diff --git a/kittens/hints/main.py b/kittens/hints/main.py index 2246b6236..855309f44 100644 --- a/kittens/hints/main.py +++ b/kittens/hints/main.py @@ -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 diff --git a/kittens/icat/main.py b/kittens/icat/main.py index 4af33c59e..7bdf662b9 100755 --- a/kittens/icat/main.py +++ b/kittens/icat/main.py @@ -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 diff --git a/kitty/cli.py b/kitty/cli.py index 2ccdace36..09e7178c7 100644 --- a/kitty/cli.py +++ b/kitty/cli.py @@ -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" diff --git a/kitty/options/definition.py b/kitty/options/definition.py index 963261089..76b99fcfa 100644 --- a/kitty/options/definition.py +++ b/kitty/options/definition.py @@ -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(''' diff --git a/kitty/rc/detach_tab.py b/kitty/rc/detach_tab.py index d2b089309..42cdb7a7a 100644 --- a/kitty/rc/detach_tab.py +++ b/kitty/rc/detach_tab.py @@ -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 diff --git a/kitty/rc/detach_window.py b/kitty/rc/detach_window.py index 271dfe1c1..99ffe4987 100644 --- a/kitty/rc/detach_window.py +++ b/kitty/rc/detach_window.py @@ -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 diff --git a/kitty/rc/launch.py b/kitty/rc/launch.py index b72833fa0..77098dd62 100644 --- a/kitty/rc/launch.py +++ b/kitty/rc/launch.py @@ -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 diff --git a/kitty/rc/new_window.py b/kitty/rc/new_window.py index f0387c69f..42a53f865 100644 --- a/kitty/rc/new_window.py +++ b/kitty/rc/new_window.py @@ -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 diff --git a/kitty/rc/set_colors.py b/kitty/rc/set_colors.py index 43ae219b1..55756b6cd 100644 --- a/kitty/rc/set_colors.py +++ b/kitty/rc/set_colors.py @@ -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',))}