commit da31e953b60d2957476c581695bcf2b659ff156e
parent 96b461a00042c13610a62545b17fb792eb17c12e
Author: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 11 Apr 2022 23:22:04 +0800
docs(term.txt): add documentation about TUI input (#18072)
Diffstat:
1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt
@@ -108,6 +108,15 @@ and right scroll margins as well. If Nvim detects that the terminal is Xterm,
it will make use of this ability to speed up scrolling that is not the full
width of the terminal.
+ *tui-input*
+Nvim uses libtermkey to convert terminal escape sequences to key codes.
+|terminfo| is used first, and CSI sequences not in |terminfo| (including
+exteneded keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed.
+For example, when running Nvim in tmux, this makes Nvim leave Insert mode and
+go to the window below: >
+ tmux send-keys 'Escape' [ 2 7 u 'C-W' j
+Where `'Escape' [ 2 7 u` is an unambiguous `CSI u` sequence for the <Esc> key.
+
*tui-colors*
Nvim uses 256 colours by default, ignoring |terminfo| for most terminal types,
including "linux" (whose virtual terminals have had 256-colour support since
