Add the most common keyboard shortcuts to the kitty man page
This commit is contained in:
Kovid Goyal
parent
3fcf83e685
commit
8d46237935
126
docs/basic.rst
Normal file
126
docs/basic.rst
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
Tabs and Windows
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
|kitty| is capable of running multiple programs organized into tabs and
|
||||||
|
windows. The top level of organization is the *Tab*. Each tab consists
|
||||||
|
of one or more *windows*. The windows can be arranged in multiple
|
||||||
|
different layouts, like windows are organized in a tiling window
|
||||||
|
manager. The keyboard controls (which are all customizable) for tabs and
|
||||||
|
windows are:
|
||||||
|
|
||||||
|
Scrolling
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
======================== =======================
|
||||||
|
Action Shortcut
|
||||||
|
======================== =======================
|
||||||
|
Scroll line up :sc:`scroll_line_up` (also :kbd:`⌥+⌘+⇞` and :kbd:`⌘+↑` on macOS)
|
||||||
|
Scroll line down :sc:`scroll_line_down` (also :kbd:`⌥+⌘+⇟` and :kbd:`⌘+↓` on macOS)
|
||||||
|
Scroll page up :sc:`scroll_page_up` (also :kbd:`⌘+⇞` on macOS)
|
||||||
|
Scroll page down :sc:`scroll_page_down` (also :kbd:`⌘+⇟` on macOS)
|
||||||
|
Scroll to top :sc:`scroll_home` (also :kbd:`⌘+↖` on macOS)
|
||||||
|
Scroll to bottom :sc:`scroll_end` (also :kbd:`⌘+↘` on macOS)
|
||||||
|
======================== =======================
|
||||||
|
|
||||||
|
Tabs
|
||||||
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
======================== =======================
|
||||||
|
Action Shortcut
|
||||||
|
======================== =======================
|
||||||
|
New tab :sc:`new_tab` (also :kbd:`⌘+t` on macOS)
|
||||||
|
Close tab :sc:`close_tab` (also :kbd:`⌘+w` on macOS)
|
||||||
|
Next tab :sc:`next_tab` (also :kbd:`^+⇥` and :kbd:`⇧+⌘+]` on macOS)
|
||||||
|
Previous tab :sc:`previous_tab` (also :kbd:`⇧+^+⇥` and :kbd:`⇧+⌘+[` on macOS)
|
||||||
|
Next layout :sc:`next_layout`
|
||||||
|
Move tab forward :sc:`move_tab_forward`
|
||||||
|
Move tab backward :sc:`move_tab_backward`
|
||||||
|
Set tab title :sc:`set_tab_title` (also :kbd:`⇧+⌘+i` on macOS)
|
||||||
|
======================== =======================
|
||||||
|
|
||||||
|
|
||||||
|
Windows
|
||||||
|
~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
======================== =======================
|
||||||
|
Action Shortcut
|
||||||
|
======================== =======================
|
||||||
|
New window :sc:`new_window` (also :kbd:`⌘+↩` on macOS)
|
||||||
|
New OS window :sc:`new_os_window` (also :kbd:`⌘+n` on macOS)
|
||||||
|
Close window :sc:`close_window` (also :kbd:`⇧+⌘+d` on macOS)
|
||||||
|
Next window :sc:`next_window`
|
||||||
|
Previous window :sc:`previous_window`
|
||||||
|
Move window forward :sc:`move_window_forward`
|
||||||
|
Move window backward :sc:`move_window_backward`
|
||||||
|
Move window to top :sc:`move_window_to_top`
|
||||||
|
Focus specific window :sc:`first_window`, :sc:`second_window` ... :sc:`tenth_window`
|
||||||
|
(also :kbd:`⌘+1`, :kbd:`⌘+2` ... :kbd:`⌘+9` on macOS)
|
||||||
|
(clockwise from the top-left)
|
||||||
|
======================== =======================
|
||||||
|
|
||||||
|
Additionally, you can define shortcuts in :file:`kitty.conf` to focus neighboring
|
||||||
|
windows and move windows around (similar to window movement in vim)::
|
||||||
|
|
||||||
|
map ctrl+left neighboring_window left
|
||||||
|
map shift+left move_window right
|
||||||
|
map ctrl+down neighboring_window down
|
||||||
|
map shift+down move_window up
|
||||||
|
...
|
||||||
|
|
||||||
|
You can also define a shortcut to switch to the previously active window::
|
||||||
|
|
||||||
|
map ctrl+p nth_window -1
|
||||||
|
|
||||||
|
``nth_window`` will focus the nth window for positive numbers and the
|
||||||
|
previously active windows for negative numbers.
|
||||||
|
|
||||||
|
.. _detach_window:
|
||||||
|
|
||||||
|
You can define shortcuts to detach the current window and
|
||||||
|
move it to another tab or another OS window::
|
||||||
|
|
||||||
|
# moves the window into a new OS window
|
||||||
|
map ctrl+f2 detach_window
|
||||||
|
# moves the window into a new Tab
|
||||||
|
map ctrl+f3 detach_window new-tab
|
||||||
|
# asks which tab to move the window into
|
||||||
|
map ctrl+f4 detach_window ask
|
||||||
|
|
||||||
|
Similarly, you can detach the current tab, with::
|
||||||
|
|
||||||
|
# moves the tab into a new OS window
|
||||||
|
map ctrl+f2 detach_tab
|
||||||
|
# asks which OS Window to move the tab into
|
||||||
|
map ctrl+f4 detach_tab ask
|
||||||
|
|
||||||
|
Finally, you can define a shortcut to close all windows in a tab other than
|
||||||
|
the currently active window::
|
||||||
|
|
||||||
|
map f9 close_other_windows_in_tab
|
||||||
|
|
||||||
|
|
||||||
|
Other keyboard shortcuts
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
================================== =======================
|
||||||
|
Action Shortcut
|
||||||
|
================================== =======================
|
||||||
|
Copy to clipboard :sc:`copy_to_clipboard` (also :kbd:`⌘+c` on macOS)
|
||||||
|
Paste from clipboard :sc:`paste_from_clipboard` (also :kbd:`⌘+v` on macOS)
|
||||||
|
Paste from selection :sc:`paste_from_selection`
|
||||||
|
Increase font size :sc:`increase_font_size` (also :kbd:`⌘++` on macOS)
|
||||||
|
Decrease font size :sc:`decrease_font_size` (also :kbd:`⌘+-` on macOS)
|
||||||
|
Restore font size :sc:`reset_font_size` (also :kbd:`⌘+0` on macOS)
|
||||||
|
Toggle fullscreen :sc:`toggle_fullscreen` (also :kbd:`^+⌘+f` on macOS)
|
||||||
|
Toggle maximized :sc:`toggle_maximized`
|
||||||
|
Input unicode character :sc:`input_unicode_character` (also :kbd:`^+⌘+space` on macOS)
|
||||||
|
Click URL using the keyboard :sc:`open_url`
|
||||||
|
Reset the terminal :sc:`reset_terminal`
|
||||||
|
Pass current selection to program :sc:`pass_selection_to_program`
|
||||||
|
Edit |kitty| config file :sc:`edit_config_file`
|
||||||
|
Open a |kitty| shell :sc:`kitty_shell`
|
||||||
|
Increase background opacity :sc:`increase_background_opacity`
|
||||||
|
Decrease background opacity :sc:`decrease_background_opacity`
|
||||||
|
Full background opacity :sc:`full_background_opacity`
|
||||||
|
Reset background opacity :sc:`reset_background_opacity`
|
||||||
|
================================== =======================
|
||||||
128
docs/index.rst
128
docs/index.rst
@ -99,133 +99,7 @@ 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
|
easily extensible so that new features can be added in the future with
|
||||||
relatively little effort.
|
relatively little effort.
|
||||||
|
|
||||||
Tabs and Windows
|
.. include:: basic.rst
|
||||||
-------------------
|
|
||||||
|
|
||||||
|kitty| is capable of running multiple programs organized into tabs and
|
|
||||||
windows. The top level of organization is the *Tab*. Each tab consists
|
|
||||||
of one or more *windows*. The windows can be arranged in multiple
|
|
||||||
different layouts, like windows are organized in a tiling window
|
|
||||||
manager. The keyboard controls (which are all customizable) for tabs and
|
|
||||||
windows are:
|
|
||||||
|
|
||||||
Scrolling
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
======================== =======================
|
|
||||||
Action Shortcut
|
|
||||||
======================== =======================
|
|
||||||
Scroll line up :sc:`scroll_line_up` (also :kbd:`⌥+⌘+⇞` and :kbd:`⌘+↑` on macOS)
|
|
||||||
Scroll line down :sc:`scroll_line_down` (also :kbd:`⌥+⌘+⇟` and :kbd:`⌘+↓` on macOS)
|
|
||||||
Scroll page up :sc:`scroll_page_up` (also :kbd:`⌘+⇞` on macOS)
|
|
||||||
Scroll page down :sc:`scroll_page_down` (also :kbd:`⌘+⇟` on macOS)
|
|
||||||
Scroll to top :sc:`scroll_home` (also :kbd:`⌘+↖` on macOS)
|
|
||||||
Scroll to bottom :sc:`scroll_end` (also :kbd:`⌘+↘` on macOS)
|
|
||||||
======================== =======================
|
|
||||||
|
|
||||||
Tabs
|
|
||||||
~~~~~~~~~~~
|
|
||||||
|
|
||||||
======================== =======================
|
|
||||||
Action Shortcut
|
|
||||||
======================== =======================
|
|
||||||
New tab :sc:`new_tab` (also :kbd:`⌘+t` on macOS)
|
|
||||||
Close tab :sc:`close_tab` (also :kbd:`⌘+w` on macOS)
|
|
||||||
Next tab :sc:`next_tab` (also :kbd:`^+⇥` and :kbd:`⇧+⌘+]` on macOS)
|
|
||||||
Previous tab :sc:`previous_tab` (also :kbd:`⇧+^+⇥` and :kbd:`⇧+⌘+[` on macOS)
|
|
||||||
Next layout :sc:`next_layout`
|
|
||||||
Move tab forward :sc:`move_tab_forward`
|
|
||||||
Move tab backward :sc:`move_tab_backward`
|
|
||||||
Set tab title :sc:`set_tab_title` (also :kbd:`⇧+⌘+i` on macOS)
|
|
||||||
======================== =======================
|
|
||||||
|
|
||||||
|
|
||||||
Windows
|
|
||||||
~~~~~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
======================== =======================
|
|
||||||
Action Shortcut
|
|
||||||
======================== =======================
|
|
||||||
New window :sc:`new_window` (also :kbd:`⌘+↩` on macOS)
|
|
||||||
New OS window :sc:`new_os_window` (also :kbd:`⌘+n` on macOS)
|
|
||||||
Close window :sc:`close_window` (also :kbd:`⇧+⌘+d` on macOS)
|
|
||||||
Next window :sc:`next_window`
|
|
||||||
Previous window :sc:`previous_window`
|
|
||||||
Move window forward :sc:`move_window_forward`
|
|
||||||
Move window backward :sc:`move_window_backward`
|
|
||||||
Move window to top :sc:`move_window_to_top`
|
|
||||||
Focus specific window :sc:`first_window`, :sc:`second_window` ... :sc:`tenth_window`
|
|
||||||
(also :kbd:`⌘+1`, :kbd:`⌘+2` ... :kbd:`⌘+9` on macOS)
|
|
||||||
(clockwise from the top-left)
|
|
||||||
======================== =======================
|
|
||||||
|
|
||||||
Additionally, you can define shortcuts in :file:`kitty.conf` to focus neighboring
|
|
||||||
windows and move windows around (similar to window movement in vim)::
|
|
||||||
|
|
||||||
map ctrl+left neighboring_window left
|
|
||||||
map shift+left move_window right
|
|
||||||
map ctrl+down neighboring_window down
|
|
||||||
map shift+down move_window up
|
|
||||||
...
|
|
||||||
|
|
||||||
You can also define a shortcut to switch to the previously active window::
|
|
||||||
|
|
||||||
map ctrl+p nth_window -1
|
|
||||||
|
|
||||||
``nth_window`` will focus the nth window for positive numbers and the
|
|
||||||
previously active windows for negative numbers.
|
|
||||||
|
|
||||||
.. _detach_window:
|
|
||||||
|
|
||||||
You can define shortcuts to detach the current window and
|
|
||||||
move it to another tab or another OS window::
|
|
||||||
|
|
||||||
# moves the window into a new OS window
|
|
||||||
map ctrl+f2 detach_window
|
|
||||||
# moves the window into a new Tab
|
|
||||||
map ctrl+f3 detach_window new-tab
|
|
||||||
# asks which tab to move the window into
|
|
||||||
map ctrl+f4 detach_window ask
|
|
||||||
|
|
||||||
Similarly, you can detach the current tab, with::
|
|
||||||
|
|
||||||
# moves the tab into a new OS window
|
|
||||||
map ctrl+f2 detach_tab
|
|
||||||
# asks which OS Window to move the tab into
|
|
||||||
map ctrl+f4 detach_tab ask
|
|
||||||
|
|
||||||
Finally, you can define a shortcut to close all windows in a tab other than
|
|
||||||
the currently active window::
|
|
||||||
|
|
||||||
map f9 close_other_windows_in_tab
|
|
||||||
|
|
||||||
|
|
||||||
Other keyboard shortcuts
|
|
||||||
----------------------------------
|
|
||||||
|
|
||||||
================================== =======================
|
|
||||||
Action Shortcut
|
|
||||||
================================== =======================
|
|
||||||
Copy to clipboard :sc:`copy_to_clipboard` (also :kbd:`⌘+c` on macOS)
|
|
||||||
Paste from clipboard :sc:`paste_from_clipboard` (also :kbd:`⌘+v` on macOS)
|
|
||||||
Paste from selection :sc:`paste_from_selection`
|
|
||||||
Increase font size :sc:`increase_font_size` (also :kbd:`⌘++` on macOS)
|
|
||||||
Decrease font size :sc:`decrease_font_size` (also :kbd:`⌘+-` on macOS)
|
|
||||||
Restore font size :sc:`reset_font_size` (also :kbd:`⌘+0` on macOS)
|
|
||||||
Toggle fullscreen :sc:`toggle_fullscreen` (also :kbd:`^+⌘+f` on macOS)
|
|
||||||
Toggle maximized :sc:`toggle_maximized`
|
|
||||||
Input unicode character :sc:`input_unicode_character` (also :kbd:`^+⌘+space` on macOS)
|
|
||||||
Click URL using the keyboard :sc:`open_url`
|
|
||||||
Reset the terminal :sc:`reset_terminal`
|
|
||||||
Pass current selection to program :sc:`pass_selection_to_program`
|
|
||||||
Edit |kitty| config file :sc:`edit_config_file`
|
|
||||||
Open a |kitty| shell :sc:`kitty_shell`
|
|
||||||
Increase background opacity :sc:`increase_background_opacity`
|
|
||||||
Decrease background opacity :sc:`decrease_background_opacity`
|
|
||||||
Full background opacity :sc:`full_background_opacity`
|
|
||||||
Reset background opacity :sc:`reset_background_opacity`
|
|
||||||
================================== =======================
|
|
||||||
|
|
||||||
|
|
||||||
.. _layouts:
|
.. _layouts:
|
||||||
|
|
||||||
|
|||||||
@ -4,3 +4,5 @@ The kitty command line interface
|
|||||||
.. program:: kitty
|
.. program:: kitty
|
||||||
|
|
||||||
.. include:: generated/cli-kitty.rst
|
.. include:: generated/cli-kitty.rst
|
||||||
|
|
||||||
|
.. include:: basic.rst
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user