diff options
| author | Maxime Coste <frrrwww@gmail.com> | 2014-07-02 23:46:32 +0100 |
|---|---|---|
| committer | Maxime Coste <frrrwww@gmail.com> | 2014-07-05 12:10:06 +0100 |
| commit | 12ecffd36183fe182e2a496f1dd6d8be1fc7c7a9 (patch) | |
| tree | 1d4103904952fb065c724189ecd4e40098e53a42 | |
| parent | ed68d1ff287d43c5293abb4d41e908aa8e50afec (diff) | |
Improve colalias documentation in README
| -rw-r--r-- | README.asciidoc | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/README.asciidoc b/README.asciidoc index 3b595f8d..c1333405 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -817,19 +817,27 @@ a single key name and +keys+ a list of keys. Color Aliases ------------- -Colorspec takes the form <fg_color>[,<bg_color>], they can be named using the -following command. +Color aliases give a name to a pair of foreground/background colors, and +can be used in place of them. -------------------------- -:colalias <name> <colspec> +:colalias <name> <fg_color[,bg_color]> -------------------------- -note that colspec can itself be a color alias. +fg_color and bg_color can be: + + * A named color: +black, red, green, yellow, blue, magenta, cyan, white+. + * +default+, which keeps the existing color + * An rgb color: +rgb:RRGGBB+, with RRGGBB the hexadecimal value of the color. + +not specifying bg_color uses +default+ + +In place of +<fg_color[,bg_color]>+, another color alias name can be referenced. Using color alias instead of colorspec permits to change the effective colors afterward. -there are some builtins color aliases: +there are some builtins color aliases used by internal Kakoune functionalities: * +PrimarySelection+: main selection color for every selected character except the cursor |