update doc

Fix leaked pushd

README.cn.md

@@ -65,7 +65,12 @@ z -b foo    # 跳转到父目录中名称以 foo 开头的那一级
       antigen bundle skywind3000/z.lua
 
   就可以了（主要要放在 antigen apply 语句之前）。
+  
+  **注意**：使用 WSL-1 的用户，需要安装 `lua-filesystem` 包：
 
+      sudo apt-get install lua-filesystem
+
+  这是由于 wsl-1 的 [bug](https://github.com/microsoft/WSL/issues/5505) 引起的，使用 lua-filesystem 可以避免该问题。
 
 - Fish Shell:
 
@@ -83,7 +88,7 @@ z -b foo    # 跳转到父目录中名称以 foo 开头的那一级
 
   在你 Power Shell 的配置文件 `profile.ps1` 中放入下面语句：
 
-      iex ($(lua /path/to/z.lua --init powershell) -join "`n") 
+      Invoke-Expression (& { (lua /path/to/z.lua --init powershell) -join "`n" })
 
 
 - Windows cmd (with clink):

README.md

@@ -69,13 +69,19 @@ z -b foo    # cd to the parent directory starting with foo
 
   and perhaps this:
 
-      export _ZL_ECHO=1
+      eval "$(lua /path/to/z.lua --init bash enhanced once echo)"
 
   if you want `z.lua` print the new directory after cd. 
 
-  If you want `fzf` tab completion use:
+  For `fzf` tab completion use:
 
       eval "$(lua /path/to/z.lua --init bash enhanced once fzf)"
+  
+  **NOTE**: For wsl-1 users, `lua-filesystem` must be installed:
+
+      sudo apt-get install lua-filesystem
+
+  To avoid a wsl-1 [defect](https://github.com/microsoft/WSL/issues/5505).
 
 - Zsh:
 
@@ -85,6 +91,8 @@ z -b foo    # cd to the parent directory starting with foo
 
   Options like "enhanced" and "once" can be used after `--init` too. It can also be initialized from "skywind3000/z.lua" with your zsh plugin managers (antigen / oh-my-zsh).
 
+  **NOTE**: for wsl-1 users, `lua-filesystem` must be installed.
+
 - Posix Shells:
 
   put something like this in your `.profile`:
@@ -113,21 +121,29 @@ z -b foo    # cd to the parent directory starting with foo
 
   put something like this in your `profile.ps1`:
 
-      iex ($(lua /path/to/z.lua --init powershell) -join "`n") 
+      Invoke-Expression (& { (lua /path/to/z.lua --init powershell) -join "`n" })
-
 
 - Windows cmd (with clink):
 
-  - copy z.lua and z.cmd to clink's home directory
+  - Copy z.lua and z.cmd to clink's home directory
   - Add clink's home to `%PATH%` (z.cmd can be called anywhere)
   - Ensure that "lua" can be called in `%PATH%`
 
 - Windows cmder:
 
-  - copy z.lua and z.cmd to cmder/vendor
+  - Copy z.lua and z.cmd to cmder/vendor
   - Add cmder/vendor to `%PATH%`
   - Ensure that "lua" can be called in `%PATH%`
 
+- Windows WSL-1:
+
+  Install `lua-filesystem` module before init z.lua:
+        
+        sudo apt-get install lua-filesystem
+
+  This module is required due to a wsl-1 [defect](https://github.com/microsoft/WSL/issues/5505).
+
+
 
 ## Options
 

z.cmd

@@ -106,13 +106,23 @@ if /i "%RunMode%"=="-n" (
 			pushd !NewPath!
 			pushd !NewPath!
 			endlocal
-			popd
+			goto popdir
 		)
 	)
 )	else (
 	call "%LuaExe%" "%LuaScript%" "%RunMode%" %MatchType% %StrictSub% %InterMode% %StripMode% %*
 )
 
+goto end
+
+:popdir
+rem -- Exploits variable expansion and the pushd stack to set the current
+rem -- directory without leaking a pushd.
+popd
+setlocal
+set NewPath=%CD%
+endlocal & popd & cd /d "%NewPath%"
+
 :end
 echo.
 

z.lua

@@ -1,10 +1,10 @@
 #! /usr/bin/env lua
 --=====================================================================
 --
--- z.lua - a cd command that learns, by skywind 2018, 2019, 2020
+-- z.lua - a cd command that learns, by skywind 2018, 2019, 2020, 2021
 -- Licensed under MIT license.
 --
--- Version 1.8.9, Last Modified: 2020/12/23 16:37
+-- Version 1.8.12, Last Modified: 2021/02/15 00:05
 --
 -- * 10x faster than fasd and autojump, 3x faster than z.sh
 -- * available for posix shells: bash, zsh, sh, ash, dash, busybox
@@ -51,7 +51,8 @@
 -- Power Shell Install:
 --
 --     * put something like this in your config file:
---         iex ($(lua /path/to/z.lua --init powershell) -join "`n")
+--         Invoke-Expression (& { 
+--           (lua /path/to/z.lua --init powershell) -join "`n" })
 --
 -- Windows Install (with Clink):
 --     * copy z.lua and z.cmd to clink's home directory
@@ -63,6 +64,10 @@
 --     * Add cmder/vendor to %PATH%
 --     * Ensure that "lua" can be called in %PATH%
 --
+-- Windows WSL-1:
+--     * Install lua-filesystem module before init z.lua:
+--         sudo apt-get install lua-filesystem
+--
 -- Configure (optional):
 --   set $_ZL_CMD in .bashrc/.zshrc to change the command (default z).
 --   set $_ZL_DATA in .bashrc/.zshrc to change the datafile (default ~/.zlua).
@@ -2081,6 +2086,8 @@ function z_clink_init()
 	end
 	local z_parser = clink.arg.new_parser()
 	z_parser:set_arguments({ z_match_completion })
+	z_parser:set_flags("-c", "-r", "-i", "--cd", "-e", "-b", "--add", "-x", "--purge", 
+		"--init", "-l", "-s", "--complete", "--help", "-h")
 	clink.arg.register_parser("z", z_parser)
 end
 
@@ -2546,12 +2553,18 @@ if /i "%RunMode%"=="-n" (
 			pushd !NewPath!
 			pushd !NewPath!
 			endlocal
-			popd
+			goto popdir
 		)
 	)
 )	else (
 	call "%LuaExe%" "%LuaScript%" "%RunMode%" %MatchType% %StrictSub% %InterMode% %StripMode% %*
 )
+goto end
+:popdir
+popd
+setlocal
+set "NewPath=%CD%"
+endlocal & popd & cd /d "%NewPath%"
 :end
 ]]
 
@@ -2735,4 +2748,5 @@ if not pcall(debug.getlocal, 4, 1) then
 	end
 end
 
+-- vim: set ts=4 sw=4 tw=0 noet :