0.7.8

LICENSE.wslbridge

@@ -1,21 +1,21 @@
-The MIT License (MIT)
+The MIT License (MIT)
-
+
-Copyright (c) 2016 Ryan Prichard
+Copyright (c) 2016 Ryan Prichard
-
+
-Permission is hereby granted, free of charge, to any person obtaining a copy
+Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to
+of this software and associated documentation files (the "Software"), to
-deal in the Software without restriction, including without limitation the
+deal in the Software without restriction, including without limitation the
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-sell copies of the Software, and to permit persons to whom the Software is
+sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+furnished to do so, subject to the following conditions:
-
+
-The above copyright notice and this permission notice shall be included in
+The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+all copies or substantial portions of the Software.
-
+
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-IN THE SOFTWARE.
+IN THE SOFTWARE.

README.md

@@ -2,21 +2,52 @@ Mintty as a terminal for Bash on Ubuntu on Windows / WSL.
 
 ### Overview ###
 
-Run the [installer](https://github.com/mintty/wsltty/releases) to install
+WSLtty components
-* wsltty package components (see below) in the user’s application folder (where WSL is also installed)
+* wsltty package components (see below) in the user’s local application folder 
-* an empty wsltty “home directory” to enable storage of a mintty config file
+  `%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.
+
+### Invocation ###
+
+WSLtty can be invoked with
+* installed desktop shortcuts or Start menu shortcuts
+* wsl*.bat scripts generated into the installation directory
+* Explorer context menu (if installed from the Start menu)
+
+Starting the mintty terminal directly from the WSLtty installation location 
+is discouraged because that would bypass the `--configdir` option.
+
 ### Configuration ###
 
 #### Command line scripts `wsl*.bat` ####
@@ -45,20 +76,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`
+* file given with mintty option `-c` (not used by wsltty default installation)
-* `%HOME%\.minttyrc`
+* file `config` in directory given with mintty option `--configdir`
-* `%HOME%\.config\mintty\config`
+  * This is `%APPDATA%\wsltty\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 
+* `%APPDATA%\wsltty\config` is the new user configuration file location. 
-  installation hosting wsltty. So `%HOME%` would mean `%LOCALAPPDATA%\wsltty\home\%USERNAME%`.
+  Further subdirectories of `%APPDATA%\wsltty` are used for language, 
-  If you define `HOME` at Windows level, this changes accordingly.
+  themes, and sounds resource configuration. 
-  Note, however, that the WSL `HOME` is a completely different setting.
+  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 ####
 

config-context-menu.bat

@@ -30,9 +30,9 @@ set cmd=%installdir%\bin\mintty.exe
 set cset=-o Locale=C -o Charset=UTF-8
 set opts=--wsl
 set arg=/bin/wslbridge -t %shell%
-set target0=\"%cmd%\" %opts% %cset% -i \"%icon%\" %arg%
+set target0=\"%cmd%\" %opts% %cset% --configdir \"%configdir%\" -i \"%icon%\" %arg%
-rem set target1=\"%cmd%\" %opts% %cset% -i \"%icon%\" /bin/dash -c \"cd '%%1'; exec %arg%\"
+rem set target1=\"%cmd%\" %opts% %cset% --configdir \"%configdir%\" -i \"%icon%\" /bin/dash -c \"cd '%%1'; exec %arg%\"
-set target1=\"%cmd%\" %opts% %cset% -i \"%icon%\" --dir \"%%1\" %arg%
+set target1=\"%cmd%\" %opts% %cset% --configdir \"%configdir%\" -i \"%icon%\" --dir \"%%1\" %arg%
 
 rem Registry entries
 reg add "%userdirname%\wsltty" /d "%label% %here%" /f

install.bat

@@ -105,5 +105,8 @@ mkdir "%configdir%\lang"
 mkdir "%configdir%\sounds"
 mkdir "%configdir%\themes"
 
+rem create config file if it does not yet exist
+if not exist "%configdir%\config" echo # To use common configuration in %%APPDATA%%\mintty, simply remove this file>"%configdir%\config"
+
 
 :end

makefile

@@ -9,20 +9,22 @@
 all:	check pkg
 
 # wsltty release
-ver=0.7.7
+ver=0.7.8
 
 # mintty release version
-minttyver=2.7.7
+minttyver=2.7.8
 #minttyver=master
 
 # wslbridge backend version
-wslbridgever=0.2.1
+wslbridgever=0.2.2
+
 # wslbridge frontend version
 # release 0.2.0 does not have cygwin_internal(CW_SYNC_WINENV) yet;
 # therefore using "master" below
 #wslbridge-frontend=wslbridge-frontend
 # release 0.2.1 is updated and complete, no separate frontend build needed:
-wslbridge-frontend=
+#wslbridge-frontend=
+wslbridge-frontend=wslbridge-frontend
 
 #############################################################################
 # target checking and some defs