diff options
| author | Rubén Durán Balda <ruduran@users.noreply.github.com> | 2018-10-05 20:23:30 +0200 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-05 20:23:30 +0200 |
| commit | ae548a99733d869f52efa36f146bd020a786a41e (patch) | |
| tree | b849de6b6e4bee9031fe26394802aae61b313f15 | |
| parent | 08f2fc12143175d011d69189679b0ed4c834b5c7 (diff) | |
| download | zsh-ae548a99733d869f52efa36f146bd020a786a41e.tar.gz zsh-ae548a99733d869f52efa36f146bd020a786a41e.tar.bz2 zsh-ae548a99733d869f52efa36f146bd020a786a41e.zip | |
jump: add README (#7237)
| -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 | |