0.7.8.3

README.md

@@ -2,18 +2,55 @@ 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 ####
+#### 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
@@ -39,19 +76,41 @@ 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)
-* `%LOCALAPPDATA%\wsltty\home\%USERNAME%\.minttyrc`
+* file `config` in directory given with mintty option `--configdir`
-* `%LOCALAPPDATA%\wsltty\home\%USERNAME%\.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 that the `%APPDATA%\mintty\config` option provides the possibility 
+Note:
-to maintain common mintty settings for various installations (like 
+* `%APPDATA%\wsltty\config` is the new user configuration file location. 
-wsltty, Cygwin, MinGW/msys, Git for Windows, MinEd for Windows).
+  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 ####
+
+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/).
+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)).

config-context-menu.bat

@@ -1,7 +1,7 @@
 @echo off
 
-rem See comments in install.bat about changing the installation directory.
+if "%installdir%" == "" set installdir=%LOCALAPPDATA%\wsltty
-set installdir=%LOCALAPPDATA%\wsltty
+if "%configdir%" == "" set configdir=%APPDATA%\wsltty
 
 
 if "%1"=="/U" goto remove
@@ -28,11 +28,11 @@ set shell=/bin/bash
 rem Mintty invocation
 set cmd=%installdir%\bin\mintty.exe
 set cset=-o Locale=C -o Charset=UTF-8
-set opts=--wsl
+set opts=--wsl -h err
 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

@@ -1,11 +1,14 @@
 @echo off
 
-rem If you change the installation directory,
+set refinstalldir=%%LOCALAPPDATA%%\wsltty
-rem it also needs to be adapted in
-rem - the Shortcut links *.lnk
-rem - the cmd invocation scripts wsl*.bat
-
 set installdir=%LOCALAPPDATA%\wsltty
+set refconfigdir=%%APPDATA%%\wsltty
+set configdir=%APPDATA%\wsltty
+set oldroot=%installdir%
+set oldhomedir=%installdir%\home\%USERNAME%
+set oldconfigdir=%oldhomedir%\.config\mintty
+if not "%1" == "" set refinstalldir=%1 && set installdir=%1
+if not "%2" == "" set refconfigdir=%2 && set configdir=%2
 
 
 :deploy
@@ -13,38 +16,52 @@ set installdir=%LOCALAPPDATA%\wsltty
 mkdir "%installdir%"
 copy LICENSE.mintty "%installdir%"
 copy LICENSE.wslbridge "%installdir%"
-copy uninstall.bat "%installdir%"
 
-copy wsl.bat "%installdir%"
+echo @echo off> setdirs.bat
-copy wsl~.bat "%installdir%"
+echo set refinstalldir=%refinstalldir%>> setdirs.bat
-copy wsl-l.bat "%installdir%"
+echo set installdir=%installdir%>> setdirs.bat
-copy "config-context-menu.bat" "%installdir%"
+echo set refconfigdir=%refconfigdir%>> setdirs.bat
+echo set configdir=%configdir%>> setdirs.bat
+copy setdirs.bat + wsl.bat "%installdir%\wsl.bat"
+copy setdirs.bat + wsl~.bat "%installdir%\wsl~.bat"
+copy setdirs.bat + wsl-l.bat "%installdir%\wsl-l.bat"
+copy setdirs.bat + uninstall.bat "%installdir%\uninstall.bat"
+copy setdirs.bat + config-context-menu.bat "%installdir%\config-context-menu.bat"
+
 copy "add to context menu.lnk" "%installdir%"
 copy "remove from context menu.lnk" "%installdir%"
-rem does not work without admin rights:
-rem copy wsl.bat "%SYSTEMROOT%\System32"
-rem copy wsl~.bat "%SYSTEMROOT%\System32"
-rem copy wsl-l.bat "%SYSTEMROOT%\System32"
 
 mkdir "%installdir%\bin"
 copy cygwin1.dll "%installdir%\bin"
 copy cygwin-console-helper.exe "%installdir%\bin"
 rem copy dash.exe "%installdir%\bin"
 copy mintty.exe "%installdir%\bin"
+copy zoo.exe "%installdir%\bin"
 copy wslbridge.exe "%installdir%\bin"
 copy wslbridge-backend "%installdir%\bin"
 
-rem create "home directory" to enable storage of config file
+rem create system config directory and copy config archive
-mkdir "%installdir%\home
+mkdir "%installdir%\usr\share\mintty\lang"
-mkdir "%installdir%\home\%USERNAME%"
+copy po.zoo "%installdir%\usr\share\mintty\lang"
 
 
 :shortcuts
 
+rem generate shortcuts
+
+set icon=%%LOCALAPPDATA%%\lxss\bash.ico
+set target=%refinstalldir%\bin\mintty.exe
+set minttyargs=--wsl -h err --configdir="%refconfigdir%" -o Locale=C -o Charset=UTF-8 /bin/wslbridge 
+set bridgeargs=-t /bin/bash
+cscript mkshortcut.vbs "/name:WSL Bash %% in Mintty"
+set bridgeargs=-C~ -t /bin/bash
+cscript mkshortcut.vbs "/name:WSL Bash ~ in Mintty"
+set bridgeargs=-t /bin/bash -l
+cscript mkshortcut.vbs "/name:WSL Bash -l in Mintty"
+
 rem create Start Menu Folder
 set smf=%APPDATA%\Microsoft\Windows\Start Menu\Programs\WSLtty
 mkdir "%smf%"
-echo on
 copy "wsltty home & help.url" "%smf%"
 copy "WSL Bash %% in Mintty.lnk" "%smf%"
 copy "WSL Bash ~ in Mintty.lnk" "%smf%"
@@ -58,4 +75,38 @@ copy "WSL Bash %% in Mintty.lnk" "%USERPROFILE%\Desktop"
 copy "WSL Bash ~ in Mintty.lnk" "%USERPROFILE%\Desktop"
 
 
+:sysconfig
+
+rem unpack config files in system config directory
+cd /D "%installdir%\usr\share\mintty\lang"
+"%installdir%\bin\zoo" xO po
+
+
+: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%"
+rmdir "%oldroot%\home"
+
+
+:userconfig
+
+rem create user config directory and subfolders
+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

@@ -1,16 +1,23 @@
 #############################################################################
-# default: generate all
+# build a wsltty installer package:
+# configure ver=... and minttyver= in this makefile
+# make targets:
+# make [all]	to build a distributable installer (default)
+# make pkg	to build an installer, bypassing the system checks
+# make wsltty	to build an installer using the local copy of mintty
+
 all:	check pkg
 
 # wsltty release
-ver=0.7.3
+ver=0.7.8.3
 
 # mintty release version
-minver=2.7.3
+#minttyver=2.7.8
-#minver=master
+minttyver=master
 
 # wslbridge backend version
-wslbridgever=0.2.1
+wslbridgever=0.2.3
+
 # wslbridge frontend version
 # release 0.2.0 does not have cygwin_internal(CW_SYNC_WINENV) yet;
 # therefore using "master" below
@@ -49,7 +56,9 @@ check:
 	# check cygwin (vs msys) for proper drag-and-drop paths:
 	uname | grep CYGWIN
 	# check 32 bit (vs 64 bit) to ensure 32-Bit Windows support, just in case:
-	uname -m | grep i686
+	#uname -m | grep i686
+	# check 64 bit (vs 32 bit) to provide 64-Bit stability support:
+	uname -m | grep x86_64
 
 #############################################################################
 # generation
@@ -72,36 +81,58 @@ wslbridge-frontend:
 	cp wslbridge-master/out/wslbridge.exe bin/
 	cp wslbridge-master/LICENSE.txt LICENSE.wslbridge
 
-mintty:
+mintty:	mintty-get mintty-build
-	$(wgeto) https://github.com/mintty/mintty/archive/$(minver).zip -o mintty-$(minver).zip
+
-	unzip -o mintty-$(minver).zip
+mintty-get:
-	cd mintty-$(minver)/src; make LDFLAGS="-static -static-libgcc -s"
+	$(wgeto) https://github.com/mintty/mintty/archive/$(minttyver).zip -o mintty-$(minttyver).zip
+	unzip -o mintty-$(minttyver).zip
+
+mintty-build:
+	cd mintty-$(minttyver)/src; make LDFLAGS="-static -static-libgcc -s" VERSION_SUFFIX="– wsltty $(ver)"
 	mkdir -p bin
-	cp mintty-$(minver)/bin/mintty.exe bin/
+	cp mintty-$(minttyver)/bin/mintty.exe bin/
-	cp mintty-$(minver)/LICENSE LICENSE.mintty
+	cp mintty-$(minttyver)/LICENSE LICENSE.mintty
+	cd mintty-$(minttyver)/lang; zoo a po *.po; mv po.zoo ../../
 
 cygwin:
 	mkdir -p bin
 	cp /bin/cygwin1.dll bin/
 	cp /bin/cygwin-console-helper.exe bin/
 	#cp /bin/dash.exe bin/
+	cp /bin/zoo.exe bin/
 
-wsltty:
+cop:	ver
-
-pkg:	wslbridge mintty cygwin wsltty
 	mkdir -p rel
+	rm -fr rel/wsltty-$(ver)-install.exe
 	sed -e "s,%version%,$(ver)," makewinx.cfg > rel/wsltty.SED
 	cp bin/cygwin1.dll rel/
 	cp bin/cygwin-console-helper.exe rel/
 	#cp bin/dash.exe rel/
 	cp bin/mintty.exe rel/
+	cp bin/zoo.exe rel/
+	cp po.zoo rel/
 	cp bin/wslbridge.exe rel/
 	cp bin/wslbridge-backend rel/
 	cp LICENSE.* rel/
 	cp *.lnk rel/
 	cp *.url rel/
 	cp *.bat rel/
+	cp *.vbs rel/
+
+cab:	cop
 	cd rel; iexpress /n wsltty.SED
 
+install:	cop installbat
+
+installbat:
+	cd rel; cmd /C install
+
+ver:
+	echo $(ver) > VERSION
+
+pkg:	wslbridge cygwin mintty cab
+
+wsltty:	wslbridge cygwin mintty-build cab
+
 #############################################################################
 # end

makewinx.cfg

@@ -51,6 +51,9 @@ FILE15="config-context-menu.bat"
 FILE16="add to context menu.lnk"
 FILE17="remove from context menu.lnk"
 FILE18="wsltty home & help.url"
+FILE19="zoo.exe"
+FILE20="po.zoo"
+FILE21=mkshortcut.vbs
 
 [SourceFiles]
 SourceFiles0=.
@@ -75,4 +78,7 @@ SourceFiles0=.
 %FILE16%=
 %FILE17%=
 %FILE18%=
+%FILE19%=
+%FILE20%=
+%FILE21%=
 

mkshortcut.vbs

@@ -0,0 +1,52 @@
+rem cscript mkshortcut.vbs [/param:arg] /target:link
+
+rem %
+rem /arguments:--wsl -h err -o Locale=C -o Charset=UTF-8 /bin/wslbridge -t /bin/bash
+rem ~
+rem /arguments:--wsl -h err -o Locale=C -o Charset=UTF-8 /bin/wslbridge -C~ -t /bin/bash
+rem -l
+rem /arguments:--wsl -h err -o Locale=C -o Charset=UTF-8 /bin/wslbridge -t /bin/bash -l
+rem /target:%LOCALAPPDATA%\wsltty\bin\mintty.exe
+rem /workingdir:%USERPROFILE%
+rem /icon:%LOCALAPPDATA%\lxss\bash.ico
+
+rem General - Name:
+name = Wscript.Arguments.Named("name") & ".lnk"
+set wshell = WScript.CreateObject("WScript.Shell")
+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
+wscript.echo "minttyargs: " & minttyargs
+wscript.echo lnk.Arguments
+
+rem Start in:
+rem lnk.WorkingDirectory = Wscript.Arguments.Named("workingdir")
+lnk.WorkingDirectory = "%USERPROFILE%"
+
+rem Icon:
+rem icon = Wscript.Arguments.Named("icon")
+rem rem iconoffset = Wscript.Arguments.Named("iconoffset")
+rem rem icon = icon & ", " & iconoffset
+icon = wshell.ExpandEnvironmentStrings("%icon%")
+wscript.echo "icon: " & icon
+lnk.IconLocation = icon
+rem lnk.IconLocation = "%LOCALAPPDATA%\lxss\bash.ico"
+
+rem Shorcut key:
+rem lnk.HotKey = "ALT+CTRL+W"
+
+rem Run:
+rem lnk.WindowStyle = 1
+
+rem Comment:
+rem lnk.IconLocation = Wscript.Arguments.Named("desc")
+rem lnk.Description = "WSLtty"
+
+lnk.Save

uninstall.bat

@@ -1,8 +1,6 @@
 @echo off
 
-rem See comments in install.bat about changing the installation directory.
+if "%installdir%" == "" set installdir=%LOCALAPPDATA%\wsltty
-
-set installdir=%LOCALAPPDATA%\wsltty
 
 
 :shortcuts
@@ -23,8 +21,9 @@ call "%installdir%\config-context-menu.bat" /U
 
 :undeploy
 
+cd %installdir%
+
 rem currently not removing software
-rem in any case, at least the config file (home\...) should not be removed
 
 
 :end

wsl-l.bat

@@ -2,11 +2,14 @@
 
 rem Start mintty terminal for WSL in home directory
 
+if "%installdir%" == "" set installdir=%LOCALAPPDATA%\wsltty
+if "%configdir%" == "" set configdir=%APPDATA%\wsltty
+
 rem To enable invocation of this script from WIN+R or from cmd.exe,
 rem you may want to copy this script into "%SYSTEMROOT%\System32"
 
 rem You may want a variant of this script without trailing "-l" 
 rem to start in the current directory from cmd.exe
 
-"%LOCALAPPDATA%\wsltty\bin\mintty.exe" --wsl -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -t /bin/bash -l
+"%installdir%\bin\mintty.exe" --wsl -h err "--configdir=%configdir%" -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -t /bin/bash -l
 

wsl.bat

@@ -2,11 +2,14 @@
 
 rem Start mintty terminal for WSL in home directory
 
+if "%installdir%" == "" set installdir=%LOCALAPPDATA%\wsltty
+if "%configdir%" == "" set configdir=%APPDATA%\wsltty
+
 rem To enable invocation of this script from WIN+R or from cmd.exe,
 rem you may want to copy this script into "%SYSTEMROOT%\System32"
 
 rem You may want a variant of this script without trailing "-l" 
 rem to start in the current directory from cmd.exe
 
-"%LOCALAPPDATA%\wsltty\bin\mintty.exe" --wsl -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -t /bin/bash
+"%installdir%\bin\mintty.exe" --wsl -h err "--configdir=%configdir%" -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -t /bin/bash
 

wsl~.bat

@@ -2,11 +2,14 @@
 
 rem Start mintty terminal for WSL in home directory
 
+if "%installdir%" == "" set installdir=%LOCALAPPDATA%\wsltty
+if "%configdir%" == "" set configdir=%APPDATA%\wsltty
+
 rem To enable invocation of this script from WIN+R or from cmd.exe,
 rem you may want to copy this script into "%SYSTEMROOT%\System32"
 
 rem You may want a variant of this script without trailing "-l" 
 rem to start in the current directory from cmd.exe
 
-"%LOCALAPPDATA%\wsltty\bin\mintty.exe" --wsl -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -C~ -t /bin/bash
+"%installdir%\bin\mintty.exe" --wsl -h err "--configdir=%configdir%" -o Locale=C -o Charset=UTF-8 -i "%LOCALAPPDATA%\lxss\bash.ico" /bin/wslbridge -C~ -t /bin/bash