diff options
| author | Alex Leferry 2 <alexherbo2@gmail.com> | 2017-01-04 01:07:45 +0100 |
|---|---|---|
| committer | Alex Leferry 2 <alexherbo2@gmail.com> | 2017-01-04 13:04:27 +0100 |
| commit | 671b50bb524ecb7e7654549ab35fd1da0a184a7e (patch) | |
| tree | e420dbabfacf90847f7658e054680a6c5736d45e /doc | |
| parent | 8f821f0fba48366e0407e5cffece9fa5ffa5a67f (diff) | |
update command names
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manpages/highlighters.asciidoc | 82 | ||||
| -rw-r--r-- | doc/manpages/hooks.asciidoc | 4 |
2 files changed, 43 insertions, 43 deletions
diff --git a/doc/manpages/highlighters.asciidoc b/doc/manpages/highlighters.asciidoc index f8f48896..1666be7f 100644 --- a/doc/manpages/highlighters.asciidoc +++ b/doc/manpages/highlighters.asciidoc @@ -11,19 +11,19 @@ Description Manipulation of the displayed text is done through highlighters, which can be added or removed with the following commands: -------------------------------------------------------- -addhl <highlighter_name> <highlighter_parameters> ... -------------------------------------------------------- +--------------------------------------------------------------- +add-highlighter <highlighter_name> <highlighter_parameters> ... +--------------------------------------------------------------- and ------------------------ -rmhl <highlighter_id> ------------------------ +----------------------------------- +remove-highlighter <highlighter_id> +----------------------------------- *highlighter_id* is a name generated by the highlighter specified with *highlighter_name*, possibly dependent on the parameters. Use command -completion in a prompt on the *rmhl* command to see the existing highlighters +completion in a prompt on the *remove-highlighter* command to see the existing highlighters ids. General highlighters @@ -32,9 +32,9 @@ General highlighters highlight a regex, takes the regex as first parameter, followed by any number of face parameters. For example: ------------------------------------------------------ - addhl regex //(\hTODO:)?[^\n] 0:cyan 1:yellow,red ------------------------------------------------------ +--------------------------------------------------------------- + add-highlighter regex //(\hTODO:)?[^\n] 0:cyan 1:yellow,red +--------------------------------------------------------------- will highlight C++ style comments in cyan, with an eventual 'TODO:' in yellow on red background @@ -77,24 +77,24 @@ Highlighting Groups The group highlighter is a container for other highlighters. You can add a group to the current window using --------------------- -addhl group <name> --------------------- +---------------------------- +add-highlighter group <name> +---------------------------- -The *-group* switch of the *addhl* command provides a mean to add highlighters +The *-group* switch of the *add-highlighter* command provides a mean to add highlighters inside this group: ----------------------------------------- -addhl -group <name> <type> <params>... ----------------------------------------- +------------------------------------------------ +add-highlighter -group <name> <type> <params>... +------------------------------------------------ Groups can contain other groups, the *-group* switch can be used to define a path as follows: --------------------------------------------------- -addhl -group <name> group <subname> -addhl -group <name>/<subname> <type> <params>... --------------------------------------------------- +---------------------------------------------------------- +add-highlighter -group <name> group <subname> +add-highlighter -group <name>/<subname> <type> <params>... +---------------------------------------------------------- Regions highlighters -------------------- @@ -136,16 +136,16 @@ of regions. The following command: ------------------------------------------------------------------------ -addhl regions <name> <region_name1> <opening1> <closing1> <recurse1> +------------------------------------------------------------------------------ +add-highlighter regions <name> <region_name1> <opening1> <closing1> <recurse1> <region_name2> <opening2> <closing2> <recurse2>... ------------------------------------------------------------------------ +------------------------------------------------------------------------------ defines multiple regions in which other highlighters can be added as follows: ---------------------------------------- -addhl -group <name>/<region_name> ... ---------------------------------------- +----------------------------------------------- +add-highlighter -group <name>/<region_name> ... +----------------------------------------------- Regions are matched using the left-most rule: the left-most region opening starts a new region. When a region closes, the closest next opening start @@ -160,13 +160,13 @@ Most programming languages can then be properly highlighted using a regions highlighter as root: ----------------------------------------------------------------- -addhl regions -default code <lang> \ +add-highlighter regions -default code <lang> \ string <str_opening> <str_closing> <str_recurse> \ comment <comment_opening> <comment_closing> <comment_recurse> -addhl -group <lang>/code ... -addhl -group <lang>/string ... -addhl -group <lang>/comment ... +add-highlighter -group <lang>/code ... +add-highlighter -group <lang>/string ... +add-highlighter -group <lang>/comment ... ----------------------------------------------------------------- Shared Highlighters @@ -177,9 +177,9 @@ sense to share the highlighters between all the windows on the same filetypes. A shared highlighter can be defined with the following command: --------------------------------- -addhl -group /<group_name> ... --------------------------------- +---------------------------------------- +add-highlighter -group /<group_name> ... +---------------------------------------- When the group switch values starts with a '/', it references a group in the shared highlighters, rather than the window highlighters. @@ -187,15 +187,15 @@ the shared highlighters, rather than the window highlighters. The common case would be to create a named shared group, and then fill it with highlighters: ------------------------------- -addhl -group / group <name> -addhl -group /name regex ... ------------------------------- +-------------------------------------- +add-highlighter -group / group <name> +add-highlighter -group /name regex ... +-------------------------------------- It can then be referenced in a window using the ref highlighter. ------------------- -addhl ref <name> ------------------- +-------------------------- +add-highlighter ref <name> +-------------------------- The ref can reference any named highlighter in the shared namespace. diff --git a/doc/manpages/hooks.asciidoc b/doc/manpages/hooks.asciidoc index 9a5b00ba..338f0b24 100644 --- a/doc/manpages/hooks.asciidoc +++ b/doc/manpages/hooks.asciidoc @@ -25,14 +25,14 @@ For example to automatically use line numbering with .cc files, use the following command: ---------------------------------------------------- -hook global WinCreate .*\.cc %{ addhl number_lines } +hook global WinCreate .*\.cc %{ add-highlighter number_lines } ---------------------------------------------------- if *group* is given, make this hook part of the named group. Groups are used for removing hooks with the following command: ----------------------- -rmhooks <scope> <group> +remove-hooks <scope> <group> ----------------------- A call to the command above will remove every hooks in *scope* that are part |
