wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-23 21:32:13 +03:00
Code Issues Projects Releases Wiki Activity

docs: minor adjustments to ssh docs

Browse Source 
Link to the new ssh backend config option and adjust the wording
slightly around libssh2.
This commit is contained in:
Wez Furlong 2021-12-03 09:00:57 -07:00
parent 20475ab32e
commit 2509e7bd67
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/ssh.md
View File

@ -1,8 +1,8 @@
## SSH Connections ## SSH Connections
wezterm uses libssh2 to provide an integrated SSH client. The wezterm uses an embedded ssh library to provide an integrated SSH client. The
client can be used to make ad-hoc SSH connections to remote hosts client can be used to make ad-hoc SSH connections to remote hosts
by invoking the client: by invoking the client like this:
```bash ```bash
$ wezterm ssh wez@my.server $ wezterm ssh wez@my.server
@ -14,8 +14,8 @@ When invoked in this way, wezterm may prompt you for SSH authentication
and once a connection is established, open a new terminal window with and once a connection is established, open a new terminal window with
your requested command, or your shell if you didn't specify one. your requested command, or your shell if you didn't specify one.
Creating a new tab will create a new channel in your existing session Creating new tabs or panes will each create a new channel in your existing
so you won't need to re-authenticate for additional tabs that you session so you won't need to re-authenticate for additional tabs that you
create. create.
SSH sessions created in this way are non-persistent and all associated SSH sessions created in this way are non-persistent and all associated
@ -25,6 +25,9 @@ Take a look at [the multiplexing section](multiplexing.html) for an
alternative configuration that connects to a remote wezterm instance alternative configuration that connects to a remote wezterm instance
and preserves your tabs. and preserves your tabs.
The [ssh_backend](config/lua/config/ssh_backend.md) configuration can
be used to specify which ssh library is used.
*Since: 20210404-112810-b63a949d* *Since: 20210404-112810-b63a949d*
wezterm is now able to parse `~/.ssh/config` and `/etc/ssh/ssh_config` wezterm is now able to parse `~/.ssh/config` and `/etc/ssh/ssh_config`
@ -61,3 +64,4 @@ example shows how to specify the private key to use when connecting to
```bash ```bash
wezterm ssh -oIdentityFile=/secret/id_ed25519 some-host wezterm ssh -oIdentityFile=/secret/id_ed25519 some-host
``` ```