diff options
Diffstat (limited to 'plugins/man')
| -rw-r--r-- | plugins/man/README.md | 13 | ||||
| -rw-r--r-- | plugins/man/man.plugin.zsh | 27 |
2 files changed, 40 insertions, 0 deletions
diff --git a/plugins/man/README.md b/plugins/man/README.md new file mode 100644 index 000000000..4601252c0 --- /dev/null +++ b/plugins/man/README.md @@ -0,0 +1,13 @@ +# Man plugin + +This plugin adds a shortcut to insert man before the previous command. + +To use it, add `man` to the plugins array in your zshrc file: + +```zsh +plugins=(... man) +``` +# Keyboard Shortcuts +| Shortcut | Description | +|-----------------------------------|------------------------------------------------------------------------| +| <kbd>Esc</kbd> + man | add man before the previous command to see the manual for this command | diff --git a/plugins/man/man.plugin.zsh b/plugins/man/man.plugin.zsh new file mode 100644 index 000000000..94aa4918d --- /dev/null +++ b/plugins/man/man.plugin.zsh @@ -0,0 +1,27 @@ +# ------------------------------------------------------------------------------ +# Author +# ------ +# +# * Jerry Ling<jerryling315@gmail.com> +# +# ------------------------------------------------------------------------------ +# Usage +# ----- +# +# man will be inserted before the command +# +# ------------------------------------------------------------------------------ + +man-command-line() { + [[ -z $BUFFER ]] && zle up-history + [[ $BUFFER != man\ * ]] && LBUFFER="man $LBUFFER" +} +zle -N man-command-line +# Defined shortcut keys: [Esc]man +bindkey "\e"man man-command-line + + +# ------------------------------------------------------------------------------ +# Also, you might want to use man-preview included in 'osx' plugin +# just substitute "man" in the function with "man-preview" after you included OS X in +# the .zshrc |