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

Document the -docstring switch of the :map command

Browse Source
This commit is contained in:
Maxime Coste 2017-03-05 22:47:16 +00:00
parent 44451e2c54
commit 58bde719e1
2 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.asciidoc
View File

@ -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),
mode being `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix), `key` being
a single key name and `keys` a list of keys.
mode being `insert`, `normal`, `prompt`, `menu` or `user` (or any prefix),
`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
normal mode.
`user` mode allows for user mapping behind the `,` key. Keys 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.
Mappings can be removed with the unmap command

4
doc/manpages/commands.asciidoc
View File

@ -125,6 +125,10 @@ command *q!* has to be used).
*user* mode allows for user mapping behind the *,* key. Keys
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>]::
remove the mapping of *key* in given *scope* and *mode*, if
expected is specified, only remove the mapping it if matches