aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-11-11 17:37:28 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-12-01 18:40:03 +0000
commit8970c7ea1801032ffc44919dca5e4faef77449a6 (patch)
treee794e52f50db72cb536865b6ede82da6f4dfdfb8 /doc
parentinput: enforce ‘numerical’ keypad mode when Num Lock override is enabled (diff)
readme/doc:foot.1: document the (new) keypad behavior
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 20ac9ebc..7e61d7a7 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -261,6 +261,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)