doc/man-pl.but

   1 \cfg{man-identity}{plink}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
   2
   3 \H{plink-manpage} Man page for Plink
   4
   5 \S{plink-manpage-name} NAME
   6
   7 \cw{plink} \- PuTTY link, command line network connection tool
   8
   9 \S{plink-manpage-synopsis} SYNOPSIS
  10
  11 \c plink [options] [user@]host [command]
  12 \e bbbbb  iiiiiii   iiiib iiii  iiiiiii
  13
  14 \S{plink-manpage-description} DESCRIPTION
  15
  16 \cw{plink} is a network connection tool supporting several protocols.
  17
  18 \S{plink-manpage-options} OPTIONS
  19
  20 The command-line options supported by \cw{plink} are:
  21
  22 \dt \cw{-V}
  23
  24 \dd Show version information and exit.
  25
  26 \dt \cw{-pgpfp}
  27
  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.
  30
  31 \dt \cw{-v}
  32
  33 \dd Show verbose messages.
  34
  35 \dt \cw{-load} \e{session}
  36
  37 \dd Load settings from saved session.
  38
  39 \dt \cw{-ssh}
  40
  41 \dd Force use of SSH protocol (default).
  42
  43 \dt \cw{-telnet}
  44
  45 \dd Force use of Telnet protocol.
  46
  47 \dt \cw{-rlogin}
  48
  49 \dd Force use of rlogin protocol.
  50
  51 \dt \cw{-raw}
  52
  53 \dd Force raw mode.
  54
  55 \dt \cw{-serial}
  56
  57 \dd Force serial mode.
  58
  59 \dt \cw{-P} \e{port}
  60
  61 \dd Connect to port \e{port}.
  62
  63 \dt \cw{-l} \e{user}
  64
  65 \dd Set remote username to \e{user}.
  66
  67 \dt \cw{-m} \e{path}
  68
  69 \dd Read remote command(s) from local file \e{path}.
  70
  71 \dt \cw{-batch}
  72
  73 \dd Disable interactive prompts.
  74
  75 \dt \cw{-pw} \e{password}
  76
  77 \dd Set remote password to \e{password}. \e{CAUTION:} this will likely
  78 make the password visible to other users of the local machine (via
  79 commands such as \q{\c{w}}).
  80
  81 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
  82
  83 \dd Set up a local port forwarding: listen on \e{srcport} (or
  84 \e{srcaddr}:\e{srcport} if specified), and forward any connections
  85 over the SSH connection to the destination address
  86 \e{desthost}:\e{destport}. Only works in SSH.
  87
  88 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
  89
  90 \dd Set up a remote port forwarding: ask the SSH server to listen on
  91 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
  92 forward any connections back over the SSH connection where the
  93 client will pass them on to the destination address
  94 \e{desthost}:\e{destport}. Only works in SSH.
  95
  96 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
  97
  98 \dd Set up dynamic port forwarding. The client listens on
  99 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
 100 implements a SOCKS server. So you can point SOCKS-aware applications
 101 at this port and they will automatically use the SSH connection to
 102 tunnel all their connections. Only works in SSH.
 103
 104 \dt \cw{-X}
 105
 106 \dd Enable X11 forwarding.
 107
 108 \dt \cw{-x}
 109
 110 \dd Disable X11 forwarding (default).
 111
 112 \dt \cw{-A}
 113
 114 \dd Enable agent forwarding.
 115
 116 \dt \cw{-a}
 117
 118 \dd Disable agent forwarding (default).
 119
 120 \dt \cw{-t}
 121
 122 \dd Enable pty allocation (default if a command is NOT specified).
 123
 124 \dt \cw{-T}
 125
 126 \dd Disable pty allocation (default if a command is specified).
 127
 128 \dt \cw{-1}
 129
 130 \dd Force use of SSH protocol version 1.
 131
 132 \dt \cw{-2}
 133
 134 \dd Force use of SSH protocol version 2.
 135
 136 \dt \cw{-4}, \cw{-6}
 137
 138 \dd Force use of IPv4 or IPv6 for network connections.
 139
 140 \dt \cw{-C}
 141
 142 \dd Enable SSH compression.
 143
 144 \dt \cw{-i} \e{keyfile}
 145
 146 \dd Private key file for user authentication. For SSH-2 keys, this key
 147 file must be in PuTTY's PPK format, not OpenSSH's format or anyone
 148 else's.
 149
 150 \lcont{ If you are using an authentication agent, you can also specify
 151 a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
 152 which of the agent's keys to use. }
 153
 154 \dt \cw{\-noagent}
 155
 156 \dd Don't try to use an authentication agent for local authentication.
 157 (This doesn't affect agent forwarding.)
 158
 159 \dt \cw{\-agent}
 160
 161 \dd Allow use of an authentication agent. (This option is only necessary
 162 to override a setting in a saved session.)
 163
 164 \dt \cw{\-hostkey} \e{key}
 165
 166 \dd Specify an acceptable host public key. This option may be specified
 167 multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
 168 a base64-encoded blob in OpenSSH's one-line format.
 169
 170 \lcont{ Specifying this option overrides automated host key
 171 management; \e{only} the key(s) specified on the command-line will be
 172 accepted (unless a saved session also overrides host keys, in which
 173 case those will be added to), and the host key cache will not be
 174 written. }
 175
 176 \dt \cw{-s}
 177
 178 \dd Remote command is SSH subsystem (SSH-2 only).
 179
 180 \dt \cw{-N}
 181
 182 \dd Don't start a remote command or shell at all (SSH-2 only).
 183
 184 \dt \cw{\-nc} \e{host}:\e{port}
 185
 186 \dd Make a remote network connection from the server instead of
 187 starting a shell or command.
 188
 189 \dt \cw{\-sercfg} \e{configuration-string}
 190
 191 \dd Specify the configuration parameters for the serial port, in
 192 \cw{-serial} mode. \e{configuration-string} should be a
 193 comma-separated list of configuration parameters as follows:
 194
 195 \lcont{
 196
 197 \b Any single digit from 5 to 9 sets the number of data bits.
 198
 199 \b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.
 200
 201 \b Any other numeric string is interpreted as a baud rate.
 202
 203 \b A single lower-case letter specifies the parity: \cq{n} for none,
 204 \cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.
 205
 206 \b A single upper-case letter specifies the flow control: \cq{N} for
 207 none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for
 208 DSR/DTR.
 209
 210 }
 211
 212 \dt \cw{\-sshlog} \e{logfile}
 213
 214 \dt \cw{\-sshrawlog} \e{logfile}
 215
 216 \dd For SSH connections, these options make \cw{plink} log protocol
 217 details to a file. (Some of these may be sensitive, although by default
 218 an effort is made to suppress obvious passwords.)
 219
 220 \lcont{
 221 \cw{\-sshlog} logs decoded SSH packets and other events (those that
 222 \cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
 223 encrypted packet data.
 224 }
 225
 226 \dt \cw{\-shareexists}
 227
 228 \dd Instead of making a new connection, test for the presence of an
 229 existing connection that can be shared. The desired session can be
 230 specified in any of the usual ways.
 231
 232 \lcont{
 233 Returns immediately with a zero exit status if a suitable \q{upstream}
 234 exists, nonzero otherwise.
 235 }
 236
 237 \S{plink-manpage-more-information} MORE INFORMATION
 238
 239 For more information on plink, it's probably best to go and look at
 240 the manual on the PuTTY web page:
 241
 242 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
 243
 244 \S{plink-manpage-bugs} BUGS
 245
 246 This man page isn't terribly complete. See the above web link for
 247 better documentation.