KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docs: use the action name of the shortcut in several places

Browse Source
This commit is contained in:
pagedown 2021-12-10 14:36:16 +08:00
parent 59957a913a
commit 8ae0ae2c93
No known key found for this signature in database
GPG Key ID: E921CF18AC8FF6EB
5 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/actions.rst
View File

@ -4,6 +4,7 @@ Mappable actions
.. highlight:: conf .. highlight:: conf
The actions described below can be mapped to any key press or mouse action The actions described below can be mapped to any key press or mouse action
using the ``map`` and ``mouse_map`` directives in :file:`kitty.conf`. using the ``map`` and ``mouse_map`` directives in :file:`kitty.conf`. For
configuration examples, see the default shortcut links for each action.
.. include:: /generated/actions.rst .. include:: /generated/actions.rst

2
docs/kittens/hints.rst
View File

@ -36,7 +36,7 @@ taken for different types of URLs <../open_actions>`.
The hints kitten is very powerful to see more detailed help on its various The hints kitten is very powerful to see more detailed help on its various
options and modes of operation, see below. You can use these options to options and modes of operation, see below. You can use these options to
create mappings in :file:`kitty.conf` to select various different text create mappings in :file:`kitty.conf` to select various different text
snippets. See :sc:`insert_selected_path` for examples. snippets. See :sc:`insert_selected_path <insert_selected_path>` for examples.
Completely customizing the matching and actions of the kitten Completely customizing the matching and actions of the kitten

6
docs/overview.rst
View File

@ -244,15 +244,15 @@ 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 :term:`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 <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,
you can see tips for doing so, in you can see tips for doing so, in
`this thread <https://github.com/kovidgoyal/kitty/issues/719>`_. `this thread <https://github.com/kovidgoyal/kitty/issues/719>`_.
If you wish to store very large amounts of scrollback to view using the piping or If you wish to store very large amounts of scrollback to view using the piping or
:sc:`show_scrollback` features, you can use the :opt:`scrollback_pager_history_size` :sc:`show_scrollback <show_scrollback>` features, you can use the
option. :opt:`scrollback_pager_history_size` option.
Integration with shells Integration with shells

2
kitty/boss.py
View File

@ -749,7 +749,7 @@ class Boss:
@ac('misc', ''' @ac('misc', '''
Clear the terminal Clear the terminal
See :sc:`reset_terminal` for details. For example:: See :sc:`reset_terminal <reset_terminal>` for details. For example::
# Reset the terminal # Reset the terminal
map kitty_mod+f9 clear_terminal reset active map kitty_mod+f9 clear_terminal reset active

2
kitty/window.py
View File

@ -569,7 +569,7 @@ class Window:
@ac('misc', ''' @ac('misc', '''
Send the specified text to the active window Send the specified text to the active window
For details, see :sc:`send_text`. See :sc:`send_text <send_text>` for details.
''') ''')
def send_text(self, *args: str) -> bool: def send_text(self, *args: str) -> bool:
mode = keyboard_mode_name(self.screen) mode = keyboard_mode_name(self.screen)