summaryrefslogtreecommitdiff
path: root/plugins/colored-man-pages/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-08-07 20:10:54 +0200
committerGitHub <noreply@github.com>2019-08-07 20:10:54 +0200
commit2156b4c08134e3918af78038416c407e4b28dbf6 (patch)
tree930f78ede08f551a0de72986fb083ea947202f49 /plugins/colored-man-pages/README.md
parent89366be43fd6ceff52a9da2f2edef654ab619514 (diff)
parent26aad59779b2cd7ce313798a4e6b76a29b9f2347 (diff)
downloadzsh-2156b4c08134e3918af78038416c407e4b28dbf6.tar.gz
zsh-2156b4c08134e3918af78038416c407e4b28dbf6.tar.bz2
zsh-2156b4c08134e3918af78038416c407e4b28dbf6.zip
colored-man-pages: add option to color any help command (#7173)
This allows you to use `colored git log --help` for example, to get colored output.
Diffstat (limited to 'plugins/colored-man-pages/README.md')
-rw-r--r--plugins/colored-man-pages/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/colored-man-pages/README.md b/plugins/colored-man-pages/README.md
new file mode 100644
index 000000000..d9f6acb2a
--- /dev/null
+++ b/plugins/colored-man-pages/README.md
@@ -0,0 +1,15 @@
+# Colored man pages plugin
+
+This plugin adds colors to man pages.
+
+To use it, add `colored-man-pages` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... colored-man-pages)
+```
+
+You can also try to color other pages by prefixing the respective command with `colored`:
+
+```zsh
+colored git help clone
+```