git.distorted.org.uk Git - u/mdw/putty/blob - 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
  34 \dt \cw{\-fb} \e{font-name}
  35
  36 \dd Specify the font to use for bold text displayed in the terminal.
  37 If the \cw{BoldAsColour} resource is set to 1 (the default), bold
  38 text will be displayed in different colours instead of a different
  39 font, so this option will be ignored. If \cw{BoldAsColour} is set to
  40 0 or 2 and you do not specify a bold font, \cw{putty} will overprint the
  41 normal font to make it look bolder.
  42
  43 \dt \cw{\-fw} \e{font-name}
  44
  45 \dd Specify the font to use for double-width characters (typically
  46 Chinese, Japanese and Korean text) displayed in the terminal.
  47
  48 \dt \cw{\-fwb} \e{font-name}
  49
  50 \dd Specify the font to use for bold double-width characters
  51 (typically Chinese, Japanese and Korean text). Like \cw{-fb}, this
  52 will be ignored unless the \cw{BoldAsColour} resource is set to 0 or 2.
  53
  54 \dt \cw{\-geometry} \e{geometry}
  55
  56 \dd Specify the size of the terminal, in rows and columns of text.
  57 See \e{X(7)} for more information on the syntax of geometry
  58 specifications.
  59
  60 \dt \cw{\-sl} \e{lines}
  61
  62 \dd Specify the number of lines of scrollback to save off the top of the
  63 terminal.
  64
  65 \dt \cw{\-fg} \e{colour}
  66
  67 \dd Specify the foreground colour to use for normal text.
  68
  69 \dt \cw{\-bg} \e{colour}
  70
  71 \dd Specify the background colour to use for normal text.
  72
  73 \dt \cw{\-bfg} \e{colour}
  74
  75 \dd Specify the foreground colour to use for bold text, if the
  76 \cw{BoldAsColour} resource is set to 1 (the default) or 2.
  77
  78 \dt \cw{\-bbg} \e{colour}
  79
  80 \dd Specify the foreground colour to use for bold reverse-video
  81 text, if the \cw{BoldAsColour} resource is set to 1 (the default) or 2.
  82 (This colour is best thought of as the bold version of the
  83 background colour; so it only appears when text is displayed \e{in}
  84 the background colour.)
  85
  86 \dt \cw{\-cfg} \e{colour}
  87
  88 \dd Specify the foreground colour to use for text covered by the cursor.
  89
  90 \dt \cw{\-cbg} \e{colour}
  91
  92 \dd Specify the background colour to use for text covered by the cursor.
  93 In other words, this is the main colour of the cursor.
  94
  95 \dt \cw{\-title} \e{title}
  96
  97 \dd Specify the initial title of the terminal window. (This can be
  98 changed under control of the server.)
  99
 100 \dt \cw{\-sb\-} or \cw{+sb}
 101
 102 \dd Tells \cw{putty} not to display a scroll bar.
 103
 104 \dt \cw{\-sb}
 105
 106 \dd Tells \cw{putty} to display a scroll bar: this is the opposite of
 107 \cw{\-sb\-}. This is the default option: you will probably only need
 108 to specify it explicitly if you have changed the default using the
 109 \cw{ScrollBar} resource.
 110
 111 \dt \cw{\-log} \e{filename}
 112
 113 \dd This option makes \cw{putty} log all the terminal output to a file
 114 as well as displaying it in the terminal.
 115
 116
 117 \dt \cw{\-cs} \e{charset}
 118
 119 \dd This option specifies the character set in which \cw{putty}
 120 should assume the session is operating. This character set will be
 121 used to interpret all the data received from the session, and all
 122 input you type or paste into \cw{putty} will be converted into
 123 this character set before being sent to the session.
 124
 125 \lcont{ Any character set name which is valid in a MIME header (and
 126 supported by \cw{putty}) should be valid here (examples are
 127 \q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also,
 128 any character encoding which is valid in an X logical font
 129 description should be valid (\q{\cw{ibm-cp437}}, for example).
 130
 131 \cw{putty}'s default behaviour is to use the same character
 132 encoding as its primary font. If you supply a Unicode
 133 (\cw{iso10646-1}) font, it will default to the UTF-8 character set.
 134
 135 Character set names are case-insensitive.
 136 }
 137
 138 \dt \cw{\-nethack}
 139
 140 \dd Tells \cw{putty} to enable NetHack keypad mode, in which the
 141 numeric keypad generates the NetHack \c{hjklyubn} direction keys.
 142 This enables you to play NetHack with the numeric keypad without
 143 having to use the NetHack \c{number_pad} option (which requires you
 144 to press \q{\cw{n}} before any repeat count). So you can move with
 145 the numeric keypad, and enter repeat counts with the normal number
 146 keys.
 147
 148 \dt \cw{\-help}, \cw{\-\-help}
 149
 150 \dd Display a message summarizing the available options.
 151
 152 \dt \cw{\-pgpfp}
 153
 154 \dd Display the fingerprints of the PuTTY PGP Master Keys, to aid
 155 in verifying new files released by the PuTTY team.
 156
 157 \dt \cw{\-load} \e{session}
 158
 159 \dd Load a saved session by name. This allows you to run a saved session
 160 straight from the command line without having to go through the
 161 configuration box first.
 162
 163 \dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}, \cw{\-serial}
 164
 165 \dd Select the protocol \cw{putty} will use to make the connection.
 166
 167 \dt \cw{\-l} \e{username}
 168
 169 \dd Specify the username to use when logging in to the server.
 170
 171 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
 172
 173 \dd Set up a local port forwarding: listen on \e{srcport} (or
 174 \e{srcaddr}:\e{srcport} if specified), and forward any connections
 175 over the SSH connection to the destination address
 176 \e{desthost}:\e{destport}. Only works in SSH.
 177
 178 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
 179
 180 \dd Set up a remote port forwarding: ask the SSH server to listen on
 181 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
 182 forward any connections back over the SSH connection where the
 183 client will pass them on to the destination address
 184 \e{desthost}:\e{destport}. Only works in SSH.
 185
 186 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
 187
 188 \dd Set up dynamic port forwarding. The client listens on
 189 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
 190 implements a SOCKS server. So you can point SOCKS-aware applications
 191 at this port and they will automatically use the SSH connection to
 192 tunnel all their connections. Only works in SSH.
 193
 194 \dt \cw{\-P} \e{port}
 195
 196 \dd Specify the port to connect to the server on.
 197
 198 \dt \cw{\-A}, \cw{\-a}
 199
 200 \dd Enable (\cw{\-A}) or disable (\cw{\-a}) SSH agent forwarding.
 201 Currently this only works with OpenSSH and SSH-1.
 202
 203 \dt \cw{\-X}, \cw{\-x}
 204
 205 \dd Enable (\cw{\-X}) or disable (\cw{\-x}) X11 forwarding.
 206
 207 \dt \cw{\-T}, \cw{\-t}
 208
 209 \dd Enable (\cw{\-t}) or disable (\cw{\-T}) the allocation of a
 210 pseudo-terminal at the server end.
 211
 212 \dt \cw{\-C}
 213
 214 \dd Enable zlib-style compression on the connection.
 215
 216 \dt \cw{\-1}, \cw{\-2}
 217
 218 \dd Select SSH protocol version 1 or 2.
 219
 220 \dt \cw{\-i} \e{keyfile}
 221
 222 \dd Specify a private key file to use for authentication. For SSH-2
 223 keys, this key file must be in PuTTY's format, not OpenSSH's or
 224 anyone else's.
 225
 226 \dt \cw{\-sercfg} \e{configuration-string}
 227
 228 \dd Specify the configuration parameters for the serial port, in
 229 \cw{-serial} mode. \e{configuration-string} should be a
 230 comma-separated list of configuration parameters as follows:
 231
 232 \lcont{
 233
 234 \b Any single digit from 5 to 9 sets the number of data bits.
 235
 236 \b \cq{1}, \cq{1.5} or \cq{2} sets the number of stop bits.
 237
 238 \b Any other numeric string is interpreted as a baud rate.
 239
 240 \b A single lower-case letter specifies the parity: \cq{n} for none,
 241 \cq{o} for odd, \cq{e} for even, \cq{m} for mark and \cq{s} for space.
 242
 243 \b A single upper-case letter specifies the flow control: \cq{N} for
 244 none, \cq{X} for XON/XOFF, \cq{R} for RTS/CTS and \cq{D} for
 245 DSR/DTR.
 246
 247 }
 248
 249 \S{putty-manpage-saved-sessions} SAVED SESSIONS
 250
 251 Saved sessions are stored in a \cw{.putty/sessions} subdirectory in
 252 your home directory.
 253
 254 \S{putty-manpage-more-information} MORE INFORMATION
 255
 256 For more information on PuTTY, it's probably best to go and look at
 257 the manual on the web page:
 258
 259 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
 260
 261 \S{putty-manpage-bugs} BUGS
 262
 263 This man page isn't terribly complete.