summaryrefslogtreecommitdiff
path: root/plugins/man/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-10-14 19:36:57 +0200
committerGitHub <noreply@github.com>2018-10-14 19:36:57 +0200
commit793ee0ffa84ef1f582bb56f53374ce15fea6e09d (patch)
tree434c32c09711b44db09e13271c2f4ad8db1068ef /plugins/man/README.md
parent9275d1fc98f61d353a900c698d7b53592036803d (diff)
parent4a5fa087b89c5f26d93c610147db478b78efae4d (diff)
downloadzsh-793ee0ffa84ef1f582bb56f53374ce15fea6e09d.tar.gz
zsh-793ee0ffa84ef1f582bb56f53374ce15fea6e09d.tar.bz2
zsh-793ee0ffa84ef1f582bb56f53374ce15fea6e09d.zip
man: add README (#7276)
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..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 |