zsh-syntax-highlighting/highlighters/pattern/README.md

zsh-syntax-highlighting / highlighters / pattern
================================================

This is the `pattern` highlighter, that highlights user defined patterns.


How to activate it
------------------

To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:

    ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] pattern)


How to tweak it
---------------

To use this highlighter, associate patterns with styles in the
`ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`:

    # To have commands starting with `rm -rf` in red:
    ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red')

The syntax for declaring styles is documented in [the `zshzle(1)` manual
page](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#SEC135).
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-12 22:57:14 +02:00			`zsh-syntax-highlighting / highlighters / pattern`
			`================================================`

docs copyedit: Restyle bold-italic to fixed-width. 2015-11-17 04:00:50 +01:00			This is the `pattern` highlighter, that highlights user defined patterns.
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-12 22:57:14 +02:00

			`How to activate it`
			`------------------`
docs copyedit: Whitespace. 2015-11-17 03:54:53 +01:00
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-12 22:57:14 +02:00			To activate it, add it to `ZSH_HIGHLIGHT_HIGHLIGHTERS`:

			`ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] pattern)`


			`How to tweak it`
			`---------------`
docs copyedit: Whitespace. 2015-11-17 03:54:53 +01:00
docs copyedit: Rewrap to 80 columns, part 2. 2015-11-17 04:02:39 +01:00			`To use this highlighter, associate patterns with styles in the`
			`ZSH_HIGHLIGHT_PATTERNS` array, for example in `~/.zshrc`:
Big refactoring. * Don't override user defined styles * Better modularisation of highlighters * Allow to define which highlighters are activated * Allow to define the order in which they are defined * Minor performance optimizations * Fixed some variables leak * Improve documentation * Brackets highlighter: use ZSH_HIGHLIGHT_STYLES instead of a specific array 2011-06-12 22:57:14 +02:00
			# To have commands starting with `rm -rf` in red:
			`ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red')`

docs copyedit: Port 6d93ea07fd61 to the other highlighters' README's. 2015-11-17 03:56:39 +01:00			The syntax for declaring styles is documented in [the `zshzle(1)` manual
			`page](http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#SEC135).`