xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document the update-option command

Browse Source
This commit is contained in:
Maxime Coste 2017-05-25 09:02:10 +01:00
parent 83d85df26e
commit 43e8edd3a3
2 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/manpages/commands.asciidoc
View File

@ -85,16 +85,24 @@ command *q!* has to be used).
*nop*:: *nop*::
does nothing, but arguments will be evaluated (e.g. shell expansion) does nothing, but arguments will be evaluated (e.g. shell expansion)
*set* <scope> <name> <value>:: *declare-option* [-hidden] <type> <name> [<value>]::
declare a new option, the -hidden hides the option in completion
suggestions (c.f. the 'options' documentation page)
*set-option* <scope> <name> <value>::
change the value of an option (c.f. the 'options' documentation page), change the value of an option (c.f. the 'options' documentation page),
note that the name of a particular buffer can be specified when the note that the name of a particular buffer can be specified when the
target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar";
the scope can also take the `current` special value, which will automatically the scope can also take the `current` special value, which will automatically
point to the narrowest scope available in the current context point to the narrowest scope available in the current context
*unset* <scope> <name>:: *unset-option* <scope> <name>::
unset the value of an option (c.f. the 'options' documentation page) unset the value of an option (c.f. the 'options' documentation page)
*update-option* <scope> <name>::
update the value of an option if its type supports that operation
(c.f. the 'options' documentation page)
*alias* <scope> <name> <command>:: *alias* <scope> <name> <command>::
define a new alias, within the context of a scope define a new alias, within the context of a scope
@ -102,10 +110,6 @@ command *q!* has to be used).
remove an alias if its current value is the same as the one passed remove an alias if its current value is the same as the one passed
as an optional parameter, remove it unconditionally otherwise as an optional parameter, remove it unconditionally otherwise
*declare-option* [-hidden] <type> <name> [<value>]::
declare a new option, the -hidden hides the option in completion
suggestions (c.f. the 'options' documentation page)
*face* <name> <facespec>:: *face* <name> <facespec>::
define a face (c.f. the 'faces' documentation page) define a face (c.f. the 'faces' documentation page)

19
doc/manpages/options.asciidoc
View File

@ -22,14 +22,19 @@ Types
a list, elements are separated by a colon (:) if an element needs a list, elements are separated by a colon (:) if an element needs
to contain a colon, it can be escaped with a backslash to contain a colon, it can be escaped with a backslash
*range-specs*:: *range-specs*::
a `:` separated list of a pair of a buffer range a `:` separated list of a pair of a buffer range (`<begin
(`<begin line>.<begin column>,<end line>.<end column>` or line>.<begin column>,<end line>.<end column>` or `<begin
`<begin line>.<begin column>+<length>`) and a string (separated by `|`), line>.<begin column>+<length>`) and a string (separated by `|`),
except for the first element which is just the timestamp of the buffer. except for the first element which is just the timestamp of
*line-flags*:: the buffer. When the `update-option` is used on an option of
this type, its ranges gets updated according to all the buffer
modifications that happened since its timestamp.
*line-specs*::
a `:` separated list of a line number and a corresponding flag a `:` separated list of a line number and a corresponding flag
(`<line>|<flag text>`), except for the first element which is just the (`<line>|<flag text>`), except for the first element which is
timestamp of the buffer. just the timestamp of the buffer. When the `update-option` is
used on an option of this type, its lines gets updated according
to all the buffer modifications that happened since its timestamp.
*completions*:: *completions*::
a `:` separated list of `<text>|<docstring>|<menu text>` a `:` separated list of `<text>|<docstring>|<menu text>`
candidates, except for the first element which follows the candidates, except for the first element which follows the