sascha/wsltty
1
0
Fork 0
mirror of https://github.com/mintty/wsltty.git synced 2025-01-18 12:05:47 +00:00
Code Issues Releases Wiki Activity

adapted installation and configuration hints to 0.7.7

Browse Source
This commit is contained in:
mintty 2017-05-20 20:31:33 +02:00
parent 0d1f0875be
commit 8ffb732330
1 changed files with 40 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -2,21 +2,42 @@ 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
WSLtty components
* wsltty package components (see below) in the user’s local application folder
`%LOCALAPPDATA%` (where WSL is also installed)
* 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 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
### Installation ###
#### WSLtty installer ####
Run the [installer](https://github.com/mintty/wsltty/releases) to install
the components listed above.
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.
#### Installation from source repository ####
Download or checkout the wsltty repository.
Invoke `make`, then `make install`.
Note this has to be done within a Cygwin environment.
#### Installation to non-default locations ####
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.
### Configuration ###
#### Command line scripts `wsl*.bat` ####
@ -45,20 +66,28 @@ add a `cd` command to your `$HOME/.profile` on Linux side.
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`
* file given with mintty option `-c` (not used by wsltty default installation)
* file `config` in directory given with mintty option `--configdir`
* This is `%APPDATA%\mintty\config` in the default wsltty installation.
* `%HOME%\.minttyrc` (usage deprecated with wsltty)
* `%HOME%\.config\mintty\config` (usage deprecated with wsltty)
* `%APPDATA%\mintty\config`
* `%LOCALAPPDATA%\wsltty\etc\minttyrc`
* `%LOCALAPPDATA%\wsltty\etc\minttyrc` (usage deprecated with wsltty)
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.
* `%APPDATA%\wsltty\config` is the new 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.
#### Shell selection ####