mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-12 10:47:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Move the section about integration to a better location

Browse Source
This commit is contained in:
Kovid Goyal
2022-01-17 10:41:35 +05:30
parent c3ded5eb72
commit 4778e0eb23
1 changed files with 13 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/kittens/icat.rst
View File

@@ -30,25 +30,23 @@ 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. 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
The ``icat`` kitten has various command line arguments to allow it to be used
from inside other programs to display images. In particular, :option:`--place`,
:option:`--detect-support` and :option:`--print-window-size`.
:option:`--detect-support`, :option:`--silent` and :option:`--print-window-size`.
If you are trying to integrate icat into a complex program like a file
manager or editor, there are a few 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. Any key presses or other input from the user on the TTY device
will be discarded. At a minimum, you should use the :option:`--silent` and
:option:`--transfer-mode` command line arguments. 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.
.. include:: /generated/cli-kitten-icat.rst