stow/oh-my-zsh/.oh-my-zsh/plugins/jump/README.md

   1 # Jump plugin
   2
   3 This plugin allows to easily jump around the file system by manually adding marks.
   4 Those marks are stored as symbolic links in the directory `$MARKPATH` (default `$HOME/.marks`)
   5
   6 To use it, add `jump` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... jump)
  10 ```
  11
  12 ## Commands
  13
  14 | Command              | Description                                                                                     |
  15 |----------------------|-------------------------------------------------------------------------------------------------|
  16 | `jump <mark-name>`   | Jump to the given mark                                                                          |
  17 | `mark [mark-name]`   | Create a mark with the given name or with the name of the current directory if none is provided |
  18 | `unmark <mark-name>` | Remove the given mark                                                                           |
  19 | `marks`              | List the existing marks and the directories they point to                                       |
  20
  21 ## Key bindings
  22
  23 Pressing `CTRL`+`G` substitutes the written mark name for the full path of the mark.
  24 For example, with a mark named `mymark` pointing to `/path/to/my/mark`:
  25 ```zsh
  26 $ cp /tmp/file mymark<C-g>
  27 ```
  28 will become:
  29 ```zsh
  30 $ cp /tmp/file /path/to/my/mark
  31 ```