History

Julien Nicoulaud 0772ddd346 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
..
test-data	Big refactoring.	2011-06-12 22:57:14 +02:00
main-highlighter.zsh	Big refactoring.	2011-06-12 22:57:14 +02:00
README.md	Big refactoring.	2011-06-12 22:57:14 +02:00

README.md

zsh-syntax-highlighting / highlighters / main

This is the main highlighter, that highlights:

Commands
Options
Arguments
Paths
Strings

How to activate it

To activate it, add it to ZSH_HIGHLIGHT_HIGHLIGHTERS:

ZSH_HIGHLIGHT_HIGHLIGHTERS=( [...] main)

This highlighter is active by default.

How to tweak it

This highlighter defines the following styles:

unknown-token - unknown tokens / errors
reserved-word - shell reserved words
alias - aliases
builtin - shell builtin commands
function - functions
command - commands
hashed-command - hashed commands
path - paths
globbing - globbing expressions
history-expansion - history expansion expressions
single-hyphen-option - single hyphen options
double-hyphen-option - double hyphen options
back-quoted-argument - backquoted expressions
single-quoted-argument - single quoted arguments
double-quoted-argument - double quoted arguments
dollar-double-quoted-argument - dollar double quoted arguments
back-double-quoted-argument - back double quoted arguments
assign - variable assignments
default - parts of the buffer that do not match anything

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

# To differentiate aliases from other command types
ZSH_HIGHLIGHT_STYLES[alias]='fg=magenta,bold'

# To have paths colored instead of underlined
ZSH_HIGHLIGHT_STYLES[path]='fg=cyan'

# To disable highlighting of globbing expressions
ZSH_HIGHLIGHT_STYLES[globbing]='none'

The syntax for declaring styles is documented here.