From c92ca01ea6d200ca3bc51a875c3e9e198f39e594 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Tue, 29 Apr 2025 08:36:39 +0530 Subject: [PATCH] More work on the docs --- docs/kittens/panel.rst | 34 ++++---------------------- docs/kittens/quick-access-terminal.rst | 28 ++++++++++++++------- docs/kittens_intro.rst | 12 +++++++++ 3 files changed, 36 insertions(+), 38 deletions(-) diff --git a/docs/kittens/panel.rst b/docs/kittens/panel.rst index ead8052a0..ed73057c6 100644 --- a/docs/kittens/panel.rst +++ b/docs/kittens/panel.rst @@ -8,10 +8,10 @@ Draw a GPU accelerated dock panel on your desktop Overview -------------- - -You can use this kitten to draw a GPU accelerated panel on the edge of your -screen or as the desktop wallpaper, that shows the output from an arbitrary -terminal program. +Draw the desktop wallpaper or docks and panels using arbitrary +terminal programs, For example, have `btop +`__ or `cava +`__ be your desktop wallpaper. It is useful for showing status information or notifications on your desktop using terminal programs instead of GUI toolkits. @@ -65,31 +65,7 @@ panels and desktop components: * `pawbar `__ -.. _quake: - -Make a Quake like quick access terminal -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. versionadded:: 0.42.0 - Support for quake mode, works only on macOS and Wayland, except for GNOME. - -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: - -.. code-block:: sh - - kitten quick-access-terminal - -Run this command in a terminal, and a quick access kitty window will show up at -the top of your screen. Run it again, and the window will be hidden. - -Simply bind this command to some key press in your window manager or desktop -environment settings and then you have a quick access terminal at a single key press. -You can use the various panel options to configure the size, appearance and -position of the quick access panel. In particular, the :option:`kitty +kitten panel --config` and -:option:`kitty +kitten panel --override` options can be used to theme the terminal appropriately, -making it look different from regular kitty terminal instances. - +.. _remote_control_panel: Controlling panels via remote control ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/kittens/quick-access-terminal.rst b/docs/kittens/quick-access-terminal.rst index 7fcecab18..95c36565c 100644 --- a/docs/kittens/quick-access-terminal.rst +++ b/docs/kittens/quick-access-terminal.rst @@ -26,22 +26,32 @@ the top of your screen. Run it again, and the window will be hidden. To make the terminal appear and disappear at a key press: -.. tab:: Linux +.. |macOs| replace:: :guilabel:`System Preferences->Keyboard->Keyboard Shortcuts->Services->General` - Simply bind the above command to some key press in your window manager or desktop - environment settings and then you have a quick access terminal at a single key press. +.. only:: not man -.. tab:: macOS + .. tab:: Linux - In kitty, run the above command to show the quick access window, then close - it by running the command again or pressing :kbd:`ctrl+d`. Now go to :guilabel:`System - Preferences->Keyboard->Keyboard Shortcuts->Services->General` and set a shortcut for - the :guilabel:`Quick access to kitty` entry. + Simply bind the above command to some key press in your window manager or desktop + environment settings and then you have a quick access terminal at a single key press. + + .. tab:: macOS + + In kitty, run the above command to show the quick access window, then close + it by running the command again or pressing :kbd:`ctrl+d`. Now go to |macOS| and set a shortcut for + the :guilabel:`Quick access to kitty` entry. + +.. only:: man + + In Linux, simply assign the above command to a global shortcut in your + 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 ` under the - hood. + hood. You can use the :ref:`techniques described there ` + for remote controlling the quick access window. Configuration ------------------------ diff --git a/docs/kittens_intro.rst b/docs/kittens_intro.rst index 0c2df07d4..182f54fe2 100644 --- a/docs/kittens_intro.rst +++ b/docs/kittens_intro.rst @@ -13,6 +13,8 @@ Extend with kittens kittens/themes kittens/choose-fonts kittens/hints + kittens/quick-access-terminal + kittens/panel kittens/remote_file kittens/hyperlinked_grep kittens/transfer @@ -51,6 +53,16 @@ Some prominent kittens: filenames, words, lines, etc. from the terminal screen. +:doc:`Quick access terminal ` + Get access to a quick access floating, semi-transparent kitty window + with a single keypress. + + +:doc:`Panel ` + Draw the desktop wallpaper or docks and panels using arbitrary + terminal programs. + + :doc:`Remote file ` Edit, open, or download remote files over SSH easily, by simply clicking on the filename.