From ff15f6bbaff698e3ad760bd5041f8f15b47f3a4b Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Sat, 6 May 2017 16:21:10 +0100 Subject: [PATCH] Document the wrap highlighter --- README.asciidoc | 1 + doc/manpages/highlighters.asciidoc | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index 5abcc032..14c6db8a 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -1241,6 +1241,7 @@ General highlighters are: -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 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 `: fill using given face, mostly useful with <> * `ranges `: use the data in the range-faces option of the given name to highlight the buffer. diff --git a/doc/manpages/highlighters.asciidoc b/doc/manpages/highlighters.asciidoc index b196c268..569b300d 100644 --- a/doc/manpages/highlighters.asciidoc +++ b/doc/manpages/highlighters.asciidoc @@ -84,6 +84,12 @@ General highlighters specify a string to separate the line numbers column with 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* :: use the data in the range-faces option of the given name to highlight the buffer.