summaryrefslogtreecommitdiff
path: root/plugins/man/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/man/README.md')
-rw-r--r--plugins/man/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/plugins/man/README.md b/plugins/man/README.md
new file mode 100644
index 000000000..0fd3fead2
--- /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 |
+|-----------------------------------|------------------------------------------------------------------------|
+| <kpd>esc</kpd> + man | add man before the previous command to see the manual for this command |