Update documentation of --to

This commit is contained in:
Kovid Goyal 2022-08-16 16:10:49 +05:30
parent 393820e77a
commit 10b74d0703
No known key found for this signature in database
GPG Key ID: 06BC317B515ACE7C
3 changed files with 14 additions and 5 deletions

View File

@ -117,7 +117,7 @@ def title(x: str) -> str:
@role
def opt(text: str) -> str:
return text
return bold(text)
@role

View File

@ -198,10 +198,12 @@ def handle_cmd(boss: BossType, window: Optional[WindowType], cmd: Dict[str, Any]
global_options_spec = partial('''\
--to
An address for the kitty instance to control. Corresponds to the address
given to the kitty instance via the :option:`kitty --listen-on` option. If not specified,
messages are sent to the controlling terminal for this process, i.e. they
will only work if this process is run within an existing kitty window.
An address for the kitty instance to control. Corresponds to the address given
to the kitty instance via the :option:`kitty --listen-on` option or the
:opt:`listen_on` setting in :file:`kitty.conf`. If not specified, the
environment variable :env:`KITTY_LISTEN_ON` is checked. If that is also not
found, messages are sent to the controlling terminal for this process, i.e.
they will only work if this process is run within a kitty window.
--password

View File

@ -17,6 +17,13 @@ func EntryPoint(tool_root *cobra.Command) *cobra.Command {
})
root.Annotations["options_title"] = "Global options"
root.PersistentFlags().String("to", "",
"An address for the kitty instance to control. Corresponds to the address given"+
" to the kitty instance via the :option:`kitty --listen-on` option or the :opt:`listen_on` setting in :file:`kitty.conf`. If not"+
" specified, the environment variable :env:`KITTY_LISTEN_ON` is checked. If that"+
" is also not found, messages are sent to the controlling terminal for this"+
" process, i.e. they will only work if this process is run within a kitty window.")
root.PersistentFlags().String("password", "",
"A password to use when contacting kitty. This will cause kitty to ask the user"+
" for permission to perform the specified action, unless the password has been"+