Repository: mintty/wsltty Branch: master Commit: ec0b5560ee6b Files: 23 Total size: 126.6 KB Directory structure: gitextract_468map4m/ ├── 0001-notify-size-change-inband.patch ├── 0002-add-com-for-lifted-wsl.patch ├── 0012-get-vmid-from-registry.patch ├── LICENSE.mintty ├── LICENSE.wslbridge2 ├── README.md ├── VERSION ├── add default to context menu.lnk ├── add to context menu.lnk ├── appveyor.yml ├── cmd2.bat ├── config-distros.sh ├── configure WSL shortcuts.lnk ├── dequote.bat ├── install-portable.bat ├── install.bat ├── makefile ├── makewinx.cfg ├── mkshortcut.c ├── mkshortcut.vbs ├── remove from context menu.lnk ├── uninstall.bat └── wsltty home & help.url ================================================ FILE CONTENTS ================================================ ================================================ FILE: 0001-notify-size-change-inband.patch ================================================ diff --git a/src/wslbridge2-backend.cpp b/src/wslbridge2-backend.cpp index 8b86cc6..63a19e5 100644 --- a/src/wslbridge2-backend.cpp +++ b/src/wslbridge2-backend.cpp @@ -17,6 +17,7 @@ #include #include #include +#include // PIPE_BUF #include #include @@ -196,6 +197,7 @@ int main(int argc, char *argv[]) ssize_t readRet = 0, writeRet = 0; char data[1024]; /* Buffer to hold raw data from pty */ + assert(sizeof data <= PIPE_BUF); do { @@ -206,8 +208,85 @@ int main(int argc, char *argv[]) if (fds[0].revents & POLLIN) { readRet = recv(ioSockets.inputSock, data, sizeof data, 0); - if (readRet > 0) - writeRet = write(mfd_dp, data, readRet); + char * s = data; + int len = readRet; + writeRet = 1; + while (writeRet > 0 && len > 0) + { + if (!*s) + { + // dispatch NUL escaped inband information + s++; + len--; + + if (len < 9 && s + 9 >= data + sizeof data) + { + // make room for additional loading + memcpy(data, s, len); + s = data; + } + + // ensure 1 more byte is loaded to dispatch on + if (!len) + { + readRet = recv(ioSockets.inputSock, s, 1, 0); + if (readRet > 0) + { + len += readRet; + } + else + { + writeRet = -1; + break; + } + } + if (*s == 2) + { + // STX: escaped NUL + s++; + len--; + writeRet = write(mfd_dp, "", 1); + } + else if (*s == 16) + { + // DLE: terminal window size change + s++; + len--; + // ensure 8 more bytes are loaded for winsize + while (readRet > 0 && len < 8) + { + readRet = recv(ioSockets.inputSock, s + len, 8 - len, 0); + if (readRet > 0) + { + len += readRet; + } + } + if (readRet <= 0) + { + writeRet = -1; + break; + } + struct winsize * winsp = (struct winsize *)s; + s += 8; + len -= 8; + winsp->ws_xpixel = 0; + winsp->ws_ypixel = 0; + ret = ioctl(mfd, TIOCSWINSZ, winsp); + if (ret != 0) + perror("ioctl(TIOCSWINSZ)"); + } + } + else + { + int n = strnlen(s, len); + writeRet = write(mfd_dp, s, n); + if (writeRet > 0) + { + s += writeRet; + len -= writeRet; + } + } + } } /* Resize window when buffer received in control socket */ diff --git a/src/wslbridge2.cpp b/src/wslbridge2.cpp index 300ad57..3ba9096 100644 --- a/src/wslbridge2.cpp +++ b/src/wslbridge2.cpp @@ -43,19 +43,41 @@ union IoSockets /* global variable */ static volatile union IoSockets g_ioSockets = { 0 }; +#define dont_debug_inband +#define dont_use_controlsocket + static void resize_window(int signum) { +#ifdef use_controlsocket +#warning this may crash for unknown reason, maybe terminate the backend struct winsize winp; + ioctl(STDIN_FILENO, TIOCGWINSZ, &winp); /* Send terminal window size to control socket */ - ioctl(STDIN_FILENO, TIOCGWINSZ, &winp); send(g_ioSockets.controlSock, (char *)&winp, sizeof winp, 0); +#else + static char wins[2 + sizeof(struct winsize)] = {0, 16}; + static struct winsize * winsp = (struct winsize *)&wins[2]; + ioctl(STDIN_FILENO, TIOCGWINSZ, winsp); + +#ifdef debug_inband + /* Send terminal window size inband, visualized as ESC sequence */ + char resizesc[55]; + //sprintf(resizesc, "\e_8;%u;%u\a", winsp->ws_row, winsp->ws_col); + sprintf(resizesc, "^[_8;%u;%u^G", winsp->ws_row, winsp->ws_col); + send(g_ioSockets.inputSock, resizesc, strlen(resizesc), 0); +#else + /* Send terminal window size inband, with NUL escape */ + send(g_ioSockets.inputSock, wins, sizeof wins, 0); +#endif +#endif } static void* send_buffer(void *param) { int ret; char data[1024]; + assert(sizeof data <= PIPE_BUF); while (1) { @@ -65,8 +87,33 @@ static void* send_buffer(void *param) closesocket(g_ioSockets.inputSock); break; } - if (!send(g_ioSockets.inputSock, data, ret, 0)) - break; + char * s = data; + int len = ret; + while (ret > 0 && len > 0) + { + if (!*s) + { + // send NUL STX +#ifdef debug_inband + ret = send(g_ioSockets.inputSock, (void*)"nul", 3, 0); +#else + static char NUL_STX[] = {0, 2}; + ret = send(g_ioSockets.inputSock, NUL_STX, 2, 0); +#endif + s++; + len--; + } + else + { + int n = strnlen(s, len); + ret = send(g_ioSockets.inputSock, s, n, 0); + if (ret > 0) + { + s += ret; + len -= ret; + } + } + } } pthread_exit(&ret); @@ -480,16 +527,6 @@ int main(int argc, char *argv[]) g_ioSockets.controlSock = win_local_accept(controlSock); } - /* Capture window resize signal and send buffer to control socket */ - { - struct sigaction act; - memset(&act, 0, sizeof act); - act.sa_handler = resize_window; - act.sa_flags = SA_RESTART; - ret = sigaction(SIGWINCH, &act, NULL); - assert(ret == 0); - } - /* Create thread to send input buffer to input socket */ pthread_t tidInput; ret = pthread_create(&tidInput, nullptr, send_buffer, nullptr); @@ -502,6 +539,17 @@ int main(int argc, char *argv[]) termState.enterRawMode(); + /* Create thread to send window size through control socket */ + struct sigaction act = {}; + act.sa_handler = resize_window; + act.sa_flags = SA_RESTART; + ret = sigaction(SIGWINCH, &act, NULL); + assert(ret == 0); + + /* Notify initial size in case it's changed since starting */ + //resize_window(0); + kill(getpid(), SIGWINCH); + /* * wsltty#254: WORKAROUND: Terminates input thread forcefully * when output thread exits. Need some inter-thread syncing. ================================================ FILE: 0002-add-com-for-lifted-wsl.patch ================================================ diff -rup src/sav/GetVmId.cpp src/GetVmId.cpp --- src/sav/GetVmId.cpp 2021-04-27 13:50:51.000000000 +0000 +++ src/GetVmId.cpp 2022-02-03 19:43:53.684999800 +0000 @@ -46,11 +46,24 @@ void ComInit(void) EOAC_STATIC_CLOAKING, NULL); assert(hRes == 0); - hRes = CoCreateInstance(CLSID_LxssUserSession, + // First try with COM server in lifted WSL service + hRes = CoCreateInstance(CLSID_WslService, NULL, CLSCTX_LOCAL_SERVER, - IID_ILxssUserSession, + IID_IWSLService, (PVOID *)&wslSession); + + + // Now try with COM server in system WSL service + if (FAILED(hRes)) + { + hRes = CoCreateInstance(CLSID_LxssUserSession, + NULL, + CLSCTX_LOCAL_SERVER, + IID_ILxssUserSession, + (PVOID *)&wslSession); + } + assert(hRes == 0); } diff -rup src/sav/LxssUserSession.hpp src/LxssUserSession.hpp --- src/sav/LxssUserSession.hpp 2021-04-27 13:50:51.000000000 +0000 +++ src/LxssUserSession.hpp 2022-02-03 19:45:22.846298200 +0000 @@ -11,14 +11,26 @@ #ifndef LXSSUSERSESSION_H #define LXSSUSERSESSION_H -/* Class identifier */ +// COM IDs for lifted WSL service +static const GUID CLSID_WslService = { + 0xF122531F, + 0x326B, + 0x4514, + { 0x85, 0xAE, 0xDC, 0x99, 0xD3, 0x1D, 0x82, 0x56 } }; + +static const GUID IID_IWSLService = { + 0x50047071, + 0x122C, + 0x4CAD, + { 0x9C, 0x93, 0x94, 0x72, 0x0E, 0xB7, 0x7B, 0x06 } }; + +// COM IDs for system WSL service static const GUID CLSID_LxssUserSession = { 0x4F476546, 0xB412, 0x4579, { 0xB6, 0x4C, 0x12, 0x3D, 0xF3, 0x31, 0xE3, 0xD6 } }; -/* Interface identifier */ static const GUID IID_ILxssUserSession = { 0x536A6BCF, 0xFE04, ================================================ FILE: 0012-get-vmid-from-registry.patch ================================================ --- wslbridge2/src/wslbridge2.cpp 2024-10-10 20:20:21.931891800 +0000 +++ wslbridge2-0.12/src/wslbridge2.cpp 2024-10-08 09:31:35.954145800 +0000 @@ -228,6 +228,26 @@ static void start_dummy(std::wstring wsl CloseHandle(pi.hThread); } +bool GetIdFromRegistry(GUID *guid) { + HKEY hKeyRoot = HKEY_LOCAL_MACHINE; + std::wstring subKey = L"SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\HostComputeService\\VolatileStore\\ComputeSystem"; + HKEY hKey; + if (RegOpenKeyEx(hKeyRoot, subKey.c_str(), 0, KEY_READ, &hKey) == ERROR_SUCCESS) { + DWORD index = 0; + WCHAR keyName[256]; + DWORD keyNameSize = sizeof(keyName) / sizeof(keyName[0]); + + while (RegEnumKeyEx(hKey, index, keyName, &keyNameSize, nullptr, nullptr, nullptr, nullptr) == ERROR_SUCCESS) { + RegCloseKey(hKey); + std::wstring id = L"{" + std::wstring(keyName) + L"}"; + return IIDFromString(id.c_str(), guid) == S_OK; + } + RegCloseKey(hKey); + } + return false; +} + + int main(int argc, char *argv[]) { /* Minimum requirement Windows 10 build 17763 aka. version 1809 */ @@ -387,8 +407,8 @@ int main(int argc, char *argv[]) if (LiftedWSLVersion) start_dummy(wslPath, wslCmdLine, distroName, debugMode); - const HRESULT hRes = GetVmId(&DistroId, &VmId, LiftedWSLVersion); - if (hRes != 0) + const bool hRes = GetIdFromRegistry(&VmId); + if (!hRes) fatal("GetVmId: %s\n", GetErrorMessage(hRes).c_str()); inputSock = win_vsock_create(); ================================================ FILE: LICENSE.mintty ================================================ mintty is copyright 2008-23 Andy Koppe, 2015-23 Thomas Wolff. Licensed under the terms of the GNU General Public License version 3 or later, amended with the bundling clause to clarify ambiguous interpretation. The bundling clause can be found in the accompanying file LICENSE.bundling. The GPL license text can be found in the accompanying file LICENSE.GPL, at /usr/share/doc/common-licenses/GPL-3.0 on Cygwin installs, or on the GNU website at http://www.gnu.org/licenses/gpl.html. Sources are available from the project page at http://mintty.github.io/. Based on PuTTY version 0.60 by Simon Tatham and contributors. Big thanks to everyone involved for their work on PuTTY. See LICENSE.PuTTY for PuTTY's copyright notice, contributors, and license. The sources of PuTTY 0.60 can be downloaded from ftp://ftp.chiark.greenend.org.uk/users/sgtatham/putty-0.60. The minibidi algorithm is under MIT license as quoted in the source file. Sixel code (sixel.c) is relicensed under GPL like mintty with the permission of its author (kmiya@culti); Sixel colour conversion code (sixel_hls.c) is licensed by its author Ross Combs under the license quoted in the source file. The program icon is the apps/utilities-terminal icon from KDE's Oxygen theme, retrieved from http://websvn.kde.org/trunk/KDE/kdebase/runtime/pics/oxygen. Thanks to the KDE artists for their sleek design. The Oxygen icons are licensed under the terms of the LGPLv3; see LICENSE.Oxygen for details. The colour schemes / theme files bundled with mintty are included under various licenses. The source and license or permission are quoted in the respective theme files. Bell sounds files are included, mostly under the creative commons license (https://creativecommons.org/publicdomain/zero/1.0/), see also the README in the sounds subdirectory. ================================================ FILE: LICENSE.wslbridge2 ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: README.md ================================================ Mintty as a terminal for WSL (Windows Subsystem for Linux). ### Overview ### WSLtty components * wsltty package components (see below) in the user’s local application folder `%LOCALAPPDATA%` * a wsltty configuration directory in the user’s application folder `%APPDATA%` (“home”-located configuration files from a previously installed version will be migrated to the new default location) * Start Menu shortcuts to start WSL terminals * Desktop shorcut to start a terminal for the default WSL distribution * `*.bat` scripts to invoke WSL terminals from the command line * optional context menu entries for Windows Explorer to start WSL terminals in the respective folder * install/uninstall context menu items from Start Menu subfolder `WSLtty` --- ### Launching WSL ### Since wsltty 3.8.0, mintty launches WSL using the native Windows launcher gateway `wsl.exe` by default. Proper display in certain cases depends on an up-to-date version of the Windows conpty layer. Its version currently deployed with Windows has unfortunately still some problems. There are two ways to fix this: * Revert to the previous launching method for now. The problem is that this way of launching WSL does not appear to work on some users’ systems. For this solution, configure this in config file `%APPDATA%/wsltty/config`. `WSLbridge=2` * Update the Windows conpty layer manually, by replacing `%SYSTEMROOT%/System32/conhost.exe` following the instructions in the [mintty wiki, section Interaction with WSL](https://github.com/mintty/mintty/wiki/Tips#interaction-with-wsl-and-other-windows-programs). #### Launcher and display interworking background #### The approach to use wsl.exe directly used to fail because the _conhost_ layer hooked into the workflow used to obstruct transparent terminal operation in multiple ways. The _conhost_ layer has meanwhile been modernised, including the _conpty_ layer, and its enforced detour through the Windows console API has been dropped, in the course of the Windows Terminal project. The new _conhost_, however, has not yet been deployed with Windows (as of summer 2025) and will probably not be deployed with Windows 10 anymore. So in order to get fully transparent terminal interaction between WSL and wsltty, the updated _conhost_ needs to be patched into Windows manually, following the instructions linked above, to patch OpenConsole into your Windows as conhost replacement. #### The wslbridge approach #### To connect to WSL, wsltty used wslbridge2, which uses undocumented Windows APIs that have been changed various times, so wslbridge2 needed to catch up with incompatible changes, particularly to support WSL V2. (See e.g. issue #343; to work with WSL V2, wsltty 2.0.0 needed a WSL update to [release 1.3.17](https://github.com/microsoft/WSL/releases/tag/1.3.17).) Since release 3.0.5, WSLtty requires Windows version 1809 (the November 2018 release). By end of 2024, wsltty works again with recent updates of the WSL subsystem. Configuration option `WSLbridge=2` switches back to the previous wslbridge launching approach; the wslbridge2 gateway is still deployed with wsltty for that matter. (If for a very old Windows 10 version you still need the original wslbridge gateway, set `WSLbridge=1` and deploy it manually.) --- ### Installation from this repository ### #### WSLtty installer ([Download](https://github.com/mintty/wsltty/releases) standalone installation) #### From the [release downloads](https://github.com/mintty/wsltty/releases), run the wsltty-VERSION-x86_64-install.exe installer to install the components listed above. Make sure to select a 64-bit installer on a 64-bit system. If Windows complains with a “Windows protected your PC” popup, you may need to click “Run anyway” to proceed with the installation. You may need to open the Properties of the installer first, tab “General” section “Security” (if available) and select “Unblock”, to enable the “Run anyway” button. #### WSLtty Portable installer For a portable installation, e.g. on a USB stick, choose the “-install-portable.exe” file for download. Installation will prompt for a portable installation folder interactively. For example, choosing `U:\opt` will create and use folder `U:\opt\wsltty` both as installation directory and configuration directory. Portable installation does not install any start menu or desktop shortcuts and no context menu entries. It creates a shortcut in the selected portable installation folder to start the default WSL distribution. Note: For an update installation, either the parent directory or the target directory itself can be selected. Note: If you rename or move the installation directory, the icon of the “WSL Terminal Portable” shortcut will not work anymore; re-run the install-portable.bat script in the installation folder to refresh it. #### Installation from archive #### In case a local anti-virus guard barfs about the wsltty installer, the release also contains a `.cab` file. Download it, open it, extract its files to some temporary deployment directory, and invoke `install.bat` from there, or `install-portable.bat` for a portable installation. #### Quiet installer #### The wsltty-VERSION-x86_64-install-quiet.exe installer is intended for integration in another installation framework. #### Installation from source repository #### Checkout the wsltty repository, or download the source archive, unpack and rename the directory to `wsltty`. Install Alpine WSL from the Microsoft Store. Invoke `make build`, then `make install`. Note this has to be done within a Cygwin environment. A minimal Cygwin environment for this purpose would be installed with the [Cygwin installer](https://cygwin.com/setup-x86_64.exe) from [cygwin.com](https://cygwin.com/), with additional packages `make`, `gcc-g++`, `unzip`, `zoo`, `patch`, (`lcab`). #### Build installers #### Install a minimal Cygwin environment plus the additional packages as listed for «Installation from source repository». Invoke `make pkg` or just `make`. #### Installation to non-default locations #### (For experts) Within the installation process, provide parameters to the script `install.bat`. The optional first parameter designates the installation target, the optional second parameter designates the configuration directory. ### Installation with other package management environments ### Note: These are 3rd-party packages, not managed by this repository. #### Windows Package Manager #### ([Check package](https://github.com/microsoft/winget-pkgs/tree/master/manifests/m/Mintty/WSLtty)) To install wsltty from the [Windows Package Manager Community Repository](https://github.com/microsoft/winget-pkgs), invoke one of * `winget install wsltty` * `winget upgrade wsltty` #### Scoop #### ([Check package](https://scoop.sh/#/apps?q=wsltty)) If you use the [Scoop package manager](https://scoop.sh/), * `scoop bucket add extras` then, invoke one of * `scoop install wsltty` * `scoop update wsltty` #### Chocolatey #### ([Check package](https://community.chocolatey.org/packages/wsltty)) If you use the [Chocolatey package manager](https://chocolatey.org/), invoke one of * `choco install wsltty` * `choco upgrade wsltty` ### Uninstallation ### To uninstall wsltty desktop, start menu, and context menu integration: Open a Windows `cmd`, go into the wsltty installation folder: `cd %LOCALAPPDATA%\wsltty` and run the `uninstall` script. To uninstall wsltty software completely, remove the installation folder manually. --- ### Invocation ### WSLtty can be invoked with * installed Start Menu shortcuts (or Desktop shortcuts if copied there) * *.bat scripts (optionally with WSL command as parameters) (see [Command line scripts](#command-line-scripts-wslbat) below) * Explorer context menu (if installed from the Start Menu `WSLtty` subfolder) Starting the mintty terminal directly from the WSLtty installation location is discouraged because that would bypass essential options. #### WSL V2 #### Terminal communication with WSL via its modes V1 or V2 is handled automatically by wsltty (mintty and the wslbridge2 gateway). #### Starting issues #### If wsltty fails with an `Error: Could not fork child process: Resource temporarily unavailable`..., its runtime may be affected by some over-ambitious virus defense strategy. For example, with Windows Defender, option “Force randomization for images” should be disabled. If wsltty fails with an error message that mentions a disk mount path (e.g. `/mnt/c`), workarounds may be the shutdown of the WSL V2 virtual machine (`wsl --shutdown` on the distro) or turning off “fast startup” in the Windows power settings (#246, #248). #### WSL shell starting issues #### With WSL V2, an additional background shell is run which may cause trouble for example when setting up automatic interaction between Windows side and WSL side (see https://github.com/mintty/wsltty/issues/197#issuecomment-687030527). As a workaround, the following may be added to (the beginning of) the WSL shell initialization script `.bashrc` (adapt for other shells): ``` # work around https://github.com/mintty/wsltty/issues/197 if [[ -n "$WSL_DISTRO_NAME" ]]; then command -v cmd.exe > /dev/null || exit fi ``` --- ### Configuration ### #### Start Menu and Desktop shortcuts #### In the Start Menu, the following shortcuts are installed: * Shortcut `WSL Terminal` to start the default WSL distribution (as configured with the Windows tool `wslconfig` or `wsl -s`) * For each installed WSL distribution, for example `Ubuntu`, a shortcut like `Ubuntu Terminal` to start in the WSL user home In the Start Menu subfolder WSLtty, the following additional shortcuts are installed: * Shortcut `WSL Terminal %` to start the default WSL distribution in the Windows %USERPROFILE% home * For each installed WSL distribution, for example `Ubuntu`, a shortcut like `Ubuntu Terminal %` to start in the Windows %USERPROFILE% home One Desktop shortcut is installed: * Shortcut `WSL Terminal` to start the default WSL distribution (as configured with the Windows tool `wslconfig` or `wsl -s`) Other, distribution-specific shortcuts can be copied to the desktop from the Start Menu if desired. The Start menu folder WSLtty contains the link `configure WSL shortcuts`. This function is initially run when wsltty is installed. It should be rerun after adding or removing WSL distributions, in order to create the respective set of shortcuts in the Start menu. #### Command line scripts `wsl*.bat` #### WSLtty installs the following scripts into `%LOCALAPPDATA%\Microsoft\WindowsApps` (and a copy in its application folder `%LOCALAPPDATA%\wsltty`): * For each installed WSL distribution, e.g. Ubuntu, a command script like `Ubuntu.bat` to start in the current folder/directory * For each installed WSL distribution, e.g. Ubuntu, a command script like `Ubuntu~.bat` to start in the WSL user home * `WSL.bat` and `WSL~.bat` to start the default WSL distribution The scripts accept an optional invocation command (since 3.7.8). Given that `%LOCALAPPDATA%\Microsoft\WindowsApps` is in your PATH, the scripts can be invoked from cmd.exe, PowerShell, or via WIN+R. #### Context menu entries #### WSLtty provides context menu entries for all installed WSL distributions and one for the configured default distribution, to start a respective WSL terminal in a specific folder from an Explorer window. They are not installed by default. To add launch entries for the default or all WSL distributions to the Explorer context menu, or remove them, run the respective script from the Start Menu subfolder `WSLtty`: * `add default to context menu` adds context menu entries for the default WSL distribution * `add to context menu` adds context menu entries for all WSL distributions * `remove from context menu` removes context menu entries for WSL distributions #### Icon #### Wsltty installation and the mintty terminal try to use the icon of the respective WSL distribution. If it cannot be determined, a penguin icon is used as a fallback. You can replace it with your preferred default icon by replacing the icon file `%LOCALAPPDATA%\wsltty\wsl.ico`. #### Mintty settings #### Mintty can maintain its configuration file in various locations, with the following precedence: * file given with mintty option `-c` (not used by wsltty default installation) * file `config` in directory given with mintty option `--configdir` * **`%APPDATA%\wsltty\config`** in the default wsltty installation * `%HOME%\.minttyrc` (usage deprecated with wsltty) * `%HOME%\.config\mintty\config` (usage deprecated with wsltty) * common config file for all mintty installation instances * **`%APPDATA%\mintty\config`** * `%LOCALAPPDATA%\wsltty\etc\minttyrc` (usage deprecated with wsltty) Note: * `%APPDATA%\wsltty\config` is the user configuration file location. Further subdirectories of `%APPDATA%\wsltty` are used for language, themes, and sounds resource configuration. Note the distinction from `%LOCALAPPDATA%\wsltty` which is the default wsltty software installation location. * The `%APPDATA%\mintty\config` option provides the possibility to maintain common mintty settings for various installations (like wsltty, Cygwin, MinGW/msys, Git for Windows, MinEd for Windows). * (About deprecated options) By default, `%HOME%` would refer to the root directory of the cygwin standalone installation hosting wsltty. So `%HOME%` would mean `%LOCALAPPDATA%\wsltty\home\%USERNAME%`. If you define `HOME` at Windows level, this changes accordingly. Note, however, that the WSL `$HOME` is a completely different setting. #### Emoji deployment #### Mintty and the wsltty package do not bundle actual emoji graphics but there are scripts to support easy download and deployment. If you have another instance of mintty installed (e.g. in cygwin) and have emojis deployed already in the common config folder `%APPDATA%\mintty\emojis`, they will be reused by wsltty. To deploy emojis standalone for wsltty, use the scripts installed in `%APPDATA%\wsltty\emojis` within WSL: * `cd $(wslpath "$APPDATA/wsltty/emojis")` * `getemojis` to provide emoji graphics as listed by Unicode.org * `getflags` to provide emoji flag graphics (extending Unicode dynamically) from various sources #### Shell selection and Login shell #### The WSLtty deployment does not impose a shell preference; it invokes the user’s default shell in login mode by the final `-` parameter: * `%LOCALAPPDATA%\wsltty\bin\mintty.exe --WSL= --configdir="%APPDATA%\wsltty" -` You may tweak shortcuts, scripts, or context menu entries as follows: To launch a default shell in non-login mode, remove the final dash. To invoke your preferred shell, replace the final dash with a shell pathname and an optional `-l` parameter * `%LOCALAPPDATA%\wsltty\bin\mintty.exe --WSL= --configdir="%APPDATA%\wsltty" /bin/bash -l` --- ### WSL locale setup and character encoding ### Character encoding setup by locale setting is propagated from the terminal towards WSL. So you can select your favourite locale with configuration options or with command-line options, for example in a copied dedicated desktop shortcut. If for example you wish to run WSL in GB18030 encoding, you may set options `Locale=zh_CN` and `Charset=GB18030` and the WSL shell will adopt that setting, provided that the selected locale is configured to be available in the locale database of the WSL distribution. This can be achieved in Ubuntu with the following commands: * `sudo mkdir -p /var/lib/locales/supported.d` * `sudo echo zh_CN.GB18030 GB18030 >> /var/lib/locales/supported.d/local` * `sudo locale-gen` --- ### Components and Credits ### For mintty, see the [Mintty homepage](http://mintty.github.io/) (with further screenshots), the [Mintty manual page](http://mintty.github.io/mintty.1.html),
and the [Mintty Wiki](https://github.com/mintty/mintty/wiki), including a [Hints and Tips page](https://github.com/mintty/mintty/wiki/Tips). It is based on [Cygwin](http://cygwin.com) and includes its runtime library ([sources](http://mirrors.dotsrc.org/cygwin/x86_64/release/cygwin)). For interacting with WSL, [wslbridge](https://github.com/rprichard/wslbridge) used to be the gateway prototype. Many thanks for this enabling gateway go to Ryan Prichard. For later changes in WSL, particularly WSL mode V2, the new gateway [wslbridge2](https://github.com/Biswa96/wslbridge2) was used instead. Many thanks for this further development and maintenance go to Biswapriyo Nath. ================================================ FILE: VERSION ================================================ 3.8.0.3 ================================================ FILE: appveyor.yml ================================================ # This file is part of wsltty project # Build image; of course wsltty has nothing to do with Visual Studio - # this is just the name of Appveyor's build environment image # that also contains cygwin image: Visual Studio 2022 # Version format version: "#{build}" # Do not increment build number after pull requests pull_requests: do_not_increment_build_number: true # Do not start a new build when a new Git tag is created skip_tags: true init: - cmd: | set PATH=C:\cygwin64;C:\cygwin64\bin;%windir%\System32 setup-x86_64 -q -P unzip -P zoo -P patch -P lcab winget install Alpine build_script: - cmd: | make test_script: - cmd: | bin\mintty.exe --log mintty.log --exec echo hello mintty grep echo mintty.log ================================================ FILE: cmd2.bat ================================================ %1 "%from%" "%to%" ================================================ FILE: config-distros.sh ================================================ #! /bin/sh # dash built-in echo enforces interpretation of \t etc echoc () { #cmd /c echo $* printf '%s\n' "$*" } copy () { from="$1" to="$2" export from to cmd /c cmd2.bat copy } delete () { from="$1" to="$1" # same again, to fill parameter export from to cmd /c cmd2.bat del/F } compare () { from="$1" to="$2" export from to cmd /c cmd2.bat comp/M } case "$installdir" in ?*) custominst=true;; "") custominst=false;; esac INSTDIR="${installdir:-$LOCALAPPDATA/wsltty}" echoc "Installing wsltty into $INSTDIR" INSTDIR=`cd "$INSTDIR"; pwd` installcop=${installdir:-"$LOCALAPPDATA\\wsltty"} installdir=${installdir:-'%LOCALAPPDATA%\wsltty'} target="$installdir"'\bin\mintty.exe' case "$INSTDIR" in */) TARGETPATH="$INSTDIR"bin/mintty.exe;; *) TARGETPATH="$INSTDIR"/bin/mintty.exe;; esac CONFDIR="${configdir:-$APPDATA/wsltty}" configdir=${configdir:-'%APPDATA%\wsltty'} PATH=/bin:"$PATH":$SYSTEMROOT/System32 contextmenu=false remove=false alldistros=true config=true case "/$0" in */wsl*) config=false;; esac case "$1" in -info) config=false shift;; -shortcuts) shift;; -shortcuts-remove) remove=true shift;; -default) alldistros=false shift;; -contextmenu) contextmenu=true shift;; -contextmenu-default) contextmenu=true alldistros=false shift;; -contextmenu-remove) contextmenu=true remove=true direckey='/HKEY_CURRENT_USER/Software/Classes/Directory' regtool list "$direckey/shell" 2>/dev/null | while read name do case `regtool get "$direckey/shell/$name/command/"` in *bin\\mintty.exe*/bin/wslbridge*|*bin\\mintty.exe*--WSL*) regtool remove "$direckey/shell/$name/command" regtool remove "$direckey/shell/$name" ;; esac done regtool list "$direckey/Background/shell" 2>/dev/null | while read name do case `regtool get "$direckey/Background/shell/$name/command/"` in *bin\\mintty.exe*/bin/wslbridge*|*bin\\mintty.exe*--WSL*) regtool remove "$direckey/Background/shell/$name/command" regtool remove "$direckey/Background/shell/$name" ;; esac done exit shift;; esac if $config && ! $contextmenu then # remove shortcut entries in Start menu and cmd-line bat shortcuts (cd "$INSTDIR" for lnk in *.lnk do if compare "$lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\$lnk" then delete "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\$lnk" fi done for bat in *.bat do if compare "$bat" "$LOCALAPPDATA\\Microsoft\\WindowsApps\\$bat" then delete "$LOCALAPPDATA\\Microsoft\\WindowsApps\\$bat" fi done ) fi # test w/o WSL: call this script with REGTOOLFAKE=true dash config-distros.sh if ${REGTOOLFAKE:-false} then regtool () { case "$1" in -*) shift;; esac key=`echo $2 | sed -e 's,.*{\(.*\)}.*,\1,' -e t -e d` case "$1.$2" in list.*) if $contextmenu then echo "{0}" else echo "{1}"; echo "{2}" fi;; get.*/DistributionName) echo "distro$key";; get.*/BasePath) echo "C:\\Program\\{$key}\\State";; get.*/PackageFamilyName) echo "distro{$key}";; get.*/PackageFullName) echo "C:\\Program\\{$key}";; esac } fi mkbat () { echo Creating "$1.bat" while read line; do echo "$line"; done <<-\/EOB > "$1".bat @echo off rem Start mintty terminal for WSL rem get basename of this script file, rem use it to select WSL distribution and homedir flag set dist=%~n0 rem start in current directory set cdir= rem if script name ends with ~, extract WSL distribution and param -~ if "%dist:~-1%" == "~" set cdir=-~ && set dist=%dist:~0,-1% rem map WSL default distribution if "%dist%" == "WSL" set dist= rem check if we have an explicit -d DIST parameter if "%1" == "-d" set dist=%2 && shift && shift chcp 65001 > nul: if "%1" == "" goto login :cmd "%LOCALAPPDATA%/wsltty/bin/mintty.exe" -i "%LOCALAPPDATA%/wsltty/wsl.ico" --WSL="%dist%" --configdir="%APPDATA%/wsltty" %cdir% %* goto end :login "%LOCALAPPDATA%/wsltty/bin/mintty.exe" -i "%LOCALAPPDATA%/wsltty/wsl.ico" --WSL="%dist%" --configdir="%APPDATA%/wsltty" %cdir% - :end /EOB } if $custominst && $config && ! $remove then #mkshortcut.exe -n "add to context menu" -a "$installdir/config-distros.sh -contextmenu" "$installdir/bin/dash.exe" -i '%SystemRoot%\System32\filemgmt.dll' -s min -d "" -w "$installdir" #mkshortcut.exe -n "add default to context menu" -a "$installdir/config-distros.sh -contextmenu-default" "$installdir/bin/dash.exe" -i '%SystemRoot%\System32\filemgmt.dll' -s min -d "" -w "$installdir" #mkshortcut.exe -n "remove from context menu" -a "$installdir/config-distros.sh -contextmenu-remove" "$installdir/bin/dash.exe" -i '%SystemRoot%\System32\filemgmt.dll' -s min -d "" -w "$installdir" #mkshortcut.exe -n "configure WSL shortcuts" -a "$installdir/config-distros.sh" "$installdir/bin/dash.exe" -i '%SystemRoot%\System32\filemgmt.dll' -s min -d "" -w "$installdir" icon='%SystemRoot%\System32\filemgmt.dll' wdir="$installdir" target="$installdir/bin/dash.exe" minttyargs="/config-distros.sh" bridgeargs= export icon wdir target minttyargs bridgeargs cscript /nologo mkshortcut.vbs "/name:configure WSL shortcuts" "/min:true" bridgeargs=-contextmenu cscript /nologo mkshortcut.vbs "/name:add to context menu" "/min:true" bridgeargs=-contextmenu-default cscript /nologo mkshortcut.vbs "/name:add default to context menu" "/min:true" bridgeargs=-contextmenu-remove cscript /nologo mkshortcut.vbs "/name:remove from context menu" "/min:true" copy "add to context menu.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\WSLtty" copy "add default to context menu.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\WSLtty" copy "remove from context menu.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\WSLtty" copy "configure WSL shortcuts.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\WSLtty" # restore target target="$installdir"'\bin\mintty.exe' fi lxss="/HKEY_CURRENT_USER/Software/Microsoft/Windows/CurrentVersion/Lxss" schema="/HKEY_CURRENT_USER/Software/Classes/Local Settings/Software/Microsoft/Windows/CurrentVersion/AppModel/SystemAppData" appex () { while read line do case "$line" in *Application*Executable*) for item in $line do case "$item" in Executable=*) eval $item echo "$Executable" break;; esac done break;; esac done < $* } config () { guid="$1" ok=false case $guid in {*) distro=`regtool get "$lxss/$guid/DistributionName"` case "$distro" in Legacy) name="Bash on Windows" launcher="$SYSTEMROOT/System32/bash.exe" ;; *) name="$distro" launcher="$LOCALAPPDATA/Microsoft/WindowsApps/$distro.exe" ;; esac basepath=`regtool get "$lxss/$guid/BasePath"` if package=`regtool -q get "$lxss/$guid/PackageFamilyName"` then distrinst=`regtool get "$schema/$package/Schemas/PackageFullName"` # get actual executable path (may not match $distro) from app manifest manifest="$ProgramW6432/WindowsApps/$distrinst/AppxManifest.xml" psh_cmd='([xml]$(Get-Content '"\"$manifest\""')).Package.Applications.Application.Executable' executable=`appex "$manifest"` if [ -r "$ProgramW6432/WindowsApps/$distrinst/$executable" ] then icon="$ProgramW6432/WindowsApps/$distrinst/$executable" elif [ -r "$ProgramW6432/WindowsApps/$distrinst/images/icon.ico" ] then icon="$ProgramW6432/WindowsApps/$distrinst/images/icon.ico" else icon="$installcop"'\wsl.ico' fi root="$basepath/rootfs" elif [ -f "$basepath/$distro.exe" ] then icon="$basepath/$distro.exe" root="$basepath/rootfs" elif [ -d "$LOCALAPPDATA/lxss" ] then # legacy "Bash on Windows" icon="$LOCALAPPDATA/lxss/bash.ico" root="$basepath" else # imported distro? (#226, #236) icon="$installcop"'\wsl.ico' root="$basepath/rootfs" fi # invocation parameters for mintty minttyargs='--WSL="'"$distro"'" --configdir="'"$configdir"'"' # MINTARGS deprecated; used for mkshortcut.exe rather than mkshortcut.vbs MINTARGS='--WSL="'"$distro"'" --configdir="'"$CONFDIR"'"' # invocation commands (deprecated for mintty, used for start menu scripts) #bridgeargs='--distro-guid "'"$guid"'" -t' ok=true;; DefaultDistribution|"") # WSL default installation distro= name=WSL icon="$installcop"'\wsl.ico' minttyargs='--WSL= --configdir="'"$configdir"'"' MINTARGS='--WSL= --configdir="'"$CONFDIR"'"' #bridgeargs='-t' ok=true;; esac bridgeargs=" -" # now used to request login mode echoc "distro '$distro'" echoc "- name '$name'" echoc "- guid $guid" echoc "- (launcher $launcher)" echoc "- icon $icon" echoc "- root $root" wdir=%USERPROFILE% case "$name" in docker*) echo skipping docker system return;; esac case "$root" in *\\Docker*) echo skipping docker system return;; esac if $ok && ! $remove && [ -n "$distro" ] then # fix #163: backend missing +x with certain mount options echo Setting +x wslbridge2 backend for distro "'$distro'" (cd "$INSTDIR"; cd bin; PATH="${WINDIR}/Sysnative:${PATH}" wsl.exe -d "$distro" chmod +x wslbridge2-backend) # (cd "$LOCALAPPDATA/wsltty/bin"; wsl.exe -d "$distro" chmod +x wslbridge2-backend) # (cd ... ; "$SYSTEMROOT/System32/bash.exe" "$guid" -c chmod +x wslbridge2-backend) fi if $ok && $config then export wdir name target minttyargs bridgeargs icon if $contextmenu then # context menu entries direckey='HKEY_CURRENT_USER\Software\Classes\Directory' keyname="${name}_Terminal" if $remove then # obsolete; handled above reg delete "$direckey\\shell\\$keyname" /f reg delete "$direckey\\Background\\shell\\$keyname" /f else direckey='/HKEY_CURRENT_USER/Software/Classes/Directory' echoc Registry setting "$direckey/[Background/]shell/$keyname" target="$installcop"'\bin\mintty.exe' regtool add "$direckey/shell" regtool add "$direckey/shell/$keyname" regtool set "$direckey/shell/$keyname/" -s "$name Terminal" regtool set "$direckey/shell/$keyname/Icon" -s "$icon" regtool add "$direckey/shell/$keyname/command" regtool set "$direckey/shell/$keyname/command/" -s "\"$target\" -i \"$icon\" --dir \"%1\" $MINTARGS $bridgeargs" regtool add "$direckey/Background/shell" regtool add "$direckey/Background/shell/$keyname" regtool set "$direckey/Background/shell/$keyname/" -s "$name Terminal" regtool set "$direckey/Background/shell/$keyname/Icon" -s "$icon" regtool add "$direckey/Background/shell/$keyname/command" regtool set "$direckey/Background/shell/$keyname/command/" -s "\"$target\" -i \"$icon\" $MINTARGS $bridgeargs" fi else # invocation shortcuts and scripts if $remove then delete "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\$name Terminal.lnk" delete "$LOCALAPPDATA\\Microsoft\\WindowsApps\\$name.bat" delete "$LOCALAPPDATA\\Microsoft\\WindowsApps\\$name~.bat" if [ "$name" = "WSL" ] then # determine actual Desktop folder desktopkey='\HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders\Desktop' desktop=`regtool get "$desktopkey"` case "$desktop" in %USERPROFILE%*) desktop="$USERPROFILE${desktop#%USERPROFILE%}";; esac delete "$desktop\\$name Terminal.lnk" fi else # desktop shortcut in %USERPROFILE% -> Start Menu - WSLtty cscript /nologo mkshortcut.vbs "/name:$name Terminal %" #mkshortcut.exe -n "$name Terminal %" -i "$icon" "$TARGETPATH" -a "$MINTARGS" -d "" -w %USERPROFILE% copy "$name Terminal %.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs\\WSLtty" # launch script in . -> WSLtty home, WindowsApps launch folder #cmd /C mkbat.bat "$name" mkbat "$name" copy "$name.bat" "$LOCALAPPDATA\\Microsoft\\WindowsApps" # store backup copies in installation dir if [ "$PWD" != "$INSTDIR" ] then copy "$name Terminal %.lnk" "$installcop" copy "$name.bat" "$installcop" fi # prepare versions to target WSL home directory #bridgeargs="-C~ $bridgeargs" minttyargs="$minttyargs -~" MINTARGS="$MINTARGS -~" # desktop shortcut in ~ -> Start Menu cscript /nologo mkshortcut.vbs "/name:$name Terminal" #mkshortcut.exe -n "$name Terminal" -i "$icon" "$TARGETPATH" -a "$MINTARGS" -d "" -w %USERPROFILE% copy "$name Terminal.lnk" "$APPDATA\\Microsoft\\Windows\\Start Menu\\Programs" # default desktop shortcut in ~ -> Desktop if [ "$name" = "WSL" ] then #copy "$name Terminal.lnk" "$USERPROFILE\\Desktop" #copy "$name Terminal.lnk" "$APPDATA\\..\\Desktop\\" # the above does not work reliably (see #166) # determine actual Desktop folder desktopkey='\HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders\Desktop' desktop=`regtool get "$desktopkey"` case "$desktop" in %USERPROFILE%*) desktop="$USERPROFILE${desktop#%USERPROFILE%}";; esac copy "$name Terminal.lnk" "$desktop\\" fi # launch script in ~ -> WSLtty home, WindowsApps launch folder #cmd /C mkbat.bat "$name~" mkbat "$name~" copy "$name~.bat" "$LOCALAPPDATA\\Microsoft\\WindowsApps" # store backup copies in installation dir if [ "$PWD" != "$INSTDIR" ] then copy "$name Terminal.lnk" "$installcop" copy "$name~.bat" "$installcop" fi fi fi fi } # ensure proper parameter passing to cmd /C chcp.com 65001 # just in case; seems to work without as well # configure for all distros, plus default distro for guid in ` if $alldistros then regtool list "$lxss" 2>/dev/null else echo DefaultDistribution fi || echo "No WSL packages registered" >&2 ` do config $guid done ================================================ FILE: dequote.bat ================================================ @echo off rem https://ss64.com/nt/syntax-dequote.html for /f "delims=" %%A in ('echo %%%1%%') do set %1=%%~A ================================================ FILE: install-portable.bat ================================================ @echo off chcp 65001 > nul if not exist "WSL Terminal Portable.lnk" goto install echo Rebuilding WSL Terminal Portable shortcut set instdir=%~dp0 goto shortcut :install echo Installing WSL Terminal Portable echo Select target folder in popup dialog ... set sel="Select folder to place installation of portable wsltty" for /f "usebackq delims=" %%f in (`powershell "(new-object -COM Shell.Application).BrowseForFolder(0, '%sel%', 0, 0).self.path"`) do set f=%%f set instdir=%f%\wsltty if exist %f%\LICENSE.mintty set instdir=%f% if "%f%"=="" ( echo No installation selected pause exit ) else if not exist "%f%" ( echo Invalid installation folder %instdir% pause exit ) rem call main installation call install "%instdir%" "%instdir%" /P rem this already changes into "%instdir%" rem copy additional portable installation files rem do this after call install as that deletes previous .bat files copy "%~dp0\install-portable.bat" . dir "%instdir%"\install-portable.bat :shortcut rem create shortcut cd /D "%instdir%" rem set drive-relative path for shortcut working directory and icon set instpath=%instdir:~2% set target=%%COMSPEC%% set minttyargs=/C bin\mintty.exe --WSL= --icon=/wsl.ico --configdir=. -~ set bridgeargs= - rem set wdir=%instpath% rem let mkshortcut set working directory to empty: set wdir=. set icon=%instpath%\wsl.ico cscript /nologo mkshortcut.vbs "/name:WSL Terminal Portable" ================================================ FILE: install.bat ================================================ @echo off set refinstalldir=%%LOCALAPPDATA%%\wsltty set refconfigdir=%%APPDATA%%\wsltty if "%installdir%" == "" set installdir="%LOCALAPPDATA%\wsltty" if "%configdir%" == "" set configdir="%APPDATA%\wsltty" call dequote installdir call dequote configdir set oldroot="%installdir%" set oldhomedir="%installdir%\home\%USERNAME%" call dequote oldroot call dequote oldhomedir set oldconfigdir="%oldhomedir%\.config\mintty" call dequote oldconfigdir rem override installdir, configdir if parameters given set arg1=%1 call dequote arg1 if "%arg1%" == "%%arg1%%" goto deploy set refinstalldir=%arg1% set installdir=%arg1% set arg2=%2 call dequote arg2 if "%arg2%" == "%%arg2%%" goto deploy set refconfigdir=%arg2% set configdir=%arg2% :deploy mkdir "%installdir%" 2> nul: rem clean up previous installation artefacts del /Q "%installdir%\*.bat" del /Q "%installdir%\*.lnk" copy LICENSE.mintty "%installdir%" copy LICENSE.wslbridge2 "%installdir%" copy "add to context menu.lnk" "%installdir%" copy "add default to context menu.lnk" "%installdir%" copy "remove from context menu.lnk" "%installdir%" copy "configure WSL shortcuts.lnk" "%installdir%" rem copy "WSL Terminal.lnk" "%installdir%" rem copy "WSL Terminal %%.lnk" "%installdir%" copy config-distros.sh "%installdir%" copy mkshortcut.vbs "%installdir%" copy cmd2.bat "%installdir%" copy dequote.bat "%installdir%" rem allow persistent customization of default icon: if not exist "%installdir%\wsl.ico" copy tux.ico "%installdir%\wsl.ico" copy uninstall.bat "%installdir%" if not exist "%installdir%\bin" goto instbin rem move previous programs possibly in use out of the way del /Q "%installdir%\bin\*.old" 2> nul: ren "%installdir%\bin\cygwin1.dll" cygwin1.dll.old ren "%installdir%\bin\cygwin-console-helper.exe" cygwin-console-helper.exe.old ren "%installdir%\bin\mintty.exe" mintty.exe.old ren "%installdir%\bin\wslbridge2.exe" wslbridge2.exe.old ren "%installdir%\bin\wslbridge2-backend" wslbridge2-backend.old del /Q "%installdir%\bin\*.old" 2> nul: :instbin mkdir "%installdir%\bin" 2> nul: copy cygwin1.dll "%installdir%\bin" copy cygwin-console-helper.exe "%installdir%\bin" copy mintty.exe "%installdir%\bin" copy wslbridge2.exe "%installdir%\bin" copy wslbridge2-backend "%installdir%\bin" copy dash.exe "%installdir%\bin" copy regtool.exe "%installdir%\bin" copy zoo.exe "%installdir%\bin" rem copy mkshortcut.exe "%installdir%"\bin rem copy cygpopt-0.dll "%installdir%"\bin rem copy cygiconv-2.dll "%installdir%"\bin rem copy cygintl-8.dll "%installdir%"\bin rem create system config directory and copy config archive and scripts mkdir "%installdir%\usr\share\mintty\lang" 2> nul: copy lang.zoo "%installdir%\usr\share\mintty\lang" mkdir "%installdir%\usr\share\mintty\themes" 2> nul: copy themes.zoo "%installdir%\usr\share\mintty\themes" mkdir "%installdir%\usr\share\mintty\sounds" 2> nul: copy sounds.zoo "%installdir%\usr\share\mintty\sounds" mkdir "%installdir%\usr\share\mintty\info" 2> nul: copy charnames.txt "%installdir%\usr\share\mintty\info" mkdir "%installdir%\usr\share\mintty\icon" 2> nul: copy tux.ico "%installdir%\usr\share\mintty\icon" copy mintty.ico "%installdir%\usr\share\mintty\icon" mkdir "%installdir%\usr\share\mintty\emojis" 2> nul: copy getemojis "%installdir%\usr\share\mintty\emojis" 2> nul: copy getflags "%installdir%\usr\share\mintty\emojis" 2> nul: mkdir "%installdir%\usr\share\terminfo" 2> nul: copy terminfo.zoo "%installdir%\usr\share\terminfo" rem create Start Menu Folder set smf="%APPDATA%\Microsoft\Windows\Start Menu\Programs\WSLtty" call dequote smf mkdir "%smf%" 2> nul: rem clean up previous installation del /Q "%smf%\*.lnk" copy "wsltty home & help.url" "%smf%" copy "add to context menu.lnk" "%smf%" copy "add default to context menu.lnk" "%smf%" copy "remove from context menu.lnk" "%smf%" copy "configure WSL shortcuts.lnk" "%smf%" rem copy "WSL Terminal.lnk" "%smf%" rem copy "WSL Terminal %%.lnk" "%smf%" rem clean up previous installation rmdir /S /Q "%smf%\context menu shortcuts" 2> nul: rem unpack config files in system config directory cd /D "%installdir%\usr\share\mintty\lang" "%installdir%\bin\zoo" xO lang cd /D "%installdir%\usr\share\mintty\themes" "%installdir%\bin\zoo" xO themes cd /D "%installdir%\usr\share\mintty\sounds" "%installdir%\bin\zoo" xO sounds cd /D "%installdir%\usr\share\terminfo" "%installdir%\bin\zoo" xO terminfo cd /D "%installdir%" :migrate configuration rem migrate old config resource files to new config dir if exist "%configdir%" goto configfile if not exist "%oldconfigdir%" goto configfile if exist "%oldhomedir%\.minttyrc" copy "%oldhomedir%\.minttyrc" "%oldconfigdir%\config" && del "%oldhomedir%\.minttyrc" xcopy /E /I /Y "%oldconfigdir%" "%configdir%" && rmdir /S /Q "%oldconfigdir%" rmdir "%oldhomedir%\.config" :configfile if exist "%configdir%\config" goto deloldhome if exist "%oldhomedir%\.minttyrc" copy "%oldhomedir%\.minttyrc" "%configdir%\config" && del "%oldhomedir%\.minttyrc" :deloldhome rmdir "%oldhomedir%" 2> nul: rmdir "%oldroot%\home" 2> nul: :userconfig rem create user config directory and subfolders, copy scripts mkdir "%configdir%\lang" 2> nul: mkdir "%configdir%\themes" 2> nul: mkdir "%configdir%\sounds" 2> nul: mkdir "%configdir%\emojis" 2> nul: copy "%installdir%\usr\share\mintty\emojis\getemojis" "%configdir%\emojis" 2> nul: copy "%installdir%\usr\share\mintty\emojis\getflags" "%configdir%\emojis" 2> nul: goto noetc rem 3.8.0.2: create global config file for troubleshooting mkdir "%installdir%\etc" 2> nul: echo ###########################>"%installdir%\etc\minttyrc" echo # Troubleshooting>>"%installdir%\etc\minttyrc" echo # To work around a pty interworking issue between wsl and cygwin,>>"%installdir%\etc\minttyrc" echo # we need to apply this configuration for now:>>"%installdir%\etc\minttyrc" echo Baud=999999>>"%installdir%\etc\minttyrc" goto etcok :noetc rem 3.8.0.3: remove previous troubleshooting patch if exist "%installdir%\etc\minttyrc" del "%installdir%\etc\minttyrc" if exist "%installdir%\etc" rmdir "%installdir%\etc" :etcok rem create config file if it does not yet exist if exist "%configdir%\config" goto appconfig echo # To use common configuration in %%APPDATA%%\mintty, simply remove this file>"%configdir%\config" if "%3" == "/P" echo # Do not remove this file for WSLtty Portable>>"%configdir%\config" :appconfig rem skip configuration for WSLtty Portable if "%3" == "/P" goto end rem distro-specific stuff: shortcuts and launch scripts cd /D "%installdir%" echo Configuring for WSL distributions bin\dash.exe "config-distros.sh" rem rem bin\dash.exe "config-distros.sh" -contextmenu :end ================================================ FILE: makefile ================================================ ############################################################################# # build a wsltty installer package: # configure ver=... and minttyver= in this makefile # make targets: # make [all] build a distributable installer (default) # make pkg build an installer, bypassing the system checks # make build build the software (no installer) # make install install wsltty locally from build (no installer needed) # make wsltty build the software, using the local copy of mintty ############################## # mintty and wsltty release versions wslttyver=3.8.0.3 minttyver=3.8.0 minrepo=git@github.com:mintty/mintty.git ############################## # wsltty appx release (obsolete) - must have 4 parts! appxver=$(wslttyver).1 ############################## # wslbridge2 repository and release version repo=Biswa96/wslbridge2 wslbridgever=0.13 # wslbridge2 fork repository and version #repo=mintty/wslbridge2 #wslbridgever=0.5.1 # wslbridge2 release or fork archive and dir archive=v$(wslbridgever) wslbridgedir=wslbridge2-$(wslbridgever) # wslbridge2 latest version #archive=master #wslbridgedir=wslbridge2-$(archive) # wslbridge2 branch or commit version (from fix-window-resize branch) and dir #commit=70e0dcea1db122d076ce1578f2a45280cc92d09f #commit=8b6dd7ee2b3102d72248990c21764c5cf86c6612 # trying post-0.12 WSL V2 patches: #commit=5b2b652d1a7355b004e7860b4370a585737e5ac9 #commit=274530b35a05df203d3a69f0e28d5015844f39bd # pixel size patch + fix (retagged as 0.13): #commit=a7162d852ff438d2d5a8dd8dae61795addb3d980 #archive=$(commit) #wslbridgedir=wslbridge2-$(archive) ############################## # mintty branch or commit version #minttyver=master # wslbridge branch or commit to build from source; wslbridge=wslbridge-source wslbridge-frontend wslbridge-backend ############################## # build backend on a musl-libc-based distribution # (reportedly not needed anymore but untested) BuildDistr=-d Alpine ############################## # Windows SDK version for appx WINSDKKEY=/HKEY_LOCAL_MACHINE/SOFTWARE/WOW6432Node/Microsoft/.NET Framework Platform/Setup/Multi-Targeting Pack WINSDKVER=`regtool list '$(WINSDKKEY)' | sed -e '$$ q' -e d` ############################################################################# # default target all: all-$(notdir $(CURDIR)) # targets and version checking all-wsltty: check committed pkg all-wsltty.appx: appx committed: if git status -suno | sed -e "s,^..,," | grep .; then false; fi ############################################################################# # target checking and some defs TARGET := $(shell $(CC) -dumpmachine) ifeq ($(TARGET), i686-pc-cygwin) sys := cygwin32 else ifeq ($(TARGET), x86_64-pc-cygwin) sys := cygwin64 else ifeq ($(TARGET), i686-pc-msys) sys := msys32 else ifeq ($(TARGET), x86_64-pc-msys) sys := msys64 else $(error Target '$(TARGET)' not supported) endif wget=curl -R -L --connect-timeout 55 -O wgeto=curl -R -L --connect-timeout 55 ############################################################################# # system check: # - ensure the path name drag-and-drop adaptation works (-> Cygwin, not MSYS) # - 64 Bit (x86_64) for more stable invocation (avoid fork issues) arch:=$(shell uname -m) check: # checkarch echo Building for: echo $(arch) | grep . # checking suitable host environment; run `make pkg` to bypass # check cygwin (vs msys) for proper drag-and-drop paths: uname | grep CYGWIN checkarch: # check 32 bit to ensure 32-Bit Windows support, just in case: #uname -m | grep i686 # check 64 bit to provide 64-Bit stability support: #uname -m | grep x86_64 ############################################################################# # patch version information for appx package configuration fix-appxver: echo patching $(WINSDKVER) into Launcher config cd Launcher; sed -i~ -e "// s,v[.0-9]*,$(WINSDKVER)," Launcher.csproj echo patched Launcher.csproj echo patching $(appxver) into app config sed -i~ -e '/ rel/wsltty.SED # build installer cd rel; iexpress /n /q wsltty.SED silent-installer: # prepare build of installer rm -f rel/$(CAB)-install-quiet.exe cd rel; sed -e "/ShowInstallProgramWindow/ s/0/1/" -e "/HideExtractAnimation/ s/0/1/" -e "/InstallPrompt/ s/=.*/=/" -e "/FinishMessage/ s/=.*/=/" -e "/TargetName/ s/install.exe/install-quiet.exe/" wsltty.SED > wsltty-quiet.SED # build installer cd rel; iexpress /n /q wsltty-quiet.SED InstallPrompt=Install Mintty terminal for WSL Portable? FinishMessage=Mintty for WSL Portable installation finished portable-installer: # prepare build of installer rm -f rel/$(CAB)-install-portable.exe cd rel; sed -e "/InstallPrompt/ s/=.*/=$(InstallPrompt)/" -e "/FinishMessage/ s/=.*/=$(FinishMessage)/" -e "/AppLaunched/ s/install/install-portable/" -e "/TargetName/ s/install.exe/install-portable.exe/" wsltty.SED > wsltty-portable.SED # build installer cd rel; iexpress /n /q wsltty-portable.SED install: cop installbat installbat: cd rel; cmd /C install ver: echo $(wslttyver) > VERSION mintty: mintty-get mintty-build mintty-usr: mintty-get mintty-appx # local wsltty build target: wsltty: wslbridge cygwin mintty-build mintty-pkg # build software without installer: build: wslbridge cygwin mintty-get mintty-build mintty-pkg # standalone wsltty package build target: pkg: wslbridge cygwin mintty-get mintty-build mintty-pkg installer # appx package contents target: wsltty-appx: wslbridge appx-bin mintty-get mintty-build-appx mintty-appx # appx package target: appx: wsltty-appx fix-appxver sh ./build.sh ############################################################################# # end ================================================ FILE: makewinx.cfg ================================================ [Version] Class=IExpress SEDVersion=3 [Options] PackagePurpose=InstallApp ShowInstallProgramWindow=0 HideExtractAnimation=0 UseLongFileName=1 InsideCompressed=0 CAB_FixedSize=0 CAB_ResvCodeSigning=0 RebootMode=N InstallPrompt=%InstallPrompt% DisplayLicense=%DisplayLicense% FinishMessage=%FinishMessage% TargetName=%TargetName% FriendlyName=%FriendlyName% AppLaunched=%AppLaunched% PostInstallCmd=%PostInstallCmd% AdminQuietInstCmd=%AdminQuietInstCmd% UserQuietInstCmd=%UserQuietInstCmd% SourceFiles=SourceFiles [Strings] InstallPrompt=Install Mintty terminal for WSL? DisplayLicense= FinishMessage=Mintty for WSL installed - for documentation and configuration see https://github.com/mintty/wsltty TargetName=wsltty-%version%-%arch%-install.exe FriendlyName=wsltty AppLaunched=cmd.exe /c install.bat PostInstallCmd= AdminQuietInstCmd= UserQuietInstCmd= [SourceFiles] SourceFiles0=. [SourceFiles0] cygwin1.dll= cygwin-console-helper.exe= mintty.exe= wslbridge2.exe= wslbridge2-backend= LICENSE.mintty= LICENSE.wslbridge2= config-distros.sh= configure WSL shortcuts.lnk= charnames.txt= VERSION= dash.exe= regtool.exe= install.bat= uninstall.bat= tux.ico= add to context menu.lnk= add default to context menu.lnk= remove from context menu.lnk= wsltty home & help.url= zoo.exe= lang.zoo= themes.zoo= sounds.zoo= terminfo.zoo= mintty.ico= mkshortcut.vbs= dequote.bat= cmd2.bat= install-portable.bat= getemojis= getflags= ================================================ FILE: mkshortcut.c ================================================ /* This is a tweaked version of mkshortcut.c -- create a Windows shortcut Changes: * Facilitate path entries starting with Windows environment variables. (works for working directory and icon location but not for target path) * Do not barf on Windows path syntax. */ #include #include #include #define dont_debug_cygwin_create_path /* Preserve leading Windows environment variable for shortcut entries. So e.g. %USERPROFILE% is not pseudo-resolved to some subdirectory but can be used as working directory. NOTE: This works for working directory and icon location but not for the target path which is still polluted with a drive prefix by Windows. */ void * _cygwin_create_path (int line, cygwin_conv_path_t what, const void *from) { what &= CCP_CONVTYPE_MASK; void * to = cygwin_create_path(what, from); if (what == CCP_WIN_W_TO_POSIX ? *(wchar_t*)from == '%' : *(char*)from == '%') { if (what == CCP_POSIX_TO_WIN_W) { to = wcschr(to, '%') ?: to; } else { to = strchr(to, '%') ?: to; } } #ifdef debug_cygwin_create_path switch (what) { case CCP_POSIX_TO_WIN_A: printf("[%d] %s -> %s\n", line, from, to); break; case CCP_POSIX_TO_WIN_W: printf("[%d] %s -> %ls\n", line, from, to); break; case CCP_WIN_A_TO_POSIX: printf("[%d] %s -> %s\n", line, from, to); break; case CCP_WIN_W_TO_POSIX: printf("[%d] %ls -> %s\n", line, from, to); break; } #endif return to; } #define cygwin_create_path(what, from) _cygwin_create_path(__LINE__, what, from) /* mkshortcut.c -- create a Windows shortcut * * Copyright (c) 2002 Joshua Daniel Franklin * * Unicode-enabled by (C) 2015 Thomas Wolff * semantic changes: Allow dir to be empty (legal in shortcut) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * See the COPYING file for full license information. * * Exit values * 1: user error (syntax error) * 2: system error (out of memory, etc.) * 3: windows error (interface failed) * * Compile with: gcc -o mkshortcut mkshortcut.c -lpopt -lole32 /usr/lib/w32api/libuuid.a * (You'd need to uncomment the moved to common.h lines.) * */ #if HAVE_CONFIG_H # include "config.h" #endif //#include "common.h" #include #include #include #include #define PACKAGE_VERSION "*" #include #include #define NOCOMATTRIBUTE #include #include /* moved to common.h */ /* #include #include */ #include #include // strlen static const char versionID[] = PACKAGE_VERSION; static const char revID[] = "$Id$"; static const char copyrightID[] = "Copyright (c) 2002\nJoshua Daniel Franklin. All rights reserved.\nLicensed under GPL v2.0\n"; typedef struct optvals_s { int icon_flag; int unix_flag; int windows_flag; int allusers_flag; int desktop_flag; int smprograms_flag; int show_flag; int offset; char *name_arg; char *desc_arg; char *dir_name_arg; char *argument_arg; char *target_arg; char *icon_name_arg; } optvals; static int mkshortcut (optvals opts); static void printTopDescription (FILE * f, char *name); static void printBottomDescription (FILE * f, char *name); static const char *getVersion (); static void usage (FILE * f, char *name); static void help (FILE * f, char *name); static void version (FILE * f, char *name); static void license (FILE * f, char *name); static char *program_name; static poptContext optCon; static WCHAR * towcs (const char * s) { int sizew = (strlen (s) * 2 + 1); // worst case: surrogates WCHAR * ws = malloc (sizew * sizeof (WCHAR)); mbstowcs (ws, s, sizew); return ws; } int main (int argc, const char **argv) { const char **rest; int rc; int ec = 0; optvals opts; const char *tmp_str; int icon_offset_flag; const char *arg; struct poptOption helpOptionsTable[] = { {"help", 'h', POPT_ARG_NONE, NULL, '?', "Show this help message", NULL}, {"usage", '\0', POPT_ARG_NONE, NULL, 'u', "Display brief usage message", NULL}, {"version", 'v', POPT_ARG_NONE, NULL, 'v', "Display version information", NULL}, {"license", '\0', POPT_ARG_NONE, NULL, 'l', "Display licensing information", NULL}, {NULL, '\0', 0, NULL, 0, NULL, NULL} }; struct poptOption generalOptionsTable[] = { {"arguments", 'a', POPT_ARG_STRING, NULL, 'a', "Use arguments ARGS", "ARGS"}, {"desc", 'd', POPT_ARG_STRING, NULL, 'd', "Text for description/tooltip (defaults to POSIX path of TARGET)", "DESC"}, {"icon", 'i', POPT_ARG_STRING, NULL, 'i', "Icon file for link to use", "ICONFILE"}, {"iconoffset", 'j', POPT_ARG_INT, &(opts.offset), 'j', "Offset of icon in icon file (default is 0)", NULL}, {"name", 'n', POPT_ARG_STRING, NULL, 'n', "Name for link (defaults to TARGET)", "NAME"}, {"show", 's', POPT_ARG_STRING, NULL, 's', "Window to show: normal, minimized, maximized", "norm|min|max"}, {"workingdir", 'w', POPT_ARG_STRING, NULL, 'w', "Set working directory (defaults to directory path of TARGET)", "PATH"}, {"allusers", 'A', POPT_ARG_VAL, &(opts.allusers_flag), 1, "Use 'All Users' instead of current user for -D,-P", NULL}, {"desktop", 'D', POPT_ARG_VAL, &(opts.desktop_flag), 1, "Create link relative to 'Desktop' directory", NULL}, {"smprograms", 'P', POPT_ARG_VAL, &(opts.smprograms_flag), 1, "Create link relative to Start Menu 'Programs' directory", NULL}, {NULL, '\0', 0, NULL, 0, NULL, NULL} }; struct poptOption opt[] = { {NULL, '\0', POPT_ARG_INCLUDE_TABLE, generalOptionsTable, 0, "General options", NULL}, {NULL, '\0', POPT_ARG_INCLUDE_TABLE, helpOptionsTable, 0, "Help options", NULL}, {NULL, '\0', 0, NULL, 0, NULL, NULL} }; setlocale (LC_CTYPE, ""); tmp_str = strrchr (argv[0], '/'); if (tmp_str == NULL) { tmp_str = strrchr (argv[0], '\\'); } if (tmp_str == NULL) { tmp_str = argv[0]; } else { tmp_str++; } if ((program_name = strdup (tmp_str)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", argv[0]); exit (2); } icon_offset_flag = 0; opts.offset = 0; opts.icon_flag = 0; opts.unix_flag = 0; opts.windows_flag = 0; opts.allusers_flag = 0; opts.desktop_flag = 0; opts.smprograms_flag = 0; opts.show_flag = SW_SHOWNORMAL; opts.target_arg = NULL; opts.argument_arg = NULL; opts.name_arg = NULL; opts.desc_arg = NULL; opts.dir_name_arg = NULL; opts.icon_name_arg = NULL; /* Parse options */ optCon = poptGetContext (NULL, argc, argv, opt, 0); poptSetOtherOptionHelp (optCon, "[OPTION]* TARGET"); while ((rc = poptGetNextOpt (optCon)) > 0) { switch (rc) { case '?': help (stdout, program_name); goto exit; case 'u': usage (stdout, program_name); goto exit; case 'v': version (stdout, program_name); goto exit; case 'l': license (stdout, program_name); goto exit; case 'd': if (arg = poptGetOptArg (optCon)) { if ((opts.desc_arg = strdup (arg)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", program_name); ec = 2; goto exit; } } break; case 'i': opts.icon_flag = 1; if (arg = poptGetOptArg (optCon)) { opts.icon_name_arg = (char *) cygwin_create_path ( CCP_POSIX_TO_WIN_A, arg); if (opts.icon_name_arg == NULL) { fprintf (stderr, "%s: error converting posix path to win32 (%s)\n", program_name, strerror (errno)); ec = 2; goto exit; } } break; case 'j': icon_offset_flag = 1; break; case 'n': if (arg = poptGetOptArg (optCon)) { if ((opts.name_arg = strdup (arg)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", program_name); ec = 2; goto exit; } } break; case 's': if (arg = poptGetOptArg (optCon)) { if (strcmp (arg, "min") == 0) { opts.show_flag = SW_SHOWMINNOACTIVE; } else if (strcmp (arg, "max") == 0) { opts.show_flag = SW_SHOWMAXIMIZED; } else if (strcmp (arg, "norm") == 0) { opts.show_flag = SW_SHOWNORMAL; } else { fprintf (stderr, "%s: %s not valid for show window\n", program_name, arg); ec = 2; goto exit; } } break; case 'w': if (arg = poptGetOptArg (optCon)) { if ((opts.dir_name_arg = strdup (arg)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", program_name); ec = 2; goto exit; } } break; case 'a': if (arg = poptGetOptArg (optCon)) { if ((opts.argument_arg = strdup (arg)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", program_name); ec = 2; goto exit; } } break; // case 'A' // case 'D' // case 'P' all handled by popt itself } } if (icon_offset_flag & !opts.icon_flag) { fprintf (stderr, "%s: --iconoffset|-j only valid in conjuction with --icon|-i\n", program_name); usage (stderr, program_name); ec = 1; goto exit; } if (opts.smprograms_flag && opts.desktop_flag) { fprintf (stderr, "%s: --smprograms|-P not valid in conjuction with --desktop|-D\n", program_name); usage (stderr, program_name); ec = 1; goto exit; } if (rc < -1) { fprintf (stderr, "%s: bad argument %s: %s\n", program_name, poptBadOption (optCon, POPT_BADOPTION_NOALIAS), poptStrerror (rc)); ec = 1; goto exit; } rest = poptGetArgs (optCon); if (rest && *rest) { if ((opts.target_arg = strdup (*rest)) == NULL) { fprintf (stderr, "%s: memory allocation error\n", program_name); ec = 2; goto exit; } rest++; if (rest && *rest) { fprintf (stderr, "%s: Too many arguments: ", program_name); while (*rest) fprintf (stderr, "%s ", *rest++); fprintf (stderr, "\n"); usage (stderr, program_name); ec = 1; } else { // THE MEAT GOES HERE ec = mkshortcut (opts); } } else { fprintf (stderr, "%s: TARGET not specified\n", program_name); usage (stderr, program_name); ec = 1; } exit: return ec; } static char * xstrncat (char **dest, const char *add) { size_t n = strlen (add); size_t len = strlen (*dest) + n + 1; char *s = (char *) realloc (*dest, len * sizeof (char)); if (!s) { fprintf (stderr, "%s: out of memory\n", program_name); exit (2); } *dest = s; return strncat (*dest, add, n); } int mkshortcut (optvals opts) { char * link_name = NULL; WCHAR * exe_name = NULL; WCHAR * dir_name = NULL; WCHAR * desc = NULL; char * buf_str; char * tmp_str; char * base_str; int tmp; /* For OLE interface */ LPITEMIDLIST id; HRESULT hres; IShellLinkW * shell_link; IPersistFile * persist_file; exe_name = (WCHAR *) cygwin_create_path (CCP_POSIX_TO_WIN_W, opts.target_arg); if (!exe_name) { fprintf (stderr, "%s: error converting posix path to win32 (%s)\n", program_name, strerror (errno)); return 2; } #ifdef colon_stuff /* If there's a colon in the TARGET, it should be a URL */ if (strchr (opts.target_arg, ':') != NULL) { /* Nope, somebody's trying a W32 path */ if (opts.target_arg[1] == ':') { fprintf (stderr, "%s: all paths must be in POSIX format\n", program_name); usage (stderr, program_name); return 1; } dir_name = L""; } /* Convert TARGET to win32 path */ else #endif { buf_str = strdup (opts.target_arg); if (opts.dir_name_arg != NULL) /* Get a working dir from 'w' option */ { #ifdef colon_stuff if (strchr (opts.dir_name_arg, ':') != NULL) { fprintf (stderr, "%s: all paths must be in POSIX format\n", program_name); usage (stderr, program_name); return 1; } #endif dir_name = (WCHAR *) cygwin_create_path (CCP_POSIX_TO_WIN_W, opts.dir_name_arg); if (!dir_name) { fprintf (stderr, "%s: error converting posix path to win32 (%s)\n", program_name, strerror (errno)); return 2; } } else /* Allow dir to be empty (legal in shortcut) */ { dir_name = L""; } } /* Generate a name for the link if not given */ if (opts.name_arg == NULL) { /* Strip trailing /'s if any */ buf_str = strdup (opts.target_arg); base_str = buf_str; tmp_str = buf_str; tmp = strlen (buf_str) - 1; while (strrchr (buf_str, '/') == (buf_str + tmp)) { buf_str[tmp] = '\0'; tmp--; } /* Get basename */ while (*buf_str) { if (*buf_str == '/') tmp_str = buf_str + 1; buf_str++; } link_name = strdup (tmp_str); } /* User specified a name, so check it and convert */ else { if (opts.desktop_flag || opts.smprograms_flag) { /* Cannot have absolute path relative to Desktop/SM Programs */ if (opts.name_arg[0] == '/') { fprintf (stderr, "%s: absolute pathnames not allowed with -D/-P\n", program_name); usage (stderr, program_name); return 1; } } /* Sigh. Another W32 path */ #ifdef colon_stuff if (strchr (opts.name_arg, ':') != NULL) { fprintf (stderr, "%s: all paths must be in POSIX format\n", program_name); usage (stderr, program_name); return 1; } #endif link_name = (char *) cygwin_create_path ( CCP_POSIX_TO_WIN_A | CCP_RELATIVE, opts.name_arg); // passing multi-byte characters transparently per byte if (!link_name) { fprintf (stderr, "%s: error converting posix path to win32 (%s)\n", program_name, strerror (errno)); return 2; } } /* Add suffix to link name if necessary */ if (strlen (link_name) > 4) { tmp = strlen (link_name) - 4; if (strncmp (link_name + tmp, ".lnk", 4) != 0) xstrncat (&link_name, ".lnk"); } else xstrncat (&link_name, ".lnk"); /* Prepend relative path if necessary */ if (opts.desktop_flag) { char local_buf[MAX_PATH]; buf_str = strdup (link_name); if (!opts.allusers_flag) SHGetSpecialFolderLocation (NULL, CSIDL_DESKTOPDIRECTORY, &id); else SHGetSpecialFolderLocation (NULL, CSIDL_COMMON_DESKTOPDIRECTORY, &id); SHGetPathFromIDList (id, local_buf); /* Make sure Win95 without "All Users" has output */ if (strlen (local_buf) == 0) { SHGetSpecialFolderLocation (NULL, CSIDL_DESKTOPDIRECTORY, &id); SHGetPathFromIDList (id, local_buf); } link_name = strdup (local_buf); xstrncat (&link_name, "\\"); xstrncat (&link_name, buf_str); } if (opts.smprograms_flag) { char local_buf[MAX_PATH]; buf_str = strdup (link_name); if (!opts.allusers_flag) SHGetSpecialFolderLocation (NULL, CSIDL_PROGRAMS, &id); else SHGetSpecialFolderLocation (NULL, CSIDL_COMMON_PROGRAMS, &id); SHGetPathFromIDList (id, local_buf); /* Make sure Win95 without "All Users" has output */ if (strlen (local_buf) == 0) { SHGetSpecialFolderLocation (NULL, CSIDL_PROGRAMS, &id); SHGetPathFromIDList (id, local_buf); } link_name = strdup (local_buf); xstrncat (&link_name, "\\"); xstrncat (&link_name, buf_str); } /* Make link name Unicode-compliant */ WCHAR * widename = towcs (link_name); /* After Windows 7, saving link to relative path fails; work around that */ #ifdef corrupt_memory WCHAR widepath[MAX_PATH]; hres = GetFullPathNameW (widename, sizeof (widepath), widepath, NULL); if (hres == 0) { fprintf (stderr, "%s: Could not qualify link name\n", program_name); return 2; } #else WCHAR * widepath = (WCHAR *) cygwin_create_path (CCP_POSIX_TO_WIN_W, link_name); #endif link_name = (char *) cygwin_create_path (CCP_WIN_W_TO_POSIX, widepath); /* Setup description text */ if (opts.desc_arg != NULL) { desc = towcs (opts.desc_arg); } else { /* Put the POSIX path in the "Description", just to be nice */ desc = towcs (cygwin_create_path (CCP_WIN_A_TO_POSIX, exe_name)); if (!desc) { fprintf (stderr, "%s: error converting win32 path to posix (%s)\n", program_name, strerror (errno)); return 2; } } /* Beginning of Windows interface */ hres = OleInitialize (NULL); if (hres != S_FALSE && hres != S_OK) { fprintf (stderr, "%s: Could not initialize OLE interface\n", program_name); return 3; } hres = CoCreateInstance (&CLSID_ShellLink, NULL, CLSCTX_INPROC_SERVER, &IID_IShellLinkW, (void **) &shell_link); if (SUCCEEDED (hres)) { hres = shell_link->lpVtbl->QueryInterface (shell_link, &IID_IPersistFile, (void **) &persist_file); if (SUCCEEDED (hres)) { shell_link->lpVtbl->SetPath (shell_link, exe_name); shell_link->lpVtbl->SetDescription (shell_link, desc); shell_link->lpVtbl->SetWorkingDirectory (shell_link, dir_name); if (opts.argument_arg) shell_link->lpVtbl->SetArguments (shell_link, towcs (opts.argument_arg)); if (opts.icon_flag) shell_link->lpVtbl->SetIconLocation (shell_link, towcs (opts.icon_name_arg), opts.offset); if (opts.show_flag != SW_SHOWNORMAL) shell_link->lpVtbl->SetShowCmd (shell_link, opts.show_flag); hres = persist_file->lpVtbl->Save (persist_file, widepath, TRUE); if (!SUCCEEDED (hres)) { fprintf (stderr, "%s: Saving \"%s\" failed; does the target directory exist?\n", program_name, link_name); return 3; } persist_file->lpVtbl->Release (persist_file); shell_link->lpVtbl->Release (shell_link); /* If we are creating shortcut for all users, ensure it is readable by all users */ if (opts.allusers_flag) { char *posixpath = (char *) cygwin_create_path ( CCP_WIN_W_TO_POSIX | CCP_ABSOLUTE, widepath); if (posixpath && *posixpath) { struct stat statbuf; if (stat (posixpath, &statbuf)) { fprintf (stderr, "%s: stat \"%s\" failed\n", program_name, posixpath); } else if (chmod (posixpath, statbuf.st_mode|S_IRUSR|S_IRGRP|S_IROTH)) { fprintf (stderr, "%s: chmod \"%s\" failed\n", program_name, posixpath); } } } return 0; } else { fprintf (stderr, "%s: QueryInterface failed\n", program_name); return 3; } } else { fprintf (stderr, "%s: CoCreateInstance failed\n", program_name); return 3; } } static const char * getVersion () { return versionID; } static void printTopDescription (FILE * f, char *name) { char s[20]; fprintf (f, "%s is part of cygutils version %s\n", name, getVersion ()); fprintf (f, " create a Windows shortcut\n\n"); } static void printBottomDescription (FILE * f, char *name) { fprintf (f, "\nNOTE: All filename arguments must be in unix (POSIX) format\n"); } static void printLicense (FILE * f, char *name) { fprintf (f, "This program is free software: you can redistribute it and/or modify\n" "it under the terms of the GNU General Public License as published by\n" "the Free Software Foundation, either version 3 of the License, or\n" "(at your option) any later version.\n\n" "This program is distributed in the hope that it will be useful,\n" "but WITHOUT ANY WARRANTY; without even the implied warranty of\n" "MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" "GNU General Public License for more details.\n\n" "You should have received a copy of the GNU General Public License\n" "along with this program. If not, see .\n\n" "See the COPYING file for full license information.\n"); } static void usage (FILE * f, char *name) { poptPrintUsage (optCon, f, 0); } static void help (FILE * f, char *name) { printTopDescription (f, name); poptPrintHelp (optCon, f, 0); printBottomDescription (f, name); } static void version (FILE * f, char *name) { printTopDescription (f, name); fprintf (f, copyrightID); } static void license (FILE * f, char *name) { printTopDescription (f, name); printLicense (f, name); } ================================================ FILE: mkshortcut.vbs ================================================ rem cscript mkshortcut.vbs [/param:arg] /target:link rem /target:%LOCALAPPDATA%\wsltty\bin\mintty.exe rem /wdir:%USERPROFILE% rem /icon:%LOCALAPPDATA%\wsltty\wsl.ico rem deprecated: /icon:%LOCALAPPDATA%\lxss\bash.ico rem deprecated: % rem /arguments:--wsl -o Locale=C -o Charset=UTF-8 /bin/wslbridge -t /bin/bash rem deprecated: ~ rem /arguments:--wsl -o Locale=C -o Charset=UTF-8 /bin/wslbridge -C~ -t /bin/bash rem deprecated: -l rem /arguments:--wsl -o Locale=C -o Charset=UTF-8 /bin/wslbridge -t /bin/bash -l rem General - Name: name = Wscript.Arguments.Named("name") & ".lnk" set wshell = WScript.CreateObject("WScript.Shell") wscript.echo "Creating " & name set lnk = wshell.CreateShortcut(name) rem Target: rem lnk.TargetPath = Wscript.Arguments.Named("target") rem lnk.Arguments = Wscript.Arguments.Named("arguments") lnk.TargetPath = wshell.ExpandEnvironmentStrings("%target%") minttyargs = wshell.ExpandEnvironmentStrings("%minttyargs%") bridgeargs = wshell.ExpandEnvironmentStrings("%bridgeargs%") lnk.Arguments = minttyargs & " " & bridgeargs rem wscript.echo "minttyargs: " & minttyargs rem wscript.echo lnk.Arguments rem Start in: rem Working directory; Arguments.Named would take "/wdir:C:\..." parameters rem wdir = Wscript.Arguments.Named("wdir") rem Working directory; function ExpandEnvironmentStrings cannot pass empty wdir = wshell.ExpandEnvironmentStrings("%wdir%") if IsEmpty(wdir) then lnk.WorkingDirectory = "%USERPROFILE%" elseif wdir = "." then lnk.WorkingDirectory = "" else lnk.WorkingDirectory = wdir end if rem Icon: rem icon = Wscript.Arguments.Named("icon") rem rem iconoffset = Wscript.Arguments.Named("iconoffset") rem rem icon = icon & ", " & iconoffset icon = wshell.ExpandEnvironmentStrings("%icon%") rem wscript.echo "icon: " & icon lnk.IconLocation = icon rem rem lnk.IconLocation = "%LOCALAPPDATA%\lxss\bash.ico" rem lnk.IconLocation = "%LOCALAPPDATA%\wsltty\wsl.ico" rem Shorcut key: rem lnk.HotKey = "ALT+CTRL+W" rem Run: rem 1: Normal 7: Minimized 3: Maximized rem lnk.WindowStyle = 1 min = Wscript.Arguments.Named("min") if min then lnk.WindowStyle = 7 end if rem Comment: rem lnk.IconLocation = Wscript.Arguments.Named("desc") rem lnk.Description = "WSLtty" lnk.Save wscript.echo "Created " & name wscript.echo ================================================ FILE: uninstall.bat ================================================ @echo off if "%installdir%" == "" set installdir="%LOCALAPPDATA%\wsltty" call dequote installdir :shortcuts rem delete Start Menu Folder set smf="%APPDATA%\Microsoft\Windows\Start Menu\Programs\WSLtty" call dequote smf rmdir /S /Q "%smf%" :start menu cd /D "%installdir%" bin\dash.exe config-distros.sh -shortcuts-remove :explorer context menu cd /D "%installdir%" bin\dash.exe config-distros.sh -contextmenu-remove :undeploy cd /D "%installdir%" rem currently not removing software :end ================================================ FILE: wsltty home & help.url ================================================ [InternetShortcut] URL=https://github.com/mintty/wsltty