stow/oh-my-zsh/.oh-my-zsh/plugins/colored-man-pages/README.md

   1 # Colored man pages plugin
   2
   3 This plugin adds colors to man pages.
   4
   5 To use it, add `colored-man-pages` to the plugins array in your zshrc file:
   6
   7 ```zsh
   8 plugins=(... colored-man-pages)
   9 ```
  10
  11 It will also automatically colorize man pages displayed by `dman` or `debman`,
  12 from [`debian-goodies`](https://packages.debian.org/stable/debian-goodies).
  13
  14 You can also try to color other pages by prefixing the respective command with `colored`:
  15
  16 ```zsh
  17 colored git help clone
  18 ```
  19
  20 ## Customization
  21
  22 The plugin declares global associative array `less_termcap`, which maps termcap capabilities to escape
  23 sequences for the `less` pager. This mapping can be further customized by the user after the plugin is
  24 loaded. Check out sources for more.
  25
  26 For example: `less_termcap[md]` maps to `LESS_TERMCAP_md` which is the escape sequence that tells `less`
  27 how to print something in bold. It's currently shown in bold red, but if you want to change it, you
  28 can redefine `less_termcap[md]` in your zshrc file, after OMZ is sourced:
  29
  30 ```zsh
  31 less_termcap[md]="${fg_bold[blue]}" # this tells less to print bold text in bold blue
  32 ```