plan9fox/sys/man/1/ssh

.TH SSH 1
.SH NAME
ssh - secure shell remote login client
.SH SYNOPSIS
.B ssh 
[
.B -d
] [
.B -R
] [
.B -r
] [
.B -t
.I thumbfile
] [
.B -T
.I tries
] [
.B -u
.I user
] [
.B -h
] [
.IR user @] host
[
.B -W
.I remote!port
] [
.I cmd
.I args
.I ...
]
.SH DESCRIPTION
.I Ssh
starts a remote shell or
.I cmd
on the computer 
.I host
logged in as
.IR user .
The input file descriptor is forwarded to the
remote side and output and error descriptors
are forwarded to the local side.
.PP
The connection is authenticated and encrypted
using the SSH2 protocol. The user authenticates
itself to the host using his RSA key pair (stored
in factotum) or plaintext  passwords. To authenticate
the host to the user, the hosts RSA public key is
hashed and compared to the entries in
.B $home/lib/sshthumbs
file (see
.IR thumbprint (6)).
The 
.I thumbfile
location can be changed with the
.B -t
option.
.PP
When
.I cmd
is specified, it is concatenated with the list of quoted
.I args
and run on the remote side. No pseudo terminal will be requested.
A
.I cmd
beginning with
.B #
is interpreted as a subsystem name such as sftp (see
.IR sshfs (4)).
.PP
Without
.IR cmd ,
a shell is started on the remote side.
In that case and when the
.B $TERM
environment variable is set (such as when started under
a terminal emulator like
.IR vt (1)),
a pseudo terminal will be requested for the shell.
This can be disabled with the
.B -R
option.
A pseudo-terminal can be requested in all cases
with the
.B -r
option.
.PP
With the
.B -W
option, instead of executing a command remotely, makes
the server dial a tcp connection to
.I remote!port
which the client relays on standard input and output.
For handling multiple connections transparently to
programs, see
.IR sshnet (4).
.PP
The
.B -d
option enables debug output.
.SH FILES
.TF $home/lib/sshthumbs
.TP
.B $home/lib/sshthumbs
the user's thumbfile of known host fingerprints
.SH SOURCE
.B /sys/src/cmd/ssh.c
.SH BUGS
If
.I keyboard-interactive
authentication fails, by default it is retried three times.
The number of
.I tries
can be changed with
.BR -T .
Setting it to zero disables keyboard-interactive authentication.
.SH "SEE ALSO"
.IR vt (1),
.IR rsa (8),
.IR thumbprint (6),
.IR factotum (4),
.IR sshfs (4),
.IR sshnet (4)
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.TH SSH 1`
			`.SH NAME`
			`ssh - secure shell remote login client`
			`.SH SYNOPSIS`
			`.B ssh`
			`[`
			`.B -d`
			`] [`
			`.B -R`
			`] [`
ssh:add -r for extra raw mode 2018-05-19 01:36:33 +00:00			`.B -r`
			`] [`
ssh: document thumbfile options 2017-04-23 00:59:32 +00:00			`.B -t`
			`.I thumbfile`
			`] [`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`.B -T`
			`.I tries`
			`] [`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.B -u`
			`.I user`
			`] [`
ssh: add -h flag to pass host (for compatibility) 2017-05-05 19:04:31 +00:00			`.B -h`
			`] [`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.IR user @] host`
			`[`
ssh: implement -W option for making remote tcp connections 2019-04-02 07:03:35 +00:00			`.B -W`
			`.I remote!port`
			`] [`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.I cmd`
ssh(1): add bugs section about host not being authenticated 2017-04-22 23:11:12 +00:00			`.I args`
			`.I ...`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`]`
			`.SH DESCRIPTION`
			`.I Ssh`
			`starts a remote shell or`
			`.I cmd`
			`on the computer`
			`.I host`
			`logged in as`
			`.IR user .`
			`The input file descriptor is forwarded to the`
ssh(1): add bugs section about host not being authenticated 2017-04-22 23:11:12 +00:00			`remote side and output and error descriptors`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`are forwarded to the local side.`
ssh(1): add bugs section about host not being authenticated 2017-04-22 23:11:12 +00:00			`.PP`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`The connection is authenticated and encrypted`
ssh(1): add bugs section about host not being authenticated 2017-04-22 23:11:12 +00:00			`using the SSH2 protocol. The user authenticates`
ssh(1): add $home/lib/thumbfile to FILE section 2017-04-23 01:31:20 +00:00			`itself to the host using his RSA key pair (stored`
			`in factotum) or plaintext passwords. To authenticate`
			`the host to the user, the hosts RSA public key is`
			`hashed and compared to the entries in`
ssh: document thumbfile options 2017-04-23 00:59:32 +00:00			`.B $home/lib/sshthumbs`
ssh(1): refer to thumbprint(6) for the sshthumbs file format 2017-04-24 00:21:43 +00:00			`file (see`
			`.IR thumbprint (6)).`
			`The`
ssh(1): add $home/lib/thumbfile to FILE section 2017-04-23 01:31:20 +00:00			`.I thumbfile`
			`location can be changed with the`
ssh: document thumbfile options 2017-04-23 00:59:32 +00:00			`.B -t`
			`option.`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.PP`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`When`
			`.I cmd`
			`is specified, it is concatenated with the list of quoted`
			`.I args`
			`and run on the remote side. No pseudo terminal will be requested.`
			`A`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.I cmd`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`beginning with`
			`.B #`
			`is interpreted as a subsystem name such as sftp (see`
			`.IR sshfs (4)).`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.PP`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`Without`
			`.IR cmd ,`
			`a shell is started on the remote side.`
ssh:add -r for extra raw mode 2018-05-19 01:36:33 +00:00			`In that case and when the`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.B $TERM`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`environment variable is set (such as when started under`
			`a terminal emulator like`
			`.IR vt (1)),`
			`a pseudo terminal will be requested for the shell.`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`This can be disabled with the`
			`.B -R`
			`option.`
ssh:add -r for extra raw mode 2018-05-19 01:36:33 +00:00			`A pseudo-terminal can be requested in all cases`
			`with the`
			`.B -r`
			`option.`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.PP`
ssh: implement -W option for making remote tcp connections 2019-04-02 07:03:35 +00:00			`With the`
			`.B -W`
			`option, instead of executing a command remotely, makes`
			`the server dial a tcp connection to`
			`.I remote!port`
			`which the client relays on standard input and output.`
ssh(1): add sshnet(4) reference 2019-04-02 16:46:00 +00:00			`For handling multiple connections transparently to`
			`programs, see`
			`.IR sshnet (4).`
ssh: implement -W option for making remote tcp connections 2019-04-02 07:03:35 +00:00			`.PP`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`The`
			`.B -d`
			`option enables debug output.`
ssh(1): add $home/lib/thumbfile to FILE section 2017-04-23 01:31:20 +00:00			`.SH FILES`
			`.TF $home/lib/sshthumbs`
			`.TP`
			`.B $home/lib/sshthumbs`
			`the user's thumbfile of known host fingerprints`
ssh(1): initial documentation, needs examples for authentication 2017-04-22 22:42:33 +00:00			`.SH SOURCE`
			`.B /sys/src/cmd/ssh.c`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`.SH BUGS`
			`If`
			`.I keyboard-interactive`
			`authentication fails, by default it is retried three times.`
			`The number of`
			`.I tries`
			`can be changed with`
			`.BR -T .`
			`Setting it to zero disables keyboard-interactive authentication.`
ssh(1): refer to thumbprint(6) for the sshthumbs file format 2017-04-24 00:21:43 +00:00			`.SH "SEE ALSO"`
ssh(1): add bugs section about host not being authenticated 2017-04-22 23:11:12 +00:00			`.IR vt (1),`
			`.IR rsa (8),`
ssh(1): refer to thumbprint(6) for the sshthumbs file format 2017-04-24 00:21:43 +00:00			`.IR thumbprint (6),`
ssh(1): document -T tries option, #subsys cmd behaviour 2017-05-03 18:56:20 +00:00			`.IR factotum (4),`
ssh(1): add sshnet(4) reference 2019-04-02 16:46:00 +00:00			`.IR sshfs (4),`
			`.IR sshnet (4)`