readme/doc:foot.1: document the (new) keypad behavior

This commit is contained in:
Daniel Eklöf 2020-11-11 18:37:28 +01:00
parent deb2c2db6d
commit 2af65471a6
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
4 changed files with 40 additions and 1 deletions

View file

@ -58,6 +58,9 @@
* Blinking text now uses the foreground color, but dimmed down in its
off state, instead of the background color.
* Num Lock by default overrides the keypad mode. See
**foot.ini**(5)::KEYPAD, or [README.md](README.md#keypad) for
details (https://codeberg.org/dnkl/foot/issues/194).
### Deprecated

View file

@ -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)
@ -270,6 +271,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

View file

@ -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)

View file

@ -84,7 +84,6 @@
# pipe-scrollback=[sh -c "xurls | bemenu | xargs -r firefox"] none
# pipe-selected=[xargs -r firefox] none
[search-bindings]
# cancel=Control+g Escape
# commit=Return