Document the wrap highlighter

This commit is contained in:
Maxime Coste 2017-05-06 16:21:10 +01:00
parent 4032d05c79
commit ff15f6bbaf
2 changed files with 7 additions and 0 deletions

View File

@ -1241,6 +1241,7 @@ General highlighters are:
-hlcursor switch will highlight the cursor line with a separate face. With the -hlcursor switch will highlight the cursor line with a separate face. With the
-separator switch one can specify a string to separate the line numbers column with -separator switch one can specify a string to separate the line numbers column with
the rest of the buffer, default is `|`. the rest of the buffer, default is `|`.
* `wrap \<-word>`: Soft wrap buffer content to window width, wrap at word boundaries if `-word` is specified.
* `fill <face>`: fill using given face, mostly useful with <<regions-highlighters,Regions highlighters>> * `fill <face>`: fill using given face, mostly useful with <<regions-highlighters,Regions highlighters>>
* `ranges <option_name>`: use the data in the range-faces option of the given name to highlight the buffer. * `ranges <option_name>`: use the data in the range-faces option of the given name to highlight the buffer.

View File

@ -84,6 +84,12 @@ General highlighters
specify a string to separate the line numbers column with specify a string to separate the line numbers column with
the rest of the buffer (default is '|') the rest of the buffer (default is '|')
*wrap* [options]::
soft wrap buffer text at window width, with the following *options*:
*-word*:::
wrap at word boundaries instead of codepoint boundaries.
*ranges* <option_name>:: *ranges* <option_name>::
use the data in the range-faces option of the given name to highlight use the data in the range-faces option of the given name to highlight
the buffer. the buffer.