doc/man-putt.but

   1 \cfg{man-identity}{putty}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
   2
   3 \H{putty-manpage} Man page for PuTTY
   4
   5 \S{putty-manpage-name} NAME
   6
   7 \cw{putty} - GUI SSH, Telnet and Rlogin client for X
   8
   9 \S{putty-manpage-synopsis} SYNOPSIS
  10
  11 \c putty [ options ] [ host ]
  12 \e bbbbb   iiiiiii     iiii
  13
  14 \S{putty-manpage-description} DESCRIPTION
  15
  16 \cw{putty} is a graphical SSH, Telnet and Rlogin client for X. It is
  17 a direct port of the Windows SSH client of the same name.
  18
  19 \S{putty-manpage-options} OPTIONS
  20
  21 The command-line options supported by \cw{putty} are:
  22
  23 \dt \cw{\-\-display} \e{display\-name}
  24
  25 \dd Specify the X display on which to open \cw{putty}. (Note this
  26 option has a double minus sign, even though none of the others do.
  27 This is because this option is supplied automatically by GTK.
  28 Sorry.)
  29
  30 \dt \cw{\-fn} \e{font-name}
  31
  32 \dd Specify the font to use for normal text displayed in the terminal.
  33 For example, \cw{\-fn\_fixed}, \cw{\-fn\_"Monospace\_12"}.
  34
  35 \dt \cw{\-fb} \e{font-name}
  36
  37 \dd Specify the font to use for bold text displayed in the terminal.
  38 If the \cw{BoldAsColour} resource is set to 1 (the default), bold
  39 text will be displayed in different colours instead of a different
  40 font, so this option will be ignored. If \cw{BoldAsColour} is set to
  41 0 or 2 and you do not specify a bold font, \cw{putty} will overprint the
  42 normal font to make it look bolder.
  43
  44 \dt \cw{\-fw} \e{font-name}
  45
  46 \dd Specify the font to use for double-width characters (typically
  47 Chinese, Japanese and Korean text) displayed in the terminal.
  48
  49 \dt \cw{\-fwb} \e{font-name}
  50
  51 \dd Specify the font to use for bold double-width characters
  52 (typically Chinese, Japanese and Korean text). Like \cw{-fb}, this
  53 will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
  54
  55 \dt \cw{\-geometry} \e{geometry}
  56
  57 \dd Specify the size of the terminal, in rows and columns of text.
  58 See \e{X(7)} for more information on the syntax of geometry
  59 specifications.
  60
  61 \dt \cw{\-sl} \e{lines}
  62
  63 \dd Specify the number of lines of scrollback to save off the top of the
  64 terminal.
  65
  66 \dt \cw{\-fg} \e{colour}
  67
  68 \dd Specify the foreground colour to use for normal text.
  69
  70 \dt \cw{\-bg} \e{colour}
  71
  72 \dd Specify the background colour to use for normal text.
  73
  74 \dt \cw{\-bfg} \e{colour}
  75
  76 \dd Specify the foreground colour to use for bold text, if the
  77 \cw{BoldAsColour} resource is set to 1 (the default) or 2.
  78
  79 \dt \cw{\-bbg} \e{colour}
  80
  81 \dd Specify the foreground colour to use for bold reverse-video
  82 text, if the \cw{BoldAsColour} resource is set to 1 (the default) or 2.
  83 (This colour is best thought of as the bold version of the
  84 background colour; so it only appears when text is displayed \e{in}
  85 the background colour.)
  86
  87 \dt \cw{\-cfg} \e{colour}
  88
  89 \dd Specify the foreground colour to use for text covered by the cursor.
  90
  91 \dt \cw{\-cbg} \e{colour}
  92
  93 \dd Specify the background colour to use for text covered by the cursor.
  94 In other words, this is the main colour of the cursor.
  95
  96 \dt \cw{\-title} \e{title}
  97
  98 \dd Specify the initial title of the terminal window. (This can be
  99 changed under control of the server.)
 100
 101 \dt \cw{\-sb\-} or \cw{+sb}
 102
 103 \dd Tells \cw{putty} not to display a scroll bar.
 104
 105 \dt \cw{\-sb}
 106
 107 \dd Tells \cw{putty} to display a scroll bar: this is the opposite of
 108 \cw{\-sb\-}. This is the default option: you will probably only need
 109 to specify it explicitly if you have changed the default using the
 110 \cw{ScrollBar} resource.
 111
 112 \dt \cw{\-log} \e{logfile}, \cw{\-sessionlog} \e{logfile}
 113
 114 \dd This option makes \cw{putty} log all the terminal output to a file
 115 as well as displaying it in the terminal.
 116
 117 \dt \cw{\-sshlog} \e{logfile}
 118
 119 \dt \cw{\-sshrawlog} \e{logfile}
 120
 121 \dd For SSH connections, these options make \cw{putty} log protocol
 122 details to a file. (Some of these may be sensitive, although by default
 123 an effort is made to suppress obvious passwords.)
 124
 125 \lcont{
 126 \cw{\-sshlog} logs decoded SSH packets and other events (those that
 127 \cw{\-v} would print). \cw{\-sshrawlog} additionally logs the raw
 128 encrypted packet data.
 129 }
 130
 131 \dt \cw{\-cs} \e{charset}
 132
 133 \dd This option specifies the character set in which \cw{putty}
 134 should assume the session is operating. This character set will be
 135 used to interpret all the data received from the session, and all
 136 input you type or paste into \cw{putty} will be converted into
 137 this character set before being sent to the session.
 138
 139 \lcont{ Any character set name which is valid in a MIME header (and
 140 supported by \cw{putty}) should be valid here (examples are
 141 \q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also,
 142 any character encoding which is valid in an X logical font
 143 description should be valid (\q{\cw{ibm-cp437}}, for example).
 144
 145 \cw{putty}'s default behaviour is to use the same character
 146 encoding as its primary font. If you supply a Unicode
 147 (\cw{iso10646-1}) font, it will default to the UTF-8 character set.
 148
 149 Character set names are case-insensitive.
 150 }
 151
 152 \dt \cw{\-nethack}
 153
 154 \dd Tells \cw{putty} to enable NetHack keypad mode, in which the
 155 numeric keypad generates the NetHack \c{hjklyubn} direction keys.
 156 This enables you to play NetHack with the numeric keypad without
 157 having to use the NetHack \c{number_pad} option (which requires you
 158 to press \q{\cw{n}} before any repeat count). So you can move with
 159 the numeric keypad, and enter repeat counts with the normal number
 160 keys.
 161
 162 \dt \cw{\-help}, \cw{\-\-help}
 163
 164 \dd Display a message summarizing the available options.
 165
 166 \dt \cw{\-pgpfp}
 167
 168 \dd Display the fingerprints of the PuTTY PGP Master Keys, to aid
 169 in verifying new files released by the PuTTY team.
 170
 171 \dt \cw{\-load} \e{session}
 172
 173 \dd Load a saved session by name. This allows you to run a saved session
 174 straight from the command line without having to go through the
 175 configuration box first.
 176
 177 \dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}, \cw{\-serial}
 178
 179 \dd Select the protocol \cw{putty} will use to make the connection.
 180
 181 \dt \cw{\-l} \e{username}
 182
 183 \dd Specify the username to use when logging in to the server.
 184
 185 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
 186
 187 \dd Set up a local port forwarding: listen on \e{srcport} (or
 188 \e{srcaddr}:\e{srcport} if specified), and forward any connections
 189 over the SSH connection to the destination address
 190 \e{desthost}:\e{destport}. Only works in SSH.
 191
 192 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
 193
 194 \dd Set up a remote port forwarding: ask the SSH server to listen on
 195 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
 196 forward any connections back over the SSH connection where the
 197 client will pass them on to the destination address
 198 \e{desthost}:\e{destport}. Only works in SSH.
 199
 200 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
 201
 202 \dd Set up dynamic port forwarding. The client listens on
 203 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
 204 implements a SOCKS server. So you can point SOCKS-aware applications
 205 at this port and they will automatically use the SSH connection to
 206 tunnel all their connections. Only works in SSH.
 207
 208 \dt \cw{\-P} \e{port}
 209
 210 \dd Specify the port to connect to the server on.
 211
 212 \dt \cw{\-A}, \cw{\-a}
 213
 214 \dd Enable (\cw{\-A}) or disable (\cw{\-a}) SSH agent forwarding.
 215 Currently this only works with OpenSSH and SSH-1.
 216
 217 \dt \cw{\-X}, \cw{\-x}
 218
 219 \dd Enable (\cw{\-X}) or disable (\cw{\-x}) X11 forwarding.
 220
 221 \dt \cw{\-T}, \cw{\-t}
 222
 223 \dd Enable (\cw{\-t}) or disable (\cw{\-T}) the allocation of a
 224 pseudo-terminal at the server end.
 225
 226 \dt \cw{\-C}
 227
 228 \dd Enable zlib-style compression on the connection.
 229
 230 \dt \cw{\-1}, \cw{\-2}
 231
 232 \dd Select SSH protocol version 1 or 2.
 233
 234 \dt \cw{-4}, \cw{-6}
 235
 236 \dd Force use of IPv4 or IPv6 for network connections.
 237
 238 \dt \cw{\-i} \e{keyfile}
 239
 240 \dd Private key file for user authentication. For SSH-2 keys, this key
 241 file must be in PuTTY's PPK format, not OpenSSH's format or anyone
 242 else's.
 243
 244 \lcont{ If you are using an authentication agent, you can also specify
 245 a \e{public} key here (in RFC 4716 or OpenSSH format), to identify
 246 which of the agent's keys to use. }
 247
 248 \dt \cw{\-noagent}
 249
 250 \dd Don't try to use an authentication agent for local authentication.
 251 (This doesn't affect agent forwarding.)
 252
 253 \dt \cw{\-agent}
 254
 255 \dd Allow use of an authentication agent. (This option is only necessary
 256 to override a setting in a saved session.)
 257
 258 \dt \cw{\-hostkey} \e{key}
 259
 260 \dd Specify an acceptable host public key. This option may be specified
 261 multiple times; each key can be either a fingerprint (\cw{99:aa:bb:...}) or
 262 a base64-encoded blob in OpenSSH's one-line format.
 263
 264 \lcont{ Specifying this option overrides automated host key
 265 management; \e{only} the key(s) specified on the command-line will be
 266 accepted (unless a saved session also overrides host keys, in which
 267 case those will be added to), and the host key cache will not be
 268 written. }
 269
 270 \dt \cw{\-sercfg} \e{configuration-string}
 271
 272 \dd Specify the configuration parameters for the serial port, in
 273 \cw{-serial} mode. \e{configuration-string} should be a
 274 comma-separated list of configuration parameters as follows:
 275
 276 \lcont{
 277
 278 \b Any single digit from 5 to 9 sets the number of data bits.
 279
 280 \b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.
 281
 282 \b Any other numeric string is interpreted as a baud rate.
 283
 284 \b A single lower-case letter specifies the parity: \cq{n} for none,
 285 \cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.
 286
 287 \b A single upper-case letter specifies the flow control: \cq{N} for
 288 none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for
 289 DSR/DTR.
 290
 291 }
 292
 293 \S{putty-manpage-saved-sessions} SAVED SESSIONS
 294
 295 Saved sessions are stored in a \cw{.putty/sessions} subdirectory in
 296 your home directory.
 297
 298 \S{putty-manpage-more-information} MORE INFORMATION
 299
 300 For more information on PuTTY, it's probably best to go and look at
 301 the manual on the web page:
 302
 303 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
 304
 305 \S{putty-manpage-bugs} BUGS
 306
 307 This man page isn't terribly complete.