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

Mention alternate screen mode in the quickstart

Browse Source
This commit is contained in:
Kovid Goyal 2021-01-17 11:41:35 +05:30
parent a88875f98e
commit 95ebeebb84
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/keyboard-protocol.rst
View File

@ -41,11 +41,12 @@ 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,
without too many changes, do the following:
#. Emit the escape code ``CSI > 1 u`` at application startup
#. Emit the escape code ``CSI > 1 u`` at application startup or when entering
alternate screen mode
#. All key events will now be sent in only a few forms to your application,
that are easy to parse unambiguously.
#. Emit the escape sequence ``CSI < u`` at application exit to restore the
previously used keyboard mode.
#. Emit the escape sequence ``CSI < u`` at application exit or just before
leaving alternate screen mode to restore the previously used keyboard mode.
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