summaryrefslogtreecommitdiff
path: root/plugins/man
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/man')
-rw-r--r--plugins/man/README.md13
-rw-r--r--plugins/man/man.plugin.zsh (renamed from plugins/man/man.zsh)4
2 files changed, 15 insertions, 2 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.zsh b/plugins/man/man.plugin.zsh
index 3490b0b61..94aa4918d 100644
--- a/plugins/man/man.zsh
+++ b/plugins/man/man.plugin.zsh
@@ -5,7 +5,7 @@
# * Jerry Ling<jerryling315@gmail.com>
#
# ------------------------------------------------------------------------------
-# Usgae
+# Usage
# -----
#
# man will be inserted before the command
@@ -24,4 +24,4 @@ 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 \ No newline at end of file
+# the .zshrc