aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-11-12 17:19:33 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-11-12 17:19:33 +0000
commit3df34055d24aebfc668bf8443b82c58851b6feb4 (patch)
treecda82357323f0cf7ce12347acc08db59561b393c /doc
parentpkgbuild: append ‘foot-terminfo’ dependency in package_foot-git() (diff)
parentreadme/doc:foot.1: document the (new) keypad behavior (diff)
Merge branch 'keypad-numlock-override'
Closes #194
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index e8460cc7..e3be3013 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -267,6 +267,23 @@ described above *cannot* be changed.
Finally, pressing *alt* will prefix the transmitted byte with ESC.
+# KEYPAD
+
+By default, *Num Lock* overrides the run-time configuration keypad
+mode; when active, the keypad is always considered to be in
+_numerical_ mode. This corresponds to XTerm's *numLock* option set to
+*true*.
+
+In this mode, the keypad keys always sends either numbers (Num Lock is
+active) or cursor movement keys (up, down, left, right, page up, page
+down etc).
+
+This can be disabled programmatically with *\E[?1035l* (and enabled
+again with *\E[?1035h*).
+
+When disabled, the keypad sends custom escape sequences instead of
+numbers, when in _application_ mode.
+
# CONFIGURATION
See *foot.ini*(5)