diff --git a/docs/kittens/icat.rst b/docs/kittens/icat.rst index da2c591e1..d21c63b08 100644 --- a/docs/kittens/icat.rst +++ b/docs/kittens/icat.rst @@ -7,6 +7,7 @@ The ``icat`` kitten can be used to display arbitrary images in the |kitty| terminal. Using it is as simple as:: kitty +kitten icat image.jpeg + kitty-tool icat image.jpeg It supports all image types supported by `ImageMagick `__. It even works over SSH. For details, see the @@ -20,8 +21,9 @@ Then you can simply use ``icat image.png`` to view images. .. note:: - `ImageMagick `__ must be installed for icat - kitten to work. + `ImageMagick `__ must be installed for the + full range of image types. Without it only PNG/JPG/GIF/BMP/TIFF/WEBP are + supported. .. note:: @@ -35,16 +37,15 @@ Then you can simply use ``icat image.png`` to view images. 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`, :option:`--silent` and -:option:`--print-window-size`. +:option:`--detect-support` 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 +discarded. At a minimum, you should use the :option:`--transfer-mode` +command line arguments. To be really robust you should consider writing proper support for the :doc:`kitty graphics protocol ` in the program instead. Nowadays there are many libraries that have support for it.