mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-14 20:44:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document how the screenshots were generated and put the images in a sidebar

Browse Source
This commit is contained in:
Kovid Goyal
2025-04-30 18:49:31 +05:30
parent 7043440e2f
commit a72fc508d9
2 changed files with 111 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
docs/kittens/quick-access-terminal.rst
View File

@@ -10,26 +10,35 @@ Make a Quake like quick access terminal
Overview
--------------
.. only:: not man
.. sidebar::
**Screenshots**
.. figure:: ../screenshots/quake-macos.webp
:alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program ``btop``, running inside kitty, on macOS
:align: center
:width: 100%
macOS
.. figure:: ../screenshots/quake-hypr.webp
:alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program ``btop``, running inside kitty, on Hyprland in Linux
:align: center
:width: 100%
Linux
How the screenshots were generated is :ref:`described in the panel
kitten docs <quake_ss>`.
.. versionadded:: 0.42.0
Works on macOS and Wayland, except for GNOME.
.. figure:: ../screenshots/quake-macos.webp
:alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program ``btop``, running inside kitty, on macOS
:align: center
:width: 40%
Floating quick access window and also desktop background showing the `btop <https://github.com/aristocratos/btop>`__
process monitor both drawn with kitty, above in macOS and below in Hyprland
on Linux.
.. figure:: ../screenshots/quake-hypr.webp
:alt: Screenshot, showing the kitty floating quick access terminal above the background which is the program ``btop``, running inside kitty, on Hyprland in Linux
:align: center
:width: 40%
This kitten can be used to make a quick access terminal, that appears and
disappears at a key press. To do so use the following command:
@@ -63,12 +72,6 @@ To make the terminal appear and disappear at a key press:
window manager. In macOS, go to |macOS| and set a shortcut
for the :guilabel:`Quick access to kitty` entry.
.. note::
This kitten uses the :doc:`panel kitten </kittens/panel>` under the
hood. You can use the :ref:`techniques described there <remote_control_panel>`
for remote controlling the quick access window.
Configuration
------------------------
@@ -78,6 +81,15 @@ by creating a :file:`quick-access-terminal.conf` file in your
:opt:`kitty_conf <kitten-quick_access_terminal.kitty_conf>` option to change
various kitty settings, just for the quick access window.
.. note::
This kitten uses the :doc:`panel kitten </kittens/panel>` under the
hood. You can use the :ref:`techniques described there <remote_control_panel>`
for remote controlling the quick access window, remember to add
``kitty_override allow_remote_control=socket-only`` and ``kitty_override
listen_on=unix:/tmp/whatever`` to
:file:`quick-access-terminal.conf`.
See below for the supported configuration directives: