f787a377c3
Supports dark mode. Also re-organize the documentation a bit, making it more hierarchical. Have a nicer landing page
44 lines
1.2 KiB
ReStructuredText
44 lines
1.2 KiB
ReStructuredText
icat
|
|
========================================
|
|
|
|
*Display images in the terminal*
|
|
|
|
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
|
|
|
|
It supports all image types supported by `ImageMagick
|
|
<https://www.imagemagick.org>`_. It even works over SSH. For details, see
|
|
the :doc:`kitty graphics protocol </graphics-protocol>`.
|
|
|
|
You might want to create an alias in your shell's configuration files::
|
|
|
|
alias icat="kitty +kitten icat"
|
|
|
|
Then you can simply use ``icat image.png`` to view images.
|
|
|
|
.. note::
|
|
|
|
`ImageMagick <https://www.imagemagick.org>`_ must be installed for ``icat`` to
|
|
work.
|
|
|
|
.. note::
|
|
|
|
kitty's image display protocol may not work when used within a terminal
|
|
multiplexer such as ``screen`` or ``tmux``, depending on whether the
|
|
multiplexer has added support for it or not.
|
|
|
|
|
|
.. 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`.
|
|
|
|
Command Line Interface
|
|
--------------------------
|
|
|
|
.. include:: /generated/cli-kitten-icat.rst
|