From 0300a355d06405acb4be6e384ff02fc14cc86a23 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Wed, 18 Oct 2023 17:31:44 +0530 Subject: [PATCH] update docs for remote_kitty --- docs/kittens/ssh.rst | 2 +- kittens/ssh/main.py | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/kittens/ssh.rst b/docs/kittens/ssh.rst index 6aed956cf..82d7408ae 100644 --- a/docs/kittens/ssh.rst +++ b/docs/kittens/ssh.rst @@ -7,7 +7,7 @@ Truly convenient SSH * Automatic :opt:`re-use of existing connections ` to avoid connection setup latency -* Make kitty itself available in the remote host :opt:`on demand ` +* Make the kitten binary available in the remote host :opt:`on demand ` * Easily :opt:`change terminal colors ` when connecting to remote hosts diff --git a/kittens/ssh/main.py b/kittens/ssh/main.py index 68937d842..010cd8be4 100644 --- a/kittens/ssh/main.py +++ b/kittens/ssh/main.py @@ -162,18 +162,18 @@ in the .conf files/themes are ignored. ''') opt('remote_kitty', 'if-needed', choices=('if-needed', 'no', 'yes'), long_text=''' -Make :program:`kitty` available on the remote host. Useful to run kittens such +Make :program:`kitten` available on the remote host. Useful to run kittens such as the :doc:`icat kitten ` to display images or the :doc:`transfer file kitten ` to transfer files. Only works if -the remote host has an architecture for which :link:`pre-compiled kitty binaries -` are available. Note that kitty +the remote host has an architecture for which :link:`pre-compiled kitten binaries +` are available. Note that kitten is not actually copied to the remote host, instead a small bootstrap script is -copied which will download and run kitty when kitty is first executed on the -remote host. A value of :code:`if-needed` means kitty is installed only if not -already present in the system-wide PATH. A value of :code:`yes` means that kitty -is installed even if already present, and the installed kitty takes precedence. -Finally, :code:`no` means no kitty is installed on the remote host. The -installed kitty can be updated by running: :code:`kitty +update-kitty` on the +copied which will download and run kitten when kitten is first executed on the +remote host. A value of :code:`if-needed` means kitten is installed only if not +already present in the system-wide PATH. A value of :code:`yes` means that kitten +is installed even if already present, and the installed kitten takes precedence. +Finally, :code:`no` means no kitten is installed on the remote host. The +installed kitten can be updated by running: :code:`kitten update-self` on the remote host. ''') egr() # }}}