mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-19 21:41:07 +01:00
jump: add README (#7237)
This commit is contained in:
parent
08f2fc1214
commit
ae548a9973
1 changed files with 19 additions and 0 deletions
19
plugins/jump/README.md
Normal file
19
plugins/jump/README.md
Normal file
|
@ -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 |
|
Loading…
Reference in a new issue