From da31e953b60d2957476c581695bcf2b659ff156e Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Mon, 11 Apr 2022 23:22:04 +0800 Subject: docs(term.txt): add documentation about TUI input (#18072) --- runtime/doc/term.txt | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'runtime') diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt index f9b2271756..ddf52b65c6 100644 --- 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 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 -- cgit