1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-21 03:41:57 +00:00
ohmyzsh/plugins/jump/README.md
Marc Cornellà bc67a55fe8 jump: fix issues in plugin and document CTRL+G key binding
- Fixes `readlink -e` dependency which isn't supported in macOS
  (fixes #3235).
- Uses native zsh wildcard expansion instead of calls to `ls`.
- Prepends commands with `command` and `builtin` to bypass aliases
  and functions.
- Documents CTRL+G key binding to substitute mark name in the command
  line with the mark path (https://github.com/ohmyzsh/ohmyzsh/pull/2045#issuecomment-22826540).
2020-02-11 19:41:43 +01:00

31 lines
1.3 KiB
Markdown

# 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 |
## Key bindings
Pressing `CTRL`+`G` substitutes the written mark name for the full path of the mark.
For example, with a mark named `mymark` pointing to `/path/to/my/mark`:
```zsh
$ cp /tmp/file mymark<C-g>
```
will become:
```zsh
$ cp /tmp/file /path/to/my/mark
```