diff options
| author | Maxime Coste <mawww@kakoune.org> | 2017-09-18 10:07:40 +0900 |
|---|---|---|
| committer | Maxime Coste <mawww@kakoune.org> | 2017-09-18 10:07:40 +0900 |
| commit | fe50e852038feb94abc4e0c2d12beddcc88629b5 (patch) | |
| tree | 44ddf5bc40ab33a01dcc7ce451d202b75d688102 | |
| parent | 3d79395e63255aa8b0991b13dc90e6ad7e6d9d02 (diff) | |
| parent | 2780467329989081a0b79230b46d9fdc1c4caa23 (diff) | |
Merge remote-tracking branch 'lenormf/fix-doc'
| -rw-r--r-- | README.asciidoc | 4 | ||||
| -rw-r--r-- | doc/manpages/highlighters.asciidoc | 26 |
2 files changed, 23 insertions, 7 deletions
diff --git a/README.asciidoc b/README.asciidoc index 83d2acaa..efea14f3 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -1264,7 +1264,7 @@ General highlighters are: * `regex <ex> <capture_id>:<face>...`: highlight a regex, takes the regex as first parameter, followed by any number of face parameters. - For example: `:add-highlighter regex (\hTODO:)?[^\n] 0:cyan 1:yellow,red` + For example: `:add-highlighter regex //\h*(TODO:)[^\n]* 0:cyan 1:yellow,red` will highlight C++ style comments in cyan, with an eventual 'TODO:' in yellow on red background. * `dynregex`: Similar to regex, but expand (like a command parameter would) the @@ -1286,6 +1286,8 @@ General highlighters are: The string part of the is interpretted as a face to apply to the range. * `replace-ranges <option_name>`: use the data in the range-specs option of the given name to highlight the buffer. The string part of the is interpretted as a display line to display in place of the range. + * `column <number> <face>`: highlight column 'number' with the given face + * `line <number> <face>`: highlight line 'number' with the given face Highlighting Groups ^^^^^^^^^^^^^^^^^^^ diff --git a/doc/manpages/highlighters.asciidoc b/doc/manpages/highlighters.asciidoc index e421813c..13a04c02 100644 --- a/doc/manpages/highlighters.asciidoc +++ b/doc/manpages/highlighters.asciidoc @@ -32,9 +32,9 @@ General highlighters highlight a regex, takes the regex as first parameter, followed by any number of face parameters. For example: ---------------------------------------------------------------- - add-highlighter regex //(\hTODO:)?[^\n] 0:cyan 1:yellow,red ---------------------------------------------------------------- +---------------------------------------------------------------- + add-highlighter regex //\h*(TODO:)[^\n]* 0:cyan 1:yellow,red +---------------------------------------------------------------- will highlight C++ style comments in cyan, with an eventual 'TODO:' in yellow on red background @@ -93,6 +93,9 @@ General highlighters *-width <max_width>*::: wrap text at *max_width* if the window is wider. +*fill* <face>:: + fill using the given *face*, mostly useful with regions highlighters + *ranges* <option_name>:: use the data in the range-specs option of the given name to highlight the buffer. The string part of the is interpretted as a face to apply @@ -103,13 +106,16 @@ General highlighters the buffer. The string part of the is interpretted as a display line to display in place of the range. -*fill* <face>:: - fill using the given *face*, mostly useful with regions highlighters +*column* <number> <face>:: + highlight column *number* with face *face* + +*line* <number> <face>:: + highlight line *number* with face *face* Highlighting Groups ------------------- -The group highlighter is a container for other highlighters. You can add a +The *group* highlighter is a container for other highlighters. You can add a group to the current window using ---------------------------- @@ -131,6 +137,14 @@ add-highlighter -group <name> group <subname> add-highlighter -group <name>/<subname> <type> <params>... ---------------------------------------------------------- +In order to specify which kinds of highlighters can be added to a given group, the *-passes* +flag set can be passed along with the group name. Possible values for this option can be one +or several (separated with a pipe sign) of *colorize*, *move* or *wrap* (default: *colorize*): + +------------------------------------------------------- +add-highlighter group -passes colorize|move|wrap <name> +------------------------------------------------------- + Regions highlighters -------------------- |
