From bbab4001de28fe7fbed488b6e08121265d730601 Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Tue, 19 Jul 2016 10:20:42 +0100 Subject: [PATCH] Document ranges highlighters They were not, as pointed out in #736 --- README.asciidoc | 4 ++++ doc/manpages/highlighters.asciidoc | 4 ++++ doc/manpages/options.asciidoc | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index 48dbcc5f..059dbeb7 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -816,6 +816,9 @@ Options are typed, their type can be * `{int,str}-list`: a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash. + * `range-faces`: a list, elements are separated by a colon (:), of + a buffer range (.,.) + and a face (separated by `|`) * `enum(value1|value2|...)`: an enum, taking on of the given values * `flags(value1|value2|...)`: a set of flags, taking a combination of the given values joined by `|`. @@ -1160,6 +1163,7 @@ general highlighters are: -separator switch one can specify a string to separate the line numbers column with the rest of the buffer, default is `|`. * `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. Highlighting Groups ^^^^^^^^^^^^^^^^^^^ diff --git a/doc/manpages/highlighters.asciidoc b/doc/manpages/highlighters.asciidoc index 0f0b829b..f8f48896 100644 --- a/doc/manpages/highlighters.asciidoc +++ b/doc/manpages/highlighters.asciidoc @@ -64,6 +64,10 @@ General highlighters specify a string to separate the line numbers column with the rest of the buffer (default is '|') +*ranges* :: + use the data in the range-faces option of the given name to highlight + the buffer. + *fill* :: fill using the given *face*, mostly useful with regions highlighters diff --git a/doc/manpages/options.asciidoc b/doc/manpages/options.asciidoc index 75c1e217..77761481 100644 --- a/doc/manpages/options.asciidoc +++ b/doc/manpages/options.asciidoc @@ -22,6 +22,10 @@ Types a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash +*range-faces*:: + a list, elements are separated by a colon (:), of pairs of buffer + range (`.,.`) and + face (separated by `|`) *enum(value1|value2|...)*:: an enum, taking one of the given values *flags(value1|value2|...)*::