doc: Document the buffer=/path/to/file scope syntax.

Also, make sure all commands that involve scopes link to the scopes
documentation, and refer to the "scope" parameter as `*scope*` for consistency.
This commit is contained in:
Tim Allen 2019-01-23 12:34:02 +11:00
parent cb7401439b
commit 4247cf6def
2 changed files with 33 additions and 16 deletions

View File

@ -96,20 +96,21 @@ of the file onto the filesystem
*set-option* [<switches>] <scope> <name> <value>:: *set-option* [<switches>] <scope> <name> <value>::
*alias* set + *alias* set +
change the value of an option change the value of an option in *scope*
note that the name of a particular buffer can be specified when the (See <<options#set-option,`:doc options set-option`>>
target *scope* is 'buffer', e.g. set buffer=/path/to/buffer foo "bar"; and <<scopes#,`:doc scopes`>>)
the scope can also take the `current` special value, which will automatically
point to the narrowest scope available in the current context
(See <<options#set-option,`:doc options set-option`>>)
*unset-option* <scope> <name>:: *unset-option* <scope> <name>::
*alias* unset + *alias* unset +
unset the value of an option (See <<options#unset-option,`:doc options unset-option`>>) unset the value of an option in *scope*, so the value from an outer scope
is used
(See <<options#unset-option,`:doc options unset-option`>>
and <<scopes#,`:doc scopes`>>)
*update-option* <scope> <name>:: *update-option* <scope> <name>::
update the value of an option if its type supports that operation update the value of an option if its type supports that operation
(See <<options#update-option,`:doc options update-option`>>) (See <<options#update-option,`:doc options update-option`>>
and <<scopes#,`:doc scopes`>>)
== Commands and Keys == Commands and Keys
@ -118,11 +119,13 @@ of the file onto the filesystem
define a new command (See <<declaring-new-commands,Declaring new commands>>) define a new command (See <<declaring-new-commands,Declaring new commands>>)
*alias* <scope> <name> <command>:: *alias* <scope> <name> <command>::
define a new alias, within the context of a scope define a new alias named *name* in *scope*
(See <<scopes#,`:doc scopes`>>)
*unalias* <scope> <name> [<command>]:: *unalias* <scope> <name> [<command>]::
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
(See <<scopes#,`:doc scopes`>>)
*evaluate-commands* [<switches>] <command> ...:: *evaluate-commands* [<switches>] <command> ...::
*alias* eval + *alias* eval +
@ -134,10 +137,12 @@ of the file onto the filesystem
execute a series of keys, as if they were hit (See <<execeval#,`:doc execeval`>>) execute a series of keys, as if they were hit (See <<execeval#,`:doc execeval`>>)
*map* [<switches>] <scope> <mode> <key> <keys>:: *map* [<switches>] <scope> <mode> <key> <keys>::
bind a list of keys to a combination (See <<mapping#,`:doc mapping`>>) bind a list of keys to a combination (See <<mapping#,`:doc mapping`>>
and <<scopes#,`:doc scopes`>>)
*unmap* <scope> <mode> <key> [<expected>]:: *unmap* <scope> <mode> <key> [<expected>]::
unbind a key combination (See <<mapping#,`:doc mapping`>>) unbind a key combination (See <<mapping#,`:doc mapping`>>
and <<scopes#,`:doc scopes`>>)
*declare-user-mode* <name>:: *declare-user-mode* <name>::
declare a new user keymap mode declare a new user keymap mode
@ -151,13 +156,13 @@ of the file onto the filesystem
== Hooks == Hooks
*hook* [-group <group>] <scope> <hook_name> <filtering_regex> <command>:: *hook* [-group <group>] <scope> <hook_name> <filtering_regex> <command>::
execute a command whenever an event is triggered execute *command* whenever an *hook_name* is triggered in *scope*
(See <<hooks#,`:doc hooks`>>) (See <<hooks#,`:doc hooks`>> and <<scopes#,`:doc scopes`>>)
*remove-hooks* <scope> <group>:: *remove-hooks* <scope> <group>::
*alias* rmhooks + *alias* rmhooks +
remove every hooks in *scope* that are part of the given *group* remove every hooks in *scope* that are part of the given *group*
(See <<hooks#,`:doc hooks`>>) (See <<hooks#,`:doc hooks`>> and <<scopes#,`:doc scopes`>>)
== Display == Display
@ -173,10 +178,12 @@ of the file onto the filesystem
*set-face* <scope> <name> <facespec>:: *set-face* <scope> <name> <facespec>::
*alias* face + *alias* face +
define a face in *scope* (See <<faces#,`:doc faces`>>) define a face in *scope*
(See <<faces#,`:doc faces`>> and <<scopes#,`:doc scopes`>>)
*unset-face* <scope> <name>:: *unset-face* <scope> <name>::
Remove a face definition from *scope* (See <<faces#,`:doc faces`>>) Remove a face definition from *scope*
(See <<faces#,`:doc faces`>> and <<scopes#,`:doc scopes`>>)
*colorscheme* <name>:: *colorscheme* <name>::
load named colorscheme load named colorscheme

View File

@ -46,6 +46,16 @@ The above priority line implies that objects can have individual values that
will be resolved first in the *window* scope (highest priority), then in will be resolved first in the *window* scope (highest priority), then in
the *buffer* scope, and finally in the *global* scope (lowest priority). the *buffer* scope, and finally in the *global* scope (lowest priority).
Normally, the *buffer* scope keyword means the scope associated with the
currently active buffer, but it's possible to specify any existing buffer by
adding an `=` and the value of `%val{buffile}` for that buffer
(See <<expansions#value-expansions,`:doc expansions value-expansions`>>).
For example, to set the `indentwidth` option for the `/etc/fstab` buffer::
----
set-option buffer=/etc/fstab indentwidth 8
----
The `set-option` and `unset-option` commands also accept *current* as The `set-option` and `unset-option` commands also accept *current* as
a valid scope name. It refers to the narrowest scope the option is set in. a valid scope name. It refers to the narrowest scope the option is set in.