mirror of
https://github.com/skywind3000/z.lua
synced 2026-03-21 07:09:49 +00:00
update doc
This commit is contained in:
17
README.cn.md
17
README.cn.md
@@ -114,21 +114,8 @@ Frecency 是一个由 'recent' 和 'frequency' 组成的合成词,这个术语
|
||||
对于 z.lua,一条路径如果访问次数过低,它的 rank 值就会比较低,但是如果它最近被访问过,那么它将迅速获得一个比其他曾经频繁访问但是最近没有访问过的路径更高的权重。Frecent 并不记录在数据库中,是运行的时候即时计算出来的。
|
||||
|
||||
|
||||
## Matching
|
||||
|
||||
z.lua 提供两种路径匹配算法:
|
||||
|
||||
- 设置 $_ZL_MATCH_MODE=0:默认匹配算法,兼容 z.sh。
|
||||
- 设置 $_ZL_MATCH_MODE=1:增强匹配算法,更懂你的高效匹配算法。
|
||||
|
||||
除了设置环境变量外,还可以通过:
|
||||
|
||||
eval "$(lua /path/to/z.lua --init bash enhanced)"
|
||||
|
||||
来进入增强模式。
|
||||
|
||||
|
||||
### 默认匹配
|
||||
## 默认匹配算法
|
||||
|
||||
默认情况下 z.lua 使用和 z.sh 类似的匹配算法,成为默认匹配法。给定路径会按顺序匹配各个正则表达式。
|
||||
|
||||
@@ -149,7 +136,7 @@ z.lua 提供两种路径匹配算法:
|
||||
|
||||
`"z in"`将会跳转到 `/home/user/mail/inbox` 因为它有更高的权重,同时你可以传递更多参数给 z.lua 来更加精确的指明,如 `"z w in"` 则会让你跳到 `/home/user/work/inbox`。
|
||||
|
||||
### 增强匹配
|
||||
## 增强匹配算法
|
||||
|
||||
你可以通过设置环境变量来启用增强匹配模式:
|
||||
|
||||
|
||||
29
README.md
29
README.md
@@ -116,12 +116,7 @@ Frecency is a portmanteau of 'recent' and 'frequency'. It is a weighted rank tha
|
||||
To z.lua, a directory that has low ranking but has been accessed recently will quickly have higher rank than a directory accessed frequently a long time ago. Frecency is determined at runtime.
|
||||
|
||||
|
||||
## Matching
|
||||
|
||||
z.lua has two different matching methods: 0 for default, 1 for enhanced:
|
||||
|
||||
|
||||
### Default matching
|
||||
## Default Matching
|
||||
|
||||
By default, z.lua uses default matching method similar to the original z.sh. Paths must be match all of the regexes in order.
|
||||
|
||||
@@ -142,11 +137,19 @@ By default, z.lua uses default matching method similar to the original z.sh. Pat
|
||||
|
||||
`"z in"` would cd into `/home/user/mail/inbox` as the higher weighted entry. However you can pass multiple arguments to z.lua to prefer a different entry. In the above example, `"z w in"` would then change directory to `/home/user/work/inbox`.
|
||||
|
||||
### Enhanced matching
|
||||
## Enhanced Matching
|
||||
|
||||
Enhanced matching can be enabled by export the environment:
|
||||
Enhanced matching can be enabled by exporting the environment:
|
||||
|
||||
export _ZL_MATCH_MODE=1
|
||||
```bash
|
||||
export _ZL_MATCH_MODE=1
|
||||
```
|
||||
|
||||
Or, append a `enhanced` after `--init xxx`:
|
||||
|
||||
```bash
|
||||
eval "$(lua /path/to/z.lua --init bash enhanced)"
|
||||
```
|
||||
|
||||
For a given set of queries (the set of command-line arguments passed to z.lua), a path is a match if and only if:
|
||||
|
||||
@@ -200,7 +203,7 @@ If no match is found, it will fall back to default matching method.
|
||||
The default matching method is designed to be compatible with original z.sh, but the enhanced matching method is much more handy and exclusive to z.lua.
|
||||
|
||||
|
||||
## Add once
|
||||
## Add Once
|
||||
|
||||
By default, z.lua will add current directory to database each time before display command prompt (correspond with z.sh). But there is an option to allow z.lua add path only if current working directory changed.
|
||||
|
||||
@@ -214,7 +217,7 @@ source (lua /path/to/z.lua --init fish | psub)
|
||||
|
||||
It could be much faster on slow hardware or Cygwin/MSYS.
|
||||
|
||||
## Interective selection
|
||||
## Interective Selection
|
||||
|
||||
When there are multiple matches found, using `z -i` will display a list:
|
||||
|
||||
@@ -230,7 +233,7 @@ And then you can input the number and choose where to go before actual cd. eg. i
|
||||
|
||||
NOTE: for fish shell, this feature requires fish 2.7.0 or above.
|
||||
|
||||
## FZF supports
|
||||
## FZF Supports
|
||||
|
||||
From version 1.1.0, a new option `"-I"` will allow you to use fzf to select when there are multiple matches.
|
||||
|
||||
@@ -284,7 +287,7 @@ sys 0m0.030s
|
||||
As you see, z.lua is the fastest one and requires less resource.
|
||||
|
||||
|
||||
## Import database
|
||||
## Import Database
|
||||
|
||||
You can import your datafile from z.sh by:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user