summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Allen <screwtape@froup.com>2017-09-18 12:59:41 +1000
committerTim Allen <screwtape@froup.com>2017-09-18 12:59:41 +1000
commit42196b83cfecae7e68aa369f28e668df5dc8ad64 (patch)
tree34615415febaf4f690877884418e9bae05a9e196
parent3aaf646eda415cd6f8177b91f28163441208aa47 (diff)
Document what keys are mappable.
-rw-r--r--doc/manpages/mapping.asciidoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/manpages/mapping.asciidoc b/doc/manpages/mapping.asciidoc
index 1a11d312..18863d39 100644
--- a/doc/manpages/mapping.asciidoc
+++ b/doc/manpages/mapping.asciidoc
@@ -50,3 +50,57 @@ set to the same sequence of keys passed using the *expected* argument.
For more information about the values of the *scope* parameter, refer to
the 'scopes' documentation page.
+
+Mappable keys
+-------------
+
+For *key* and *keys* in the *map* command, the following key names can
+be used:
+
+*x*, *<x>*::
+ Most keys, especially alphabetic keys, represent themselves.
+ Keys can also be wrapped in angle-brackets for consistency
+ with the non-alphabetic keys below.
+
+*X*, *<X>*::
+ Holding down Shift while pressing the *x* key.
+
+*<c-x>*::
+ Holding down Control while pressing the *x* key.
+
+*<a-x>*::
+ Holding down Alt while pressing the *x* key.
+
+*<lt>*, *<gt>*::
+ The *<* and *>* characters.
+
+*<plus>*, *<minus>*::
+ The *+* and *-* characters..
+
+*<ret>*::
+ The Return or Enter key.
+
+*<space>*::
+ The space bar.
+
+*<tab>*::
+ The Tab key.
+
+*<backtab>*::
+ The reverse-tab key. This is Shift-Tab on most keyboards.
+
+*<backspace>*::
+ The Backspace (delete to the left) key.
+
+*<del>*::
+ The Delete (to the right) key.
+
+*<esc>*::
+ The Escape key.
+
+*<up>*, *<down>*, *<left>*, *<right>*, *<pageup>*, *<pagedown>*, *<home>*::
+*<end>*::
+ The usual cursor-movement keys.
+
+*<f1>*, *<f2>*, ...*<f12>*::
+ Function keys.