KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Make it clearer that there are separate keyboard mode stacks for main and alternate screens

Browse Source
This commit is contained in:
Kovid Goyal 2021-06-18 09:41:35 +05:30
parent 5da5d00aec
commit 74b0a7f6f8
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/keyboard-protocol.rst
View File

@ -41,12 +41,14 @@ If you are an application or library developer just interested in using this
protocol to make keyboard handling simpler and more robust in your application, protocol to make keyboard handling simpler and more robust in your application,
without too many changes, do the following: without too many changes, do the following:
#. Emit the escape code ``CSI > 1 u`` at application startup or when entering #. Emit the escape code ``CSI > 1 u`` at application startup if using the main
alternate screen mode screen or when entering alternate screen mode, if using the alternate
screen.
#. All key events will now be sent in only a few forms to your application, #. All key events will now be sent in only a few forms to your application,
that are easy to parse unambiguously. that are easy to parse unambiguously.
#. Emit the escape sequence ``CSI < u`` at application exit or just before #. Emit the escape sequence ``CSI < u`` at application exit if using the main
leaving alternate screen mode to restore the previously used keyboard mode. screen or just before leaving alternate screen mode if using the alternate screen,
to restore the previously used keyboard mode.
Key events will all be delivered to your application either as plain UTF-8 Key events will all be delivered to your application either as plain UTF-8
text, or using the following escape codes, for those keys that do not produce text, or using the following escape codes, for those keys that do not produce