diff options
author | Christoph Bachhuber <cbachhuber89@gmail.com> | 2020-03-11 18:17:08 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-11 18:17:08 +0100 |
commit | ff6d111d793970fc522dd3743367a4c3c46f5fc2 (patch) | |
tree | 1c55974f6b643e47fb97968799cec8cc8c7f3b04 /plugins | |
parent | 27f4e079329dabf8e7008b98c8bddf443116eb54 (diff) | |
download | zsh-ff6d111d793970fc522dd3743367a4c3c46f5fc2.tar.gz zsh-ff6d111d793970fc522dd3743367a4c3c46f5fc2.tar.bz2 zsh-ff6d111d793970fc522dd3743367a4c3c46f5fc2.zip |
z: add markdown Readme (#8715)
Diffstat (limited to 'plugins')
-rw-r--r-- | plugins/z/README.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/z/README.md b/plugins/z/README.md new file mode 100644 index 000000000..ea8d4610a --- /dev/null +++ b/plugins/z/README.md @@ -0,0 +1,23 @@ +# z - jump around + +This plugin defines the [z command](https://github.com/rupa/z) that tracks your most visited directories and allows you to access them with very few keystrokes. + +### Example +Assume that you have previously visited directory `~/.oh-my-zsh/plugins`. From any folder in your command line, you can quickly access it by using a regex match to this folder: + +```bash +/usr/bin$ z plug # Even 'z p' might suffice +~/.oh-my-zsh/plugins$ +``` + +### Setup +To enable z, add `z` to your `plugins` array in your zshrc file: + +```zsh +plugins=(... z) +``` + +### Further reading + +For advanced usage and details of z, see [README](./README) (in man page format, copied from [rupa/z](https://github.com/rupa/z)). + |