Browse Source

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.
Marc Cornellà 4 years ago
parent
commit
2156b4c081

+ 15 - 0
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
+```

+ 6 - 2
plugins/colored-man-pages/colored-man-pages.plugin.zsh

@@ -16,7 +16,7 @@ EOF
 	fi
 fi
 
-function man() {
+function colored() {
 	env \
 		LESS_TERMCAP_mb=$(printf "\e[1;31m") \
 		LESS_TERMCAP_md=$(printf "\e[1;31m") \
@@ -28,5 +28,9 @@ function man() {
 		PAGER="${commands[less]:-$PAGER}" \
 		_NROFF_U=1 \
 		PATH="$HOME/bin:$PATH" \
-			man "$@"
+			"$@"
+}
+
+function man() {
+	colored man "$@"
 }