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

Document file compression

Browse Source
This commit is contained in:
Kovid Goyal 2021-11-19 09:21:09 +05:30
parent a528b45d60
commit ccc2d7d2da
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -243,7 +243,20 @@ TODO:
Compression
--------------
TODO:
Individual files can be transmitted compressed if needed.
Currently, only :rfc:`1950` ZLIB based deflate compression is
supported, which is specified using the ``compression=zlib`` key when
requesting a file. For example when sending files to the terminal emulator,
when sending the file metadata the ``compression`` key can also be
specified::
→ action=file id=someid file_id=f1 name=/path/to/destination compression=zlib
Similarly when receiving files from the terminal emulator, the final file
command that the client sends to the terminal requesting the start of the
transfer of data for the file can include the ``compression`` key::
→ action=file id=someid file_id=f1 name=/some/path
.. _bypass_auth: