aboutsummaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
parentinput: enforce ‘numerical’ keypad mode when Num Lock override is enabled (diff)
readme/doc:foot.1: document the (new) keypad behavior
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0d4ce17c..7cc055ac 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,7 @@ The fast, lightweight and minimalistic Wayland terminal emulator.
1. [Server (daemon) mode](#server-daemon-mode)
1. [Alt/meta](#alt-meta)
1. [Backspace](#backspace)
+1. [Keypad](#keypad)
1. [DPI and font size](#dpi-and-font-size)
1. [Supported OSCs](#supported-oscs)
1. [Programmatically checking if running in foot](#programmatically-checking-if-running-in-foot)
@@ -263,6 +264,25 @@ Finally, pressing <kbd>alt</kbd> will prefix the transmitted byte with
ESC.
+## KEYPAD
+
+By default, <kbd>Num Lock</kbd> 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 (<kbd>Num
+Lock</kbd> is **active**) or cursor movement keys (<kbd>Up</kbd>,
+<kbd>Down</kbd>, <kbd>Left</kbd>, <kbd>Right</kbd>, <kbd>Page
+Up</kbd>, <kbd>Page Down</kbd> 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.
+
+
## DPI and font size
Font sizes are apparently a complex thing. Many applications use a