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

Merge branch 'docs-kbd' of https://github.com/page-down/kitty

Browse Source
This commit is contained in:
Kovid Goyal 2021-11-26 07:54:47 +05:30
commit 2770a853f6
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/file-transfer-protocol.rst
View File

@ -23,14 +23,14 @@ before any actual data is transmitted, unless a :ref:`pre-shared password is
provided <bypass_auth>`. provided <bypass_auth>`.
There can be either send or receive sessions. In send sessions files are sent There can be either send or receive sessions. In send sessions files are sent
from from remote client to the terminal emulator and vice versa for receive from remote client to the terminal emulator and vice versa for receive sessions.
sessions. Every session basically consists of sending metadata for the files Every session basically consists of sending metadata for the files first and
first and then sending the actual data. The session is a series of commands, then sending the actual data. The session is a series of commands, every command
every command carrying the session id (which should be a random unique-ish carrying the session id (which should be a random unique-ish identifier, to
identifier, to avoid conflicts). The session is bi-directional with commands avoid conflicts). The session is bi-directional with commands going both to and
going both to and from the terminal emulator. Every command in a session from the terminal emulator. Every command in a session also carries an
also carries an ``action`` field that specifies what the command does. The ``action`` field that specifies what the command does. The remaining fields in
remaining fields in the command are dependent on the nature of the command. the command are dependent on the nature of the command.
Let's look at some simple examples of sessions to get a feel for the protocol. Let's look at some simple examples of sessions to get a feel for the protocol.

2
docs/keyboard-protocol.rst
View File

@ -67,7 +67,7 @@ modifiers pressed for the key event. The encoding is described in the
:ref:`modifiers` section. :ref:`modifiers` section.
The second form is used for a few functional keys, such as the :kbd:`Home`, The second form is used for a few functional keys, such as the :kbd:`Home`,
:kbd:`End`, :kbd:`Arrow` keys and :kbd:`F1`...:kbd:`F4`, they are enumerated in :kbd:`End`, :kbd:`Arrow` keys and :kbd:`F1` ... :kbd:`F4`, they are enumerated in
the :ref:`functional` table below. Note that if no modifiers are present the the :ref:`functional` table below. Note that if no modifiers are present the
parameters are omitted entirely giving an escape code of the form ``CSI parameters are omitted entirely giving an escape code of the form ``CSI
[ABCDEFHPQRS]``. [ABCDEFHPQRS]``.