PuTTY

NAME

PuTTY - GUI SSH, Telnet and Rlogin client GUI  

SYNOPSIS

PuTTY [ options ] [ host ]

DESCRIPTION

PuTTY is a graphical SSH, Telnet and Rlogin client.

Please note:
This manual page describes the Unix/Linux port of the PuTTY command, therefore expect slight Unix/Linux specific differences to the Windows™ version.

See also putty.Help(1) and https://the.earth.li/~sgtatham/putty/latest/htmldoc/ for more information.

OPTIONS

-h

usage message.

-i

install the PuTTY command as 'PuTTY' to the Windows™ 'Desktop'.

-u

uninstall the PuTTY shortcut from the

-V

print program version.

The command-line options supported by PuTTY are:

-pgpfp

Display the fingerprints of the PuTTY PGP Master Keys, to aid in verifying new files released by the PuTTY team.

-load session

Load a saved session by name. This allows you to run a saved session straight from the command line without having to go through the configuration box first.

-ssh, -telnet, -rlogin, -raw, -serial

Select the protocol putty will use to make the connection.

-proxycmd command

Instead of making a TCP connection, use command as a proxy; network traffic will be redirected to the standard input and output of command. command must be a single word, so is likely to need quoting by the shell.

The special strings %host and %port in command will be replaced by the hostname and port number you want to connect to; to get a literal % sign, enter %%.

Backslash escapes are also supported, such as sequences like \n being replaced by a literal newline; to get a literal backslash, enter \\. (Further escaping may be required by the shell.)

(See the main PuTTY manual for full details of the supported %- and backslash-delimited tokens, although most of them are probably not very useful in this context.)

-l username

Specify the username to use when logging in to the server.

-L [srcaddr:]srcport:desthost:destport

Set up a local port forwarding: listen on srcport (or srcaddr:srcport if specified), and forward any connections over the SSH connection to the destination address desthost:destport. Only works in SSH.

-R [srcaddr:]srcport:desthost:destport

Set up a remote port forwarding: ask the SSH server to listen on srcport (or srcaddr:srcport if specified), and to forward any connections back over the SSH connection where the client will pass them on to the destination address desthost:destport. Only works in SSH.

-D [srcaddr:]srcport

Set up dynamic port forwarding. The client listens on srcport (or srcaddr:srcport if specified), and implements a SOCKS server. So you can point SOCKS-aware applications at this port and they will automatically use the SSH connection to tunnel all their connections. Only works in SSH.

-P port

Specify the port to connect to the server on.

-A, -a

Enable (-A) or disable (-a) SSH agent forwarding. Currently this only works with OpenSSH and SSH-1.

-X, -x

Enable (-X) or disable (-x) X11 forwarding.

-T, -t

Enable (-t) or disable (-T) the allocation of a pseudo-terminal at the server end.

-C

Enable zlib-style compression on the connection.

-1, -2

Select SSH protocol version 1 or 2.

-4, -6

Force use of IPv4 or IPv6 for network connections.

-i keyfile

Private key file for user authentication. For SSH-2 keys, this key file must be in PuTTY's PPK format, not OpenSSH's format or anyone else's.

If you are using an authentication agent, you can also specify a public key here (in RFC 4716 or OpenSSH format), to identify which of the agent's keys to use.

-noagent

Don't try to use an authentication agent for local authentication. (This doesn't affect agent forwarding.)

-agent

Allow use of an authentication agent. (This option is only necessary to override a setting in a saved session.)

-hostkey key

Specify an acceptable host public key. This option may be specified multiple times; each key can be either a fingerprint (99:aa:bb:...) or a base64-encoded blob in OpenSSH's one-line format.

Specifying this option overrides automated host key management; only the key(s) specified on the command-line will be accepted (unless a saved session also overrides host keys, in which case those will be added to), and the host key cache will not be written.

-sercfg configuration-string

Specify the configuration parameters for the serial port, in -serial mode. configuration-string should be a comma-separated list of configuration parameters as follows:

*

Any single digit from 5 to 9 sets the number of data bits.

*

`1', `1.5' or `2' sets the number of stop bits.

*

Any other numeric string is interpreted as a baud rate.

*

A single lower-case letter specifies the parity: `n' for none, `o' for odd, `e' for even, `m' for mark and `s' for space.

*

A single upper-case letter specifies the flow control: `N' for none, `X' for XON/XOFF, `R' for RTS/CTS and `D' for DSR/DTR.

SAVED SESSIONS

Saved sessions are stored in etc/PuTTY.cfg and a history of the last 31 changed configurations is saved in var/cache/putty/.

SEE ALSO

MORE INFORMATION

For more information on PuTTY, it's probably best to go and look at the manual on the web page:

https://www.chiark.greenend.org.uk/~sgtatham/putty/  

BUGS

This man page isn't terribly complete.

While using putty(1) and the caffeine(1) command is running without the -stes option the PuTTY session will receive disturbing control characters.

This is why PuTTY is asking to restart Caffeine with compatible options (-stes) if this condition is detected.