diff options
author | justsaumit <justsaumit@draconyan.xyz> | 2022-03-02 11:23:45 +0530 |
---|---|---|
committer | justsaumit <justsaumit@draconyan.xyz> | 2022-03-02 11:23:45 +0530 |
commit | a754011fc58e83f38cadc5bc10492ab961c9c540 (patch) | |
tree | d7c3cd6fd254fb7e52759f77e44193bf103de177 /.config/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md | |
parent | 98bbe7bd7fcec209e2408ff0b086858715ca89e0 (diff) |
spring cleaning 0.1
Diffstat (limited to '.config/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md')
-rw-r--r-- | .config/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/.config/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md b/.config/zsh/plugins/zsh-syntax-highlighting/docs/highlighters/root.md new file mode 100644 index 0000000..8197e4b --- /dev/null +++ b/.config/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]: https://zsh.sourceforge.io/Doc/Release/Zsh-Line-Editor.html#Character-Highlighting |