mirror of
https://github.com/kovidgoyal/kitty
synced 2026-07-07 17:43:53 +02:00
More work on the docs
This commit is contained in:
@@ -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
|
||||
<https://github.com/aristocratos/btop>`__ or `cava
|
||||
<https://github.com/karlstav/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 <https://github.com/codelif/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
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -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 </kittens/panel>` under the
|
||||
hood.
|
||||
hood. You can use the :ref:`techniques described there <remote_control_panel>`
|
||||
for remote controlling the quick access window.
|
||||
|
||||
Configuration
|
||||
------------------------
|
||||
|
||||
@@ -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 <kittens/quick-access-terminal>`
|
||||
Get access to a quick access floating, semi-transparent kitty window
|
||||
with a single keypress.
|
||||
|
||||
|
||||
:doc:`Panel <kittens/panel>`
|
||||
Draw the desktop wallpaper or docks and panels using arbitrary
|
||||
terminal programs.
|
||||
|
||||
|
||||
:doc:`Remote file <kittens/remote_file>`
|
||||
Edit, open, or download remote files over SSH easily, by simply clicking on
|
||||
the filename.
|
||||
|
||||
Reference in New Issue
Block a user