From ed4daf7429bf2580118aad87b8f3e2011efed7ec Mon Sep 17 00:00:00 2001 From: Jacob McDonnell Date: Thu, 14 Jul 2022 19:09:06 -0400 Subject: Initial commit --- .../highlighters/pattern/README.md | 24 ++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .config/shells/zsh/plugins/zsh-syntax-highlighting/highlighters/pattern/README.md (limited to '.config/shells/zsh/plugins/zsh-syntax-highlighting/highlighters/pattern/README.md') diff --git a/.config/shells/zsh/plugins/zsh-syntax-highlighting/highlighters/pattern/README.md b/.config/shells/zsh/plugins/zsh-syntax-highlighting/highlighters/pattern/README.md new file mode 100644 index 0000000..e67d79f --- /dev/null +++ b/.config/shells/zsh/plugins/zsh-syntax-highlighting/highlighters/pattern/README.md @@ -0,0 +1,24 @@ +zsh-syntax-highlighting / highlighters / pattern +------------------------------------------------ + +This is the `pattern` highlighter, that highlights user-defined patterns. + + +### How to tweak it + +To use this highlighter, associate patterns with styles in the +`ZSH_HIGHLIGHT_PATTERNS` associative array, for example in `~/.zshrc`: + +```zsh +# Declare the variable +typeset -A ZSH_HIGHLIGHT_PATTERNS + +# To have commands starting with `rm -rf` in red: +ZSH_HIGHLIGHT_PATTERNS+=('rm -rf *' 'fg=white,bold,bg=red') +``` + +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][zshzle-Character-Highlighting]. + +[zshzle-Character-Highlighting]: http://zsh.sourceforge.net/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting -- cgit v1.2.3