Update documentation of --to

This commit is contained in:
Kovid Goyal
2022-08-16 16:10:49 +05:30
parent 393820e77a
commit 10b74d0703
3 changed files with 14 additions and 5 deletions

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"+