Switch over to at-cmd form for references.
Sphinx anyway converts at_cmd to at-cmd for anchors in HTML so using at-cmd consistently.
This commit is contained in:
parent
555020cfd5
commit
3bcb694b1b
@ -249,7 +249,7 @@ if you specify a program-to-run you can use the special placeholder
|
|||||||
from kitty.rc.base import cli_params_for
|
from kitty.rc.base import cli_params_for
|
||||||
for cmd_name in sorted(all_command_names()):
|
for cmd_name in sorted(all_command_names()):
|
||||||
func = command_for_name(cmd_name)
|
func = command_for_name(cmd_name)
|
||||||
p(f'.. _at_{func.name}:\n')
|
p(f'.. _at-{func.name}:\n')
|
||||||
p('kitty @', func.name)
|
p('kitty @', func.name)
|
||||||
p('-' * 120)
|
p('-' * 120)
|
||||||
p('.. program::', 'kitty @', func.name)
|
p('.. program::', 'kitty @', func.name)
|
||||||
|
|||||||
@ -132,8 +132,8 @@ You can also define keyboard shortcuts to set colors, for example::
|
|||||||
map f1 set_colors --configured /path/to/some/config/file/colors.conf
|
map f1 set_colors --configured /path/to/some/config/file/colors.conf
|
||||||
|
|
||||||
Or you can enable :doc:`remote control <remote-control>` for |kitty| and use
|
Or you can enable :doc:`remote control <remote-control>` for |kitty| and use
|
||||||
:ref:`at_set-colors`. The shortcut mapping technique has the same syntax as the
|
:ref:`at-set-colors`. The shortcut mapping technique has the same syntax as the
|
||||||
remote control command, for details, see :ref:`at_set-colors`.
|
remote control command, for details, see :ref:`at-set-colors`.
|
||||||
|
|
||||||
To change colors when SSHing into a remote host, use the :opt:`color_scheme
|
To change colors when SSHing into a remote host, use the :opt:`color_scheme
|
||||||
<kitten-ssh.color_scheme>` setting for the :doc:`ssh kitten <kittens/ssh>`.
|
<kitten-ssh.color_scheme>` setting for the :doc:`ssh kitten <kittens/ssh>`.
|
||||||
|
|||||||
@ -36,7 +36,7 @@ This will make ``Hello, World`` show up in the window running the :program:`cat`
|
|||||||
program. The :option:`kitty @ send-text --match` option is very powerful, it
|
program. The :option:`kitty @ send-text --match` option is very powerful, it
|
||||||
allows selecting windows by their titles, the command line of the program
|
allows selecting windows by their titles, the command line of the program
|
||||||
running in the window, the working directory of the program running in the
|
running in the window, the working directory of the program running in the
|
||||||
window, etc. See :ref:`kitty @ send-text --help <at_send-text>` for details.
|
window, etc. See :ref:`kitty @ send-text --help <at-send-text>` for details.
|
||||||
|
|
||||||
More usefully, you can pipe the output of a command running in one window to
|
More usefully, you can pipe the output of a command running in one window to
|
||||||
another window, for example::
|
another window, for example::
|
||||||
|
|||||||
@ -2188,7 +2188,7 @@ class Boss:
|
|||||||
@ac('misc', '''
|
@ac('misc', '''
|
||||||
Change colors in the specified windows
|
Change colors in the specified windows
|
||||||
|
|
||||||
For details, see :ref:`at_set-colors`. For example::
|
For details, see :ref:`at-set-colors`. For example::
|
||||||
|
|
||||||
map f5 set_colors --configured /path/to/some/config/file/colors.conf
|
map f5 set_colors --configured /path/to/some/config/file/colors.conf
|
||||||
''')
|
''')
|
||||||
|
|||||||
@ -87,7 +87,7 @@ For numeric fields: :code:`id`, :code:`pid`, :code:`num` and :code:`recent`, the
|
|||||||
a number, not a regular expression.
|
a number, not a regular expression.
|
||||||
|
|
||||||
The field :code:`num` refers to the window position in the current tab, starting from zero and counting clockwise (this
|
The field :code:`num` refers to the window position in the current tab, starting from zero and counting clockwise (this
|
||||||
is the same as the order in which the windows are reported by the :ref:`kitty @ ls <at_ls>` command).
|
is the same as the order in which the windows are reported by the :ref:`kitty @ ls <at-ls>` command).
|
||||||
|
|
||||||
The window id of the current window is available as the :envvar:`KITTY_WINDOW_ID` environment variable.
|
The window id of the current window is available as the :envvar:`KITTY_WINDOW_ID` environment variable.
|
||||||
|
|
||||||
@ -102,7 +102,7 @@ The field :code:`state` matches on the state of the window. Supported states are
|
|||||||
Active windows are the windows that are active in their parent tab. There is only one focused window and it is the
|
Active windows are the windows that are active in their parent tab. There is only one focused window and it is the
|
||||||
window to which keyboard events are delivered.
|
window to which keyboard events are delivered.
|
||||||
|
|
||||||
Note that you can use the :ref:`kitty @ ls <at_ls>` command to get a list of windows.
|
Note that you can use the :ref:`kitty @ ls <at-ls>` command to get a list of windows.
|
||||||
'''
|
'''
|
||||||
MATCH_TAB_OPTION = '''\
|
MATCH_TAB_OPTION = '''\
|
||||||
--match -m
|
--match -m
|
||||||
@ -136,7 +136,7 @@ The field :code:`state` matches on the state of the tab. Supported states are:
|
|||||||
Active tabs are the tabs that are active in their parent OS window. There is only one focused tab
|
Active tabs are the tabs that are active in their parent OS window. There is only one focused tab
|
||||||
and it is the tab to which keyboard events are delivered.
|
and it is the tab to which keyboard events are delivered.
|
||||||
|
|
||||||
Note that you can use the :ref:`kitty @ ls <at_ls>` command to get a list of tabs.
|
Note that you can use the :ref:`kitty @ ls <at-ls>` command to get a list of tabs.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -28,7 +28,7 @@ class NewWindow(RemoteCommand):
|
|||||||
|
|
||||||
short_desc = 'Open new window'
|
short_desc = 'Open new window'
|
||||||
desc = (
|
desc = (
|
||||||
'DEPRECATED: Use the :ref:`launch <at_launch>` command instead.\n\n'
|
'DEPRECATED: Use the :ref:`launch <at-launch>` command instead.\n\n'
|
||||||
'Open a new window in the specified tab. If you use the :option:`kitty @ new-window --match` option'
|
'Open a new window in the specified tab. If you use the :option:`kitty @ new-window --match` option'
|
||||||
' the first matching tab is used. Otherwise the currently active tab is used.'
|
' the first matching tab is used. Otherwise the currently active tab is used.'
|
||||||
' Prints out the id of the newly opened window'
|
' Prints out the id of the newly opened window'
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user