mirror of
https://github.com/mintty/wsltty.git
synced 2025-01-18 20:10:58 +00:00
81 lines
3.6 KiB
Markdown
81 lines
3.6 KiB
Markdown
Mintty as a terminal for Bash on Ubuntu on Windows / WSL.
|
||
|
||
### Overview ###
|
||
|
||
Run the [installer](https://github.com/mintty/wsltty/releases) to install
|
||
* wsltty package components (see below) in the user’s application folder (where WSL is also installed)
|
||
* an empty wsltty “home directory” to enable storage of a mintty config file
|
||
* Start Menu and Desktop shortcuts to start a WSL bash (with some variations, see below)
|
||
* optional context menu entries for Windows Explorer to start a WSL bash in the respective folder
|
||
* install/uninstall context menu items from Start Menu subfolder
|
||
* `wsl*.bat` scripts to invoke wsltty manually (with some variations and invocation options, see below)
|
||
* an uninstall script that can be invoked manually to remove shortcuts and context menu entries
|
||
|
||
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.
|
||
|
||
### Configuration ###
|
||
|
||
#### Command line scripts `wsl*.bat` ####
|
||
|
||
WSLtty installs the following scripts in its application folder `%LOCALAPPDATA%\wsltty`:
|
||
* `wsl.bat` to start a WSL bash in the current folder/directory
|
||
* `wsl~.bat` to start a WSL bash in the WSL user home
|
||
* `wsl-l.bat` to start a WSL login bash
|
||
|
||
To enable invocation of these scripts from WIN+R or from cmd.exe,
|
||
copy them from `%LOCALAPPDATA%\wsltty` into `%SYSTEMROOT%\System32`,
|
||
renaming them as desired.
|
||
(The package does not do this to avoid trouble with missing admin privileges.)
|
||
|
||
#### Start Menu and Desktop shortcuts ####
|
||
|
||
The Start Menu subfolder WSLtty offers three shortcuts:
|
||
* `WSL Bash % in Mintty` to start a WSL bash in the Windows %USERPROFILE% home
|
||
* `WSL Bash ~ in Mintty` to start a WSL bash in the WSL user home
|
||
* `WSL Bash -l in Mintty` to start a WSL login bash
|
||
|
||
To ensure a login bash to start in your Linux home directory,
|
||
add a `cd` command to your `$HOME/.profile` on Linux side.
|
||
|
||
#### Mintty settings ####
|
||
|
||
Mintty can maintain its configuration file in various locations,
|
||
with the following precedence:
|
||
* file given with mintty option `-c`
|
||
* `%HOME%\.minttyrc`
|
||
* `%HOME%\.config\mintty\config`
|
||
* `%APPDATA%\mintty\config`
|
||
* `%LOCALAPPDATA%\wsltty\etc\minttyrc`
|
||
|
||
Note:
|
||
* 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.
|
||
* 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).
|
||
|
||
#### Shell selection ####
|
||
|
||
To invoke your favourite shell, simply replace `/bin/bash` with its pathname
|
||
in the Desktop shortcuts, `wsl*.bat` invocation scripts,
|
||
or Explorer context menu commands (configured in `config-context-menu.bat`).
|
||
|
||
### Components ###
|
||
|
||
For mintty, see the [Mintty homepage](http://mintty.github.io/),
|
||
then [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/release/cygwin)).
|
||
|
||
For interacting with WSL, it uses [wslbridge](https://github.com/rprichard/wslbridge).
|
||
|