diff options
| author | Kozlov Alexander <badryke@gmail.com> | 2018-11-16 13:38:43 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-16 13:38:43 +0300 |
| commit | 8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch) | |
| tree | ee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/jump/README.md | |
| parent | dd30cf104c9ca42d89d26a134382ca421869ce7e (diff) | |
| parent | 3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff) | |
| download | zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2 zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip | |
Merge branch 'master' into master
Diffstat (limited to 'plugins/jump/README.md')
| -rw-r--r-- | plugins/jump/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/jump/README.md b/plugins/jump/README.md new file mode 100644 index 000000000..ed6415289 --- /dev/null +++ b/plugins/jump/README.md @@ -0,0 +1,19 @@ +# Jump plugin + +This plugin allows to easily jump around the file system by manually adding marks. +Those marks are stored as symbolic links in the directory `$MARKPATH` (default `$HOME/.marks`) + +To use it, add `jump` to the plugins array in your zshrc file: + +```zsh +plugins=(... jump) +``` + +## Commands + +| Command | Description | +|----------------------|-------------------------------------------------------------------------------------------------| +| `jump <mark-name>` | Jump to the given mark | +| `mark [mark-name]` | Create a mark with the given name or with the name of the current directory if none is provided | +| `unmark <mark-name>` | Remove the given mark | +| `marks` | List the existing marks and the directories they point to | |