From ed4daf7429bf2580118aad87b8f3e2011efed7ec Mon Sep 17 00:00:00 2001 From: Jacob McDonnell Date: Thu, 14 Jul 2022 19:09:06 -0400 Subject: Initial commit --- .../docs/highlighters/root.md | 25 ++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .config/shells/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md (limited to '.config/shells/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md') diff --git a/.config/shells/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md b/.config/shells/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md new file mode 100644 index 0000000..d120d20 --- /dev/null +++ b/.config/shells/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md @@ -0,0 +1,25 @@ +zsh-syntax-highlighting / highlighters / root +--------------------------------------------- + +This is the `root` highlighter, that highlights the whole line if the current +user is root. + + +### How to tweak it + +This highlighter defines the following styles: + +* `root` - the style for the whole line if the current user is root. + +To override one of those styles, change its entry in `ZSH_HIGHLIGHT_STYLES`, +for example in `~/.zshrc`: + +```zsh +ZSH_HIGHLIGHT_STYLES[root]='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