@@ -8603,6 +8603,39 @@ <h1>VIDEO OUTPUT DRIVERS</h1>
8603
8603
<dd>Use 256 colors - for terminals which don't support true color.</dd>
8604
8604
</dl>
8605
8605
</dd>
8606
+ <dt><tt class="docutils literal">kitty</tt></dt>
8607
+ <dd><p class="first">Graphical output for the terminal, using the kitty graphics protocol.
8608
+ Tested with kitty and Konsole.</p>
8609
+ <p>You may need to use <tt class="docutils literal"><span class="pre">--profile=sw-fast</span></tt> to get decent performance.</p>
8610
+ <p>Kitty size and alignment options:</p>
8611
+ <dl class="last docutils">
8612
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-cols=<columns></span></tt>, <tt class="docutils literal"><span class="pre">--vo-kitty-rows=<rows></span></tt> (default: 0)</dt>
8613
+ <dd>Specify the terminal size in character cells, otherwise (0) read it
8614
+ from the terminal, or fall back to 80x25.</dd>
8615
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-width=<width></span></tt>, <tt class="docutils literal"><span class="pre">--vo-kitty-height=<height></span></tt> (default: 0)</dt>
8616
+ <dd>Specify the available size in pixels, otherwise (0) read it from the
8617
+ terminal, or fall back to 320x240.</dd>
8618
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-left=<col></span></tt>, <tt class="docutils literal"><span class="pre">--vo-kitty-top=<row></span></tt> (default: 0)</dt>
8619
+ <dd>Specify the position in character cells where the image starts (1 is
8620
+ the first column or row). If 0 (default) then try to automatically
8621
+ determine it according to the other values and the image aspect ratio
8622
+ and zoom.</dd>
8623
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-config-clear=<yes|no></span></tt> (default: yes)</dt>
8624
+ <dd>Whether or not to clear the terminal whenever the output is
8625
+ reconfigured (e.g. when video size changes).</dd>
8626
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-alt-screen=<yes|no></span></tt> (default: yes)</dt>
8627
+ <dd>Whether or not to use the alternate screen buffer and return the
8628
+ terminal to its previous state on exit. When set to no, the last
8629
+ kitty image stays on screen after quit, with the cursor following it.</dd>
8630
+ <dt><tt class="docutils literal"><span class="pre">--vo-kitty-use-shm=<yes|no></span></tt> (default: no)</dt>
8631
+ <dd><p class="first">Use shared memory objects to transfer image data to the terminal.
8632
+ This is much faster than sending the data as escape codes, but is not
8633
+ supported by as many terminals. It also only works on the local machine
8634
+ and not via e.g. SSH connections.</p>
8635
+ <p class="last">This option is not implemented on Windows.</p>
8636
+ </dd>
8637
+ </dl>
8638
+ </dd>
8606
8639
<dt><tt class="docutils literal">sixel</tt></dt>
8607
8640
<dd><p class="first">Graphical output for the terminal, using sixels. Tested with <tt class="docutils literal">mlterm</tt> and
8608
8641
<tt class="docutils literal">xterm</tt>.</p>
0 commit comments