mirrors/kitty
1
0
Fork 0
mirror of https://github.com/kovidgoyal/kitty synced 2026-07-07 17:43:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Unify and generalize the terms remote computer, machine and host

Browse Source
This commit is contained in:
pagedown
2022-03-22 23:26:15 +08:00
parent efda0ea455
commit ff8a99211d
3 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/kittens/ssh.rst
View File

@@ -1,18 +1,18 @@
Truly convenient SSH
=========================================
* Automatic :ref:`shell_integration` on remote machines
* Automatic :ref:`shell_integration` on remote hosts
* Easily :ref:`clone local shell/editor config <real_world_ssh_kitten_config>` on remote machines
* Easily :ref:`clone local shell/editor config <real_world_ssh_kitten_config>` on remote hosts
* Automatic :opt:`re-use of existing connections <kitten-ssh.share_connections>` to avoid connection setup latency
The ssh kitten allows you to login easily to remote servers, and automatically
The ssh kitten allows you to login easily to remote hosts, and automatically
setup the environment there to be as comfortable as your local shell. You
can specify environment variables to set on the remote server and
can specify environment variables to set on the remote host and
files to copy there, making your remote experience just like your
local shell. Additionally, it automatically sets up :ref:`shell_integration` on
the remote server and copies the kitty terminfo database there.
the remote host and copies the kitty terminfo database there.
The ssh kitten is a thin wrapper around the traditional `ssh <https://man.openbsd.org/ssh>`__
command line program and supports all the same options and arguments and configuration.
@@ -23,7 +23,7 @@ out, simply run:
kitty +kitten ssh some-hostname-to-connect-to
You should end up at a shell prompt on the remote server, with shell
You should end up at a shell prompt on the remote host, with shell
integration enabled. If you like it you can add an alias to it in your shell's
rc files:
@@ -38,11 +38,11 @@ If you define a mapping in :file:`kitty.conf` such as::
map f1 new_window_with_cwd
Then, pressing :kbd:`F1` will open a new window automatically logged
into the same server using the ssh kitten, at the same directory.
into the same host using the ssh kitten, at the same directory.
The ssh kitten can be configured using the :file:`~/.config/kitty/ssh.conf`
file where you can specify environment variables to set on the remote server
and files to copy from your local machine to the remote server. Let's see a
file where you can specify environment variables to set on the remote host
and files to copy from the local to the remote host. Let's see a
quick example:
.. code-block:: conf
@@ -51,7 +51,7 @@ quick example:
copy .zshrc .vimrc .vim
# Setup some environment variables
env SOME_VAR=x
# COPIED_VAR will have the same value on the remote server as it does locally
# COPIED_VAR will have the same value on the remote host as it does locally
env COPIED_VAR=_kitty_copy_env_var_
# Create some per hostname settings
@@ -117,7 +117,7 @@ How it works
The ssh kitten works by having SSH transmit and execute a POSIX sh (or
:opt:`optionally <kitten-ssh.interpreter>` Python) bootstrap script on the
remote server using an :opt:`interpreter <kitten-ssh.interpreter>`. This script
remote host using an :opt:`interpreter <kitten-ssh.interpreter>`. This script
reads setup data over the tty device, which kitty sends as a base64 encoded
compressed tarball. The script extracts it and places the :opt:`files <kitten-ssh.copy>`
and sets the :opt:`environment variables <kitten-ssh.env>` before finally
@@ -130,9 +130,9 @@ localhost by the kitten, the transmission is allowed. If your OpenSSH version is
.. note::
When connecting to BSD servers, it is possible the bootstrap script will
When connecting to BSD hosts, it is possible the bootstrap script will
fail or run slowly, because the default shells are crippled in various ways.
Your best bet is to install python on the server, make sure the login shell
Your best bet is to install Python on the remote, make sure the login shell
is something POSIX sh compliant, and use :code:`python` as the :opt:`interpreter
<kitten-ssh.interpreter>` in :file:`ssh.conf`.