aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2022-07-07 07:42:22 +0800
committerGitHub <noreply@github.com>2022-07-07 07:42:22 +0800
commit4cded8cec13cb91ce97d6c505879123b8b892bb3 (patch)
tree3f949dbf090a62fe3ff206067cf0970a1fc83837 /runtime
parent5e84db5c90db60f68fe69b3585ba742d1a872b90 (diff)
parent03c9cf3feb0bdfdf4f6c1825440067b85a1fb619 (diff)
downloadrneovim-4cded8cec13cb91ce97d6c505879123b8b892bb3.tar.gz
rneovim-4cded8cec13cb91ce97d6c505879123b8b892bb3.tar.bz2
rneovim-4cded8cec13cb91ce97d6c505879123b8b892bb3.zip
Merge pull request #19180 from zeertzjq/tui-kitty-keypad
feat(tui): recognize keypad keys when using kitty keyboard protocol
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/term.txt12
1 files changed, 9 insertions, 3 deletions
diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt
index 9969fc0a79..cd6798a5de 100644
--- a/runtime/doc/term.txt
+++ b/runtime/doc/term.txt
@@ -111,11 +111,17 @@ 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
-extended keys a.k.a. modifyOtherKeys or `CSI u`) can also be parsed.
+extended 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.
+ 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.
+
+The kitty keyboard protocol https://sw.kovidgoyal.net/kitty/keyboard-protocol/
+is partially supported, including keypad keys in Unicode Private Use Area.
+For example, this sequence is recognized by Nvim as <C-kEnter>: >
+ CSI 57414 ; 5 u
+and can be used differently from <C-CR> in mappings.
*tui-modifyOtherKeys* *tui-csiu*
Historically, terminal emulators could not distinguish between certain control