Document the -docstring switch of the :map command
This commit is contained in:
parent
44451e2c54
commit
58bde719e1
|
@ -1465,11 +1465,15 @@ You can redefine a key's meaning using the map command
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
with `scope` being one of `global`, `buffer` or `window` (or any prefix),
|
with `scope` being one of `global`, `buffer` or `window` (or any prefix),
|
||||||
mode being `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix), `key` being
|
mode being `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix),
|
||||||
a single key name and `keys` a list of keys.
|
`key` being a single key name and `keys` a list of keys.
|
||||||
|
|
||||||
`user` mode allows for user mapping behind the `,` key. Keys will be executed in
|
`user` mode allows for user mapping behind the `,` key. Keys will be
|
||||||
normal mode.
|
executed in normal mode.
|
||||||
|
|
||||||
|
An optional *-docstring* switch followed by a string can be used to
|
||||||
|
describe what the mapping does. This docstring will be used in autoinfo
|
||||||
|
boxes.
|
||||||
|
|
||||||
Mappings can be removed with the unmap command
|
Mappings can be removed with the unmap command
|
||||||
|
|
||||||
|
|
|
@ -125,6 +125,10 @@ command *q!* has to be used).
|
||||||
*user* mode allows for user mapping behind the *,* key. Keys
|
*user* mode allows for user mapping behind the *,* key. Keys
|
||||||
will be executed in normal mode.
|
will be executed in normal mode.
|
||||||
|
|
||||||
|
An optional *-docstring* switch followed by a string can be used
|
||||||
|
to describe what the mapping does. This docstring will be used
|
||||||
|
in autoinfo boxes.
|
||||||
|
|
||||||
*unmap* <scope> <mode> <key> [<expected>]::
|
*unmap* <scope> <mode> <key> [<expected>]::
|
||||||
remove the mapping of *key* in given *scope* and *mode*, if
|
remove the mapping of *key* in given *scope* and *mode*, if
|
||||||
expected is specified, only remove the mapping it if matches
|
expected is specified, only remove the mapping it if matches
|
||||||
|
|
Loading…
Reference in New Issue
Block a user