Add a glossary to define some commonly used terms in kitty
This commit is contained in:
parent
fd475423cf
commit
9e9d1a4e96
33
docs/glossary.rst
Normal file
33
docs/glossary.rst
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
Glossary
|
||||||
|
=========
|
||||||
|
|
||||||
|
.. glossary::
|
||||||
|
|
||||||
|
os_window
|
||||||
|
kitty has two kinds of windows. Operating System windows, refered to as :term:`OS
|
||||||
|
Window <os_window>`, and *kitty windows*. An OS Window consists of one or more kitty
|
||||||
|
:term:`tabs <tab>`. Each tab in turn consists of one or more *kitty
|
||||||
|
windows* organized in a :term:`layout`.
|
||||||
|
|
||||||
|
tab
|
||||||
|
A *tab* refers to a group of :term:`kitty windows <window>`, organized in
|
||||||
|
a :term:`layout`. Every :term:`OS Window <os_window>` contains one or more tabs.
|
||||||
|
|
||||||
|
layout
|
||||||
|
A *layout* is a system of organizing :term:`kitty windows <window>` in
|
||||||
|
groups inside a tab. The layout automatically maintains the size and
|
||||||
|
position of the windows, think of a layout as a tiling window manager for
|
||||||
|
the terminal. See :doc:`layouts` for details.
|
||||||
|
|
||||||
|
window
|
||||||
|
kitty has two kinds of windows. Operating System windows, refered to as :term:`OS
|
||||||
|
Window <os_window>`, and *kitty windows*. An OS Window consists of one or more kitty
|
||||||
|
:term:`tabs <tab>`. Each tab in turn consists of one or more *kitty
|
||||||
|
windows* organized in a :term:`layout`.
|
||||||
|
|
||||||
|
overlay
|
||||||
|
An *overlay window* is a :term:`kitty window <window>` that is placed on
|
||||||
|
top of an existing kitty window, entirely covering it. Overlays are used
|
||||||
|
throught kitty, for example, to display the :ref:`the scrollback buffer <scrollback>`,
|
||||||
|
to display :doc:`hints </kittens/hints>`, for :doc:`unicode input
|
||||||
|
</kittens/unicode-input>` etc.
|
||||||
@ -17,7 +17,7 @@ kitty - the fast, featureful, GPU based terminal emulator
|
|||||||
and several :doc:`new terminal protocol extensions
|
and several :doc:`new terminal protocol extensions
|
||||||
<protocol-extensions>`.
|
<protocol-extensions>`.
|
||||||
|
|
||||||
* Supports tiling multiple terminal windows side by side in different
|
* Supports tiling multiple terminal :term:`windows <window>` side by side in different
|
||||||
:ref:`layouts <layouts>` without needing to use an extra program like tmux
|
:ref:`layouts <layouts>` without needing to use an extra program like tmux
|
||||||
|
|
||||||
* Can be :doc:`controlled from scripts or the shell prompt <remote-control>`,
|
* Can be :doc:`controlled from scripts or the shell prompt <remote-control>`,
|
||||||
@ -29,14 +29,15 @@ kitty - the fast, featureful, GPU based terminal emulator
|
|||||||
:doc:`Side-by-side diff <kittens/diff>`.
|
:doc:`Side-by-side diff <kittens/diff>`.
|
||||||
|
|
||||||
* Supports :ref:`startup sessions <sessions>` which allow you to specify
|
* Supports :ref:`startup sessions <sessions>` which allow you to specify
|
||||||
the window/tab layout, working directories and programs to run on startup.
|
the :term:`window`/:term:`tab` layout, working directories and programs to run on startup.
|
||||||
|
|
||||||
* Cross-platform: |kitty| works on Linux and macOS, but because it uses only
|
* Cross-platform: |kitty| works on Linux and macOS, but because it uses only
|
||||||
OpenGL for rendering, it should be trivial to port to other Unix-like platforms.
|
OpenGL for rendering, it should be trivial to port to other Unix-like platforms.
|
||||||
|
|
||||||
* Allows you to open :ref:`the scrollback buffer <scrollback>` in a
|
* Allows you to open :ref:`the scrollback buffer <scrollback>` in a
|
||||||
separate window using arbitrary programs of your choice. This is useful for
|
separate :term:`overlay window <overlay>` using arbitrary programs of
|
||||||
browsing the history comfortably in a pager or editor.
|
your choice. This is useful for browsing the history comfortably in a
|
||||||
|
pager or editor.
|
||||||
|
|
||||||
* Has :ref:`multiple copy/paste buffers <cpbuf>`, like vim.
|
* Has :ref:`multiple copy/paste buffers <cpbuf>`, like vim.
|
||||||
|
|
||||||
@ -105,8 +106,9 @@ relatively little effort.
|
|||||||
Layouts
|
Layouts
|
||||||
----------
|
----------
|
||||||
|
|
||||||
A layout is an arrangement of multiple kitty *windows* inside a top-level OS window. You can create a new window
|
A :term:`layout` is an arrangement of multiple :term:`kitty windows <window>`
|
||||||
using the :sc:`new_window` key combination.
|
inside a top-level :term:`OS window <os_window>`. You can create a new
|
||||||
|
:term:`window` using the :sc:`new_window` key combination.
|
||||||
|
|
||||||
Currently, there are seven layouts available:
|
Currently, there are seven layouts available:
|
||||||
|
|
||||||
@ -166,8 +168,8 @@ Some prominent kittens:
|
|||||||
|
|
||||||
|
|
||||||
:doc:`Broadcast <kittens/broadcast>`
|
:doc:`Broadcast <kittens/broadcast>`
|
||||||
Type in one kitty window and have it broadcast to all (or a subset) of
|
Type in one :term:`kitty window <window>` and have it broadcast to all (or a subset) of
|
||||||
other kitty windows.
|
other :term:`kitty windows <window>`.
|
||||||
|
|
||||||
|
|
||||||
:doc:`Panel <kittens/panel>`
|
:doc:`Panel <kittens/panel>`
|
||||||
@ -195,7 +197,8 @@ Remote control
|
|||||||
|
|
||||||
|kitty| has a very powerful system that allows you to control it from the
|
|kitty| has a very powerful system that allows you to control it from the
|
||||||
:doc:`shell prompt, even over SSH <remote-control>`. You can change colors,
|
:doc:`shell prompt, even over SSH <remote-control>`. You can change colors,
|
||||||
fonts, open new windows, tabs, set their titles, change window layout, get text
|
fonts, open new :term:`windows <window>`, :term:`tabs <tab>`, set their titles,
|
||||||
|
change window layout, get text
|
||||||
from one window and send text to another, etc, etc. The possibilities are
|
from one window and send text to another, etc, etc. The possibilities are
|
||||||
endless. See the :doc:`tutorial <remote-control>` to get started.
|
endless. See the :doc:`tutorial <remote-control>` to get started.
|
||||||
|
|
||||||
@ -204,14 +207,15 @@ endless. See the :doc:`tutorial <remote-control>` to get started.
|
|||||||
Startup Sessions
|
Startup Sessions
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
You can control the tabs, window layout, working directory, startup programs,
|
You can control the :term:`tabs <tab>`, `:term:`kitty window <window>` layout,
|
||||||
|
working directory, startup programs,
|
||||||
etc. by creating a "session" file and using the :option:`kitty --session`
|
etc. by creating a "session" file and using the :option:`kitty --session`
|
||||||
command line flag or the :opt:`startup_session` option in :file:`kitty.conf`.
|
command line flag or the :opt:`startup_session` option in :file:`kitty.conf`.
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
.. code-block:: session
|
.. code-block:: session
|
||||||
|
|
||||||
# Set the window layout for the current tab
|
# Set the layout for the current tab
|
||||||
layout tall
|
layout tall
|
||||||
# Set the working directory for windows in the current tab
|
# Set the working directory for windows in the current tab
|
||||||
cd ~
|
cd ~
|
||||||
@ -300,11 +304,12 @@ Colors and text formatting are preserved. You can explore the scrollback buffer
|
|||||||
comfortably within the pager.
|
comfortably within the pager.
|
||||||
|
|
||||||
Additionally, you can pipe the contents of the scrollback buffer to an
|
Additionally, you can pipe the contents of the scrollback buffer to an
|
||||||
arbitrary, command running in a new window, tab or overlay, for example::
|
arbitrary, command running in a new :term:`window`, :term:`tab` or :term:`overlay`,
|
||||||
|
for example::
|
||||||
|
|
||||||
map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting less +G -R
|
map f1 launch --stdin-source=@screen_scrollback --stdin-add-formatting less +G -R
|
||||||
|
|
||||||
Would open the scrollback buffer in a new window when you press the :kbd:`F1`
|
Would open the scrollback buffer in a new :term:`window` when you press the :kbd:`F1`
|
||||||
key. See :sc:`show_scrollback` for details.
|
key. See :sc:`show_scrollback` for details.
|
||||||
|
|
||||||
If you want to use it with an editor such as vim to get more powerful features,
|
If you want to use it with an editor such as vim to get more powerful features,
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user