summaryrefslogtreecommitdiff
path: root/plugins/colored-man-pages/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2020-11-21 14:57:26 -0700
committerTuowen Zhao <ztuowen@gmail.com>2020-11-21 14:57:26 -0700
commit3aaa0bc62ece494dd2b6e47a191de79e562156f9 (patch)
tree53b623b60358bd9b8a5f9d267166f717e2f3947c /plugins/colored-man-pages/README.md
parent058885f5263f29f046c96ea2ecf55e6dca3ed321 (diff)
parent88b3f028f4a2ffa4f3853a11e4b8e0d78008ca34 (diff)
downloadzsh-3aaa0bc62ece494dd2b6e47a191de79e562156f9.tar.gz
zsh-3aaa0bc62ece494dd2b6e47a191de79e562156f9.tar.bz2
zsh-3aaa0bc62ece494dd2b6e47a191de79e562156f9.zip
Merge remote-tracking branch 'origin/master'
Diffstat (limited to 'plugins/colored-man-pages/README.md')
-rw-r--r--plugins/colored-man-pages/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/colored-man-pages/README.md b/plugins/colored-man-pages/README.md
index f34941e73..4cbf64d3e 100644
--- a/plugins/colored-man-pages/README.md
+++ b/plugins/colored-man-pages/README.md
@@ -16,3 +16,17 @@ You can also try to color other pages by prefixing the respective command with `
```zsh
colored git help clone
```
+
+## Customization
+
+The plugin declares global associative array `less_termcap`, which maps termcap capabilities to escape
+sequences for the `less` pager. This mapping can be further customized by the user after the plugin is
+loaded. Check out sources for more.
+
+For example: `less_termcap[md]` maps to `LESS_TERMCAP_md` which is the escape sequence that tells `less`
+how to print something in bold. It's currently shown in bold red, but if you want to change it, you
+can redefine `less_termcap[md]` in your zshrc file, after OMZ is sourced:
+
+```zsh
+less_termcap[md]="${fg_bold[blue]}" # this tells less to print bold text in bold blue
+```