mirror of
https://github.com/kovidgoyal/kitty.git
synced 2026-11-16 13:08:25 +00:00
Dragging the mouse over text drawn in the tab bar outside the tabs, such as text a custom tab_bar.py draws below the tabs of a vertical tab bar, selects it, and releasing the button copies it like a window selection (primary selection, then copy_on_select). Clicks and double clicks on empty space and presses on tabs behave as before. Based on the draft in #10870, with these additions: - Movement within drag_threshold selects nothing, so a slightly jittery double click on text still opens a new tab. - A selection whose release was lost does not keep capturing the mouse: it is cancelled by a press outside the tab bar (which then goes to its normal target), by motion with no button held, by any press in the tab bar, and by the OS window losing focus. - The pointer shape is reset after the press or release that starts or ends a selection, instead of being left as the drag shape. Fixes #10869 Closes #10870
305 lines
12 KiB
ReStructuredText
305 lines
12 KiB
ReStructuredText
Overview
|
|
==============
|
|
|
|
Design philosophy
|
|
-------------------
|
|
|
|
|kitty| is designed for power keyboard users. To that end all its controls work
|
|
with the keyboard (although it fully supports mouse interactions as well). Its
|
|
configuration is a simple, human editable, single file for easy reproducibility
|
|
(I like to store configuration in source control).
|
|
|
|
The code in |kitty| is designed to be simple, modular and hackable. It is
|
|
written in a mix of C (for performance sensitive parts), Python (for easy
|
|
extensibility and flexibility of the UI) and Go (for the command line
|
|
:term:`kittens`). It does not depend on any large and complex UI toolkit,
|
|
using only OpenGL for rendering everything.
|
|
|
|
Finally, |kitty| is designed from the ground up to support all modern terminal
|
|
features, such as Unicode, true color, bold/italic fonts, text formatting, etc.
|
|
It even extends existing text formatting escape codes, to add support for
|
|
features not available elsewhere, such as colored and styled (curly) underlines.
|
|
One of the design goals of |kitty| is to be easily extensible so that new
|
|
features can be added in the future with relatively little effort.
|
|
|
|
.. include:: basic.rst
|
|
|
|
|
|
Configuring kitty
|
|
-------------------
|
|
|
|
|kitty| is highly configurable, everything from keyboard shortcuts to painting
|
|
frames-per-second. Press :sc:`edit_config_file` in kitty to open its fully
|
|
commented sample config file in your text editor. For details see the
|
|
:doc:`configuration docs <conf>`.
|
|
|
|
You can quickly browse all available mappable actions by pressing
|
|
:sc:`command_palette`, see :doc:`kittens/command-palette` for details.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
conf
|
|
|
|
|
|
.. _layouts:
|
|
|
|
Layouts
|
|
----------
|
|
|
|
A :term:`layout` is an arrangement of multiple :term:`kitty windows <window>`
|
|
inside a top-level :term:`OS window <os_window>`. The layout manages all its
|
|
windows automatically, resizing and moving them as needed. You can create a new
|
|
:term:`window` using the :sc:`new_window` key combination.
|
|
|
|
Currently, there are seven layouts available:
|
|
|
|
* **Fat** -- One (or optionally more) windows are shown full width on the top,
|
|
the rest of the windows are shown side-by-side on the bottom
|
|
|
|
* **Grid** -- All windows are shown in a grid
|
|
|
|
* **Horizontal** -- All windows are shown side-by-side
|
|
|
|
* **Splits** -- Windows arranged in arbitrary patterns created using horizontal
|
|
and vertical splits
|
|
|
|
* **Stack** -- Only a single maximized window is shown at a time
|
|
|
|
* **Tall** -- One (or optionally more) windows are shown full height on the
|
|
left, the rest of the windows are shown one below the other on the right
|
|
|
|
* **Vertical** -- All windows are shown one below the other
|
|
|
|
By default, all layouts are enabled and you can switch between layouts using
|
|
the :sc:`next_layout` key combination. You can also create shortcuts to select
|
|
particular layouts, and choose which layouts you want to enable, see
|
|
:ref:`conf-kitty-shortcuts.layout` for examples. The first layout listed in
|
|
:opt:`enabled_layouts` becomes the default layout.
|
|
|
|
For more details on the layouts and how to use them see :doc:`the documentation
|
|
<layouts>`.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
layouts
|
|
|
|
Extending kitty
|
|
------------------
|
|
|
|
kitty has a powerful framework for scripting. You can create small terminal
|
|
programs called :doc:`kittens <kittens_intro>`. These can be used to add features
|
|
to kitty, for example, :doc:`editing remote files <kittens/remote_file>` or
|
|
:doc:`inputting Unicode characters <kittens/unicode_input>`. They can also be
|
|
used to create programs that leverage kitty's powerful features, for example,
|
|
:doc:`viewing images <kittens/icat>` or :doc:`diffing files with image support
|
|
<kittens/diff>`.
|
|
|
|
You can :doc:`create your own kittens to scratch your own itches
|
|
<kittens/custom>`.
|
|
|
|
For a list of all the builtin kittens, run ``kitten`` in kitty, or to browse
|
|
some of the more prominent ones, see :ref:`see here <kittens>`.
|
|
|
|
Additionally, you can use the :ref:`watchers <Watchers>` framework
|
|
to create Python scripts that run in response to various events such as windows
|
|
being resized, closing, having their titles changed, etc.
|
|
|
|
Finally, there is remote control which allows you to control kitty from
|
|
anywhere, even across a network! See below for more about remote control.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
kittens_intro
|
|
|
|
|
|
Remote control
|
|
------------------
|
|
|
|
|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,
|
|
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.
|
|
The possibilities are endless. See the :doc:`tutorial <remote-control>` to get
|
|
started.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
remote-control
|
|
|
|
|
|
Sessions
|
|
------------------
|
|
|
|
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` command line flag or the :opt:`startup_session`
|
|
option in :file:`kitty.conf`. You can also easily switch between sessions with
|
|
a keypress. See :doc:`sessions` for details.
|
|
|
|
|
|
Creating tabs/windows
|
|
-------------------------------
|
|
|
|
kitty can be told to run arbitrary programs in new :term:`tabs <tab>`,
|
|
:term:`windows <window>` or :term:`overlays <overlay>` at a keypress.
|
|
To learn how to do this, see :doc:`here <launch>`.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
launch
|
|
|
|
|
|
Mouse features
|
|
-------------------
|
|
|
|
* You can click on a URL to open it in a browser.
|
|
* You can double click to select a word and then drag to select more words.
|
|
* You can triple click to select a line and then drag to select more lines.
|
|
* You can triple click while holding :kbd:`Ctrl+Alt` to select from clicked
|
|
point to end of line.
|
|
* You can right click to extend a previous selection.
|
|
* You can hold down :kbd:`Ctrl+Alt` and drag with the mouse to select in
|
|
columns.
|
|
* Selecting text automatically copies it to the primary clipboard (on platforms
|
|
with a primary clipboard).
|
|
* You can middle click to paste from the primary clipboard (on platforms with a
|
|
primary clipboard).
|
|
* You can right click while holding :kbd:`Ctrl+Shift` to open the output of the
|
|
clicked on command in a pager (requires :ref:`shell_integration`)
|
|
* You can select text with kitty even when a terminal program has grabbed the
|
|
mouse by holding down the :kbd:`Shift` key
|
|
|
|
All these actions can be customized in :file:`kitty.conf` as described
|
|
:ref:`here <conf-kitty-mouse.mousemap>`.
|
|
|
|
You can also customize what happens when clicking on :term:`hyperlinks` in
|
|
kitty, having it open files in your editor, download remote files, open things
|
|
in your browser, etc. For details, see :doc:`here <open_actions>`.
|
|
|
|
Additionally, various bits of the kitty UI itself work with the mouse. You can
|
|
drag and drop tabs in the tab bar to re-order them or move them from one OS
|
|
Window to another, or even pop them out into a new OS Window. A tab containing a
|
|
single window can also be dropped into the content area of another tab to insert
|
|
its window at the highlighted edge.
|
|
|
|
Dragging a tab in the tab bar shows an insertion marker at the position it
|
|
will be dropped at, keeping the other tabs in place during the drag. When
|
|
dragging a tab containing a single window, hover over another tab for 0.6
|
|
seconds to switch to it, then keep dragging into its content area to choose a
|
|
split position for the window before releasing the mouse.
|
|
|
|
When dragging a window, hovering over the middle of a tab also switches to it,
|
|
and dropping the window there moves it into that tab. The outer 10% at either
|
|
end of a tab, the gaps between tabs and the ends of the tab bar show an
|
|
insertion marker instead. Dropping a window there puts it into a new tab at
|
|
that position.
|
|
|
|
You can drag window borders to resize windows. You can double click on empty regions
|
|
of the tab bar to create new tabs or double click on an existing tab to rename
|
|
it. Text in an empty region of the tab bar, such as text drawn there by a custom
|
|
tab bar, can be selected by dragging the mouse over it, and is copied like a
|
|
selection in a window, see :opt:`copy_on_select`.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
open_actions
|
|
|
|
Font control
|
|
-----------------
|
|
|
|
|kitty| has extremely flexible and powerful font selection features. You can
|
|
specify individual families for the regular, bold, italic and bold+italic fonts.
|
|
You can even specify specific font families for specific ranges of Unicode
|
|
characters. This allows precise control over text rendering. It can come in
|
|
handy for applications like powerline, without the need to use patched fonts.
|
|
See the various font related configuration directives in
|
|
:ref:`conf-kitty-fonts`.
|
|
|
|
|
|
.. _scrollback:
|
|
|
|
The scrollback buffer
|
|
-----------------------
|
|
|
|
|kitty| supports scrolling back to view history, just like most terminals. You
|
|
can use either keyboard shortcuts or the mouse scroll wheel to do so. |kitty|
|
|
displays an interactive :opt:`scrollbar` along the right edge
|
|
of the window that shows your current position in the scrollback. You can click
|
|
and drag the scrollbar to quickly navigate through the history.
|
|
|
|
However, |kitty| has an extra, neat feature. Sometimes you need to explore the scrollback
|
|
buffer in more detail, maybe search for some text or refer to it side-by-side
|
|
while typing in a follow-up command. |kitty| allows you to do this by pressing
|
|
the :sc:`show_scrollback` shortcut, which will open the scrollback buffer in
|
|
your favorite pager program (which is :program:`less` by default). Colors and
|
|
text formatting are preserved. You can explore the scrollback buffer comfortably
|
|
within the pager.
|
|
|
|
Additionally, you can pipe the contents of the scrollback buffer to an
|
|
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
|
|
|
|
Would open the scrollback buffer in a new :term:`window` when you press the
|
|
:kbd:`F1` key. See :sc:`show_scrollback <show_scrollback>` for details.
|
|
|
|
If you want to use it with an editor such as :program:`nvim` to get more powerful
|
|
features, see for example, `kitty-scrollback.nvim
|
|
<https://github.com/mikesmithgh/kitty-scrollback.nvim>`__ or `kitty-grab <https://github.com/yurikhan/kitty_grab>`__
|
|
or see more tips for using various editor programs, in :iss:`this thread <719>`.
|
|
|
|
If you wish to store very large amounts of scrollback to view using the piping
|
|
or :sc:`show_scrollback <show_scrollback>` features, you can use the
|
|
:opt:`scrollback_pager_history_size` option.
|
|
|
|
|
|
Integration with shells
|
|
---------------------------------
|
|
|
|
kitty has the ability to integrate closely within common shells, such as `zsh
|
|
<https://www.zsh.org/>`__, `fish <https://fishshell.com>`__ and `bash
|
|
<https://www.gnu.org/software/bash/>`__ to enable features such as jumping to
|
|
previous prompts in the scrollback, viewing the output of the last command in
|
|
:program:`less`, using the mouse to move the cursor while editing prompts, etc.
|
|
See :doc:`shell-integration` for details.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
shell-integration
|
|
|
|
.. _cpbuf:
|
|
|
|
Multiple copy/paste buffers
|
|
-----------------------------
|
|
|
|
In addition to being able to copy/paste from the system clipboard, in |kitty|
|
|
you can also setup an arbitrary number of copy paste buffers. To do so, simply
|
|
add something like the following to your :file:`kitty.conf`::
|
|
|
|
map f1 copy_to_buffer a
|
|
map f2 paste_from_buffer a
|
|
|
|
This will allow you to press :kbd:`F1` to copy the current selection to an
|
|
internal buffer named ``a`` and :kbd:`F2` to paste from that buffer. The buffer
|
|
names are arbitrary strings, so you can define as many such buffers as you need.
|
|
|
|
|
|
Marks
|
|
-------------
|
|
|
|
kitty has the ability to mark text on the screen based on regular expressions.
|
|
This can be useful to highlight words or phrases when browsing output from long
|
|
running programs or similar. To learn how this feature works, see :doc:`marks`.
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
marks
|