1 \cfg{man-identity}{plink}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
3 \H{plink-manpage} Man page for Plink
5 \S{plink-manpage-name} NAME
7 \cw{plink} \- PuTTY link, command line network connection tool
9 \S{plink-manpage-synopsis} SYNOPSIS
11 \c plink [options] [user@]host [command]
12 \e bbbbb iiiiiii iiiib iiii iiiiiii
14 \S{plink-manpage-description} DESCRIPTION
16 \cw{plink} is a network connection tool supporting several protocols.
18 \S{plink-manpage-options} OPTIONS
20 The command-line options supported by \cw{plink} are:
24 \dd Show version information and exit.
28 \dd Display the fingerprints of the PuTTY PGP Master Keys and exit,
29 to aid in verifying new files released by the PuTTY team.
33 \dd Show verbose messages.
35 \dt \cw{-load} \e{session}
37 \dd Load settings from saved session.
41 \dd Force use of SSH protocol (default).
45 \dd Force use of Telnet protocol.
49 \dd Force use of rlogin protocol.
57 \dd Force serial mode.
59 \dt \cw{\-proxycmd} \e{command}
61 \dd Instead of making a TCP connection, use \e{command} as a proxy;
62 network traffic will be redirected to the standard input and output
63 of \e{command}. \e{command} must be a single word, so is likely to
64 need quoting by the shell.
67 The special strings \cw{%host} and \cw{%port} in \e{command} will be
68 replaced by the hostname and port number you want to connect to; to get
69 a literal \c{%} sign, enter \c{%%}.
71 Backslash escapes are also supported, such as sequences like \c{\\n}
72 being replaced by a literal newline; to get a literal backslash,
73 enter \c{\\\\}. (Further escaping may be required by the shell.)
75 (See the main PuTTY manual for full details of the supported \cw{%}-
76 and backslash-delimited tokens, although most of them are probably not
77 very useful in this context.)
82 \dd Connect to port \e{port}.
86 \dd Set remote username to \e{user}.
90 \dd Read remote command(s) from local file \e{path}.
94 \dd Disable interactive prompts.
96 \dt \cw{-pw} \e{password}
98 \dd Set remote password to \e{password}. \e{CAUTION:} this will likely
99 make the password visible to other users of the local machine (via
100 commands such as \q{\c{w}}).
102 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
104 \dd Set up a local port forwarding: listen on \e{srcport} (or
105 \e{srcaddr}:\e{srcport} if specified), and forward any connections
106 over the SSH connection to the destination address
107 \e{desthost}:\e{destport}. Only works in SSH.
109 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
111 \dd Set up a remote port forwarding: ask the SSH server to listen on
112 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
113 forward any connections back over the SSH connection where the
114 client will pass them on to the destination address
115 \e{desthost}:\e{destport}. Only works in SSH.
117 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
119 \dd Set up dynamic port forwarding. The client listens on
120 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
121 implements a SOCKS server. So you can point SOCKS-aware applications
122 at this port and they will automatically use the SSH connection to
123 tunnel all their connections. Only works in SSH.
127 \dd Enable X11 forwarding.
131 \dd Disable X11 forwarding (default).
135 \dd Enable agent forwarding.
139 \dd Disable agent forwarding (default).
143 \dd Enable pty allocation (default if a command is NOT specified).
147 \dd Disable pty allocation (default if a command is specified).
151 \dd Force use of SSH protocol version 1.
155 \dd Force use of SSH protocol version 2.
159 \dd Force use of IPv4 or IPv6 for network connections.
163 \dd Enable SSH compression.
165 \dt \cw{-i} \e{keyfile}
167 \dd Private key file for user authentication. For SSH-2 keys, this key
168 file must be in PuTTY's PPK format, not OpenSSH's format or anyone
171 \lcont{ If you are using an authentication agent, you can also specify
172 a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
173 which of the agent's keys to use. }
177 \dd Don't try to use an authentication agent for local authentication.
178 (This doesn't affect agent forwarding.)
182 \dd Allow use of an authentication agent. (This option is only necessary
183 to override a setting in a saved session.)
185 \dt \cw{\-hostkey} \e{key}
187 \dd Specify an acceptable host public key. This option may be specified
188 multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
189 a base64-encoded blob in OpenSSH's one-line format.
191 \lcont{ Specifying this option overrides automated host key
192 management; \e{only} the key(s) specified on the command-line will be
193 accepted (unless a saved session also overrides host keys, in which
194 case those will be added to), and the host key cache will not be
199 \dd Remote command is SSH subsystem (SSH-2 only).
203 \dd Don't start a remote command or shell at all (SSH-2 only).
205 \dt \cw{\-nc} \e{host}:\e{port}
207 \dd Make a remote network connection from the server instead of
208 starting a shell or command.
210 \dt \cw{\-sercfg} \e{configuration-string}
212 \dd Specify the configuration parameters for the serial port, in
213 \cw{-serial} mode. \e{configuration-string} should be a
214 comma-separated list of configuration parameters as follows:
218 \b Any single digit from 5 to 9 sets the number of data bits.
220 \b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.
222 \b Any other numeric string is interpreted as a baud rate.
224 \b A single lower-case letter specifies the parity: \cq{n} for none,
225 \cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.
227 \b A single upper-case letter specifies the flow control: \cq{N} for
228 none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for
233 \dt \cw{\-sshlog} \e{logfile}
235 \dt \cw{\-sshrawlog} \e{logfile}
237 \dd For SSH connections, these options make \cw{plink} log protocol
238 details to a file. (Some of these may be sensitive, although by default
239 an effort is made to suppress obvious passwords.)
242 \cw{\-sshlog} logs decoded SSH packets and other events (those that
243 \cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
244 encrypted packet data.
247 \dt \cw{\-shareexists}
249 \dd Instead of making a new connection, test for the presence of an
250 existing connection that can be shared. The desired session can be
251 specified in any of the usual ways.
254 Returns immediately with a zero exit status if a suitable \q{upstream}
255 exists, nonzero otherwise.
258 \S{plink-manpage-more-information} MORE INFORMATION
260 For more information on plink, it's probably best to go and look at
261 the manual on the PuTTY web page:
263 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
265 \S{plink-manpage-bugs} BUGS
267 This man page isn't terribly complete. See the above web link for
268 better documentation.