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

Add a note about using icat from other programs

Browse Source
This commit is contained in:
Kovid Goyal 2022-01-17 08:35:48 +05:30
parent 386bb837d8
commit 92075a44d8
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/kittens/icat.rst
View File

@ -30,6 +30,20 @@ Then you can simply use ``icat image.png`` to view images.
multiplexer has added support for it or not.
.. note::
If you are trying to integrate icat into another program like a file
manager, there are a couple of things to keep in mind. icat works by
communicating over the TTY device, it both writes to and reads from the TTY.
So it is imperative that while it is running the host program does not do
any TTY I/O. And any key presses or other input from the user on the TTY
device will be discarded. At a minimum, you should use the
:option:`kitty +kitten icat --silent` and :option:`kitty +kitten icat --transfer-mode` flags. To be really robust
you should consider writing proper support for the
:doc:`../graphics-protocol` in the program instead.
Nowadays there are many libraries that have support for it.
.. program:: kitty +kitten icat