contrib/putty/DOC/MAN-PUTT.BUT

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