Mark various options in text correctly
This commit is contained in:
parent
ecea1ba241
commit
f3376601f2
@ -599,7 +599,7 @@ indices into the list of selections. You can use 0 for the first selection and
|
||||
default=auto
|
||||
choices=auto,always,never
|
||||
Add trailing space after matched text. Defaults to auto, which adds the space
|
||||
when used together with --multiple.
|
||||
when used together with :code:`--multiple`.
|
||||
|
||||
|
||||
--hints-offset
|
||||
|
||||
@ -109,7 +109,7 @@ Do not print out anything to STDOUT during operation.
|
||||
default=0
|
||||
Z-index of the image. When negative, text will be displayed on top of the image. Use
|
||||
a double minus for values under the threshold for drawing images under cell background
|
||||
colors. For example, --1 evaluates as -1,073,741,825.
|
||||
colors. For example, :code:`--1` evaluates as -1,073,741,825.
|
||||
|
||||
|
||||
--loop -l
|
||||
|
||||
@ -657,7 +657,7 @@ respect to the temporary directory. To control kitty, you can send
|
||||
it commands with :italic:`kitty @` using the :option:`kitty @ --to` option to
|
||||
specify this address. This option will be ignored, unless you set
|
||||
:opt:`allow_remote_control` to yes in :file:`kitty.conf`. Note that if you run
|
||||
:italic:`kitty @` within a kitty window, there is no need to specify the :italic:`--to`
|
||||
:italic:`kitty @` within a kitty window, there is no need to specify the :code:`--to`
|
||||
option as it is read automatically from the environment. For UNIX sockets, this
|
||||
can also be specified in :file:`kitty.conf`.
|
||||
|
||||
@ -682,7 +682,7 @@ Output commands received from child process to stdout
|
||||
|
||||
|
||||
--replay-commands
|
||||
Replay previously dumped commands. Specify the path to a dump file previously created by --dump-commands. You
|
||||
Replay previously dumped commands. Specify the path to a dump file previously created by :option:`kitty --dump-commands`. You
|
||||
can open a new kitty window to replay the commands with::
|
||||
|
||||
kitty sh -c "kitty --replay-commands /path/to/dump/file; read"
|
||||
|
||||
@ -3440,7 +3440,7 @@ map('Open the selected hyperlink',
|
||||
'open_selected_hyperlink kitty_mod+p>y kitten hints --type hyperlink',
|
||||
long_text='''
|
||||
Select a hyperlink (i.e. a URL that has been marked as such by the terminal
|
||||
program, for example, by ls --hyperlink=auto).
|
||||
program, for example, by :code:`ls --hyperlink=auto`).
|
||||
'''
|
||||
)
|
||||
egr('''
|
||||
|
||||
@ -23,7 +23,7 @@ class DetachTab(RemoteCommand):
|
||||
short_desc = 'Detach a tab and place it in a different/new OS Window'
|
||||
desc = (
|
||||
'Detach the specified tab and either move it into a new OS window'
|
||||
' or add it to the OS Window containing the tab specified by --target-tab'
|
||||
' or add it to the OS Window containing the tab specified by :option:`kitty @ detach-tab --target-tab`'
|
||||
)
|
||||
options_spec = MATCH_TAB_OPTION + '\n\n' + MATCH_TAB_OPTION.replace('--match -m', '--target-tab -t') + '''\n
|
||||
--self
|
||||
|
||||
@ -24,7 +24,7 @@ class DetachWindow(RemoteCommand):
|
||||
short_desc = 'Detach a window and place it in a different/new tab'
|
||||
desc = (
|
||||
'Detach the specified window and either move it into a new tab, a new OS window'
|
||||
' or add it to the specified tab. Use the special value :code:`new` for --target-tab'
|
||||
' or add it to the specified tab. Use the special value :code:`new` for :option:`kitty @ detach-window --target-tab`'
|
||||
' to move to a new tab. If no target tab is specified the window is moved to a new OS window.'
|
||||
)
|
||||
options_spec = MATCH_WINDOW_OPTION + '\n\n' + MATCH_TAB_OPTION.replace('--match -m', '--target-tab -t') + '''\n
|
||||
|
||||
@ -48,7 +48,7 @@ class Launch(RemoteCommand):
|
||||
' Prints out the id of the newly opened window. Any command line arguments'
|
||||
' are assumed to be the command line used to run in the new window, if none'
|
||||
' are provided, the default shell is run. For example:'
|
||||
' :italic:`kitty @ launch --title Email mutt`.'
|
||||
' :code:`kitty @ launch --title Email mutt`.'
|
||||
)
|
||||
options_spec = MATCH_TAB_OPTION + '\n\n' + '''\
|
||||
--no-response
|
||||
|
||||
@ -35,7 +35,7 @@ class NewWindow(RemoteCommand):
|
||||
' (unless :option:`--no-response` is used). Any command line arguments'
|
||||
' are assumed to be the command line used to run in the new window, if none'
|
||||
' are provided, the default shell is run. For example:\n'
|
||||
':italic:`kitty @ new-window --title Email mutt`'
|
||||
':code:`kitty @ new-window --title Email mutt`'
|
||||
)
|
||||
options_spec = MATCH_TAB_OPTION + '''\n
|
||||
--title
|
||||
@ -65,7 +65,7 @@ Open a new tab
|
||||
|
||||
|
||||
--tab-title
|
||||
When using --new-tab set the title of the tab.
|
||||
When using :option:`kitty @ new-window --new-tab` set the title of the tab.
|
||||
|
||||
|
||||
--no-response
|
||||
|
||||
@ -86,7 +86,7 @@ windows or after a reset).
|
||||
--reset
|
||||
type=bool-set
|
||||
Restore all colors to the values they had at kitty startup. Note that if you specify
|
||||
this option, any color arguments are ignored and --configured and --all are implied.
|
||||
this option, any color arguments are ignored and :option:`kitty @ set-colors --configured` and :option:`kitty @ set-colors --all` are implied.
|
||||
''' + '\n\n' + MATCH_WINDOW_OPTION + '\n\n' + MATCH_TAB_OPTION.replace('--match -m', '--match-tab -t')
|
||||
argspec = 'COLOR_OR_FILE ...'
|
||||
args_completion = {'files': ('CONF files', ('*.conf',))}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user