From 58bde719e124549768d3d37bfa6c7a90672b8816 Mon Sep 17 00:00:00 2001 From: Maxime Coste Date: Sun, 5 Mar 2017 22:47:16 +0000 Subject: [PATCH] Document the -docstring switch of the :map command --- README.asciidoc | 12 ++++++++---- doc/manpages/commands.asciidoc | 4 ++++ 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index 78b44b53..f36e69aa 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -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 diff --git a/doc/manpages/commands.asciidoc b/doc/manpages/commands.asciidoc index 95caa33f..44f7cc50 100644 --- a/doc/manpages/commands.asciidoc +++ b/doc/manpages/commands.asciidoc @@ -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* []:: remove the mapping of *key* in given *scope* and *mode*, if expected is specified, only remove the mapping it if matches