zsh-syntax-highlighting/docs/highlighters/cursor.md
Daniel Shahaf 7ee350efcd docs: Port new text to individual highlighters' documentation.
The new text is from the preceding two commits, 22123ab622 + ded1c8789b.

Fixes a broken link.
2015-11-24 07:39:44 +00:00

755 B

zsh-syntax-highlighting / highlighters / cursor

This is the cursor highlighter, that highlights the cursor.

How to tweak it

This highlighter defines the following styles:

  • cursor - the style for the current cursor position

To override one of those styles, change its entry in ZSH_HIGHLIGHT_STYLES, for example in ~/.zshrc:

ZSH_HIGHLIGHT_STYLES[cursor]='bg=blue'

The syntax for values is the same as the syntax of "types of highlighting" of the zsh builtin $zle_highlight array, which is documented in the zshzle(1) manual page.