1 \cfg{man-identity}{putty}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}
3 \H{putty-manpage} Man page for PuTTY
5 \S{putty-manpage-name} NAME
7 \cw{putty} - GUI SSH, Telnet and Rlogin client for X
9 \S{putty-manpage-synopsis} SYNOPSIS
11 \c putty [ options ] [ host ]
14 \S{putty-manpage-description} DESCRIPTION
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.
19 \S{putty-manpage-options} OPTIONS
21 The command-line options supported by \cw{putty} are:
23 \dt \cw{\-\-display} \e{display\-name}
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.
30 \dt \cw{\-fn} \e{font-name}
32 \dd Specify the font to use for normal text displayed in the terminal.
34 \dt \cw{\-fb} \e{font-name}
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 and you do not specify a bold font, \cw{putty} will overprint the
41 normal font to make it look bolder.
43 \dt \cw{\-fw} \e{font-name}
45 \dd Specify the font to use for double-width characters (typically
46 Chinese, Japanese and Korean text) displayed in the terminal.
48 \dt \cw{\-fwb} \e{font-name}
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.
54 \dt \cw{\-geometry} \e{geometry}
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
60 \dt \cw{\-sl} \e{lines}
62 \dd Specify the number of lines of scrollback to save off the top of the
65 \dt \cw{\-fg} \e{colour}
67 \dd Specify the foreground colour to use for normal text.
69 \dt \cw{\-bg} \e{colour}
71 \dd Specify the background colour to use for normal text.
73 \dt \cw{\-bfg} \e{colour}
75 \dd Specify the foreground colour to use for bold text, if the
76 \cw{BoldAsColour} resource is set to 1 (the default).
78 \dt \cw{\-bbg} \e{colour}
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).
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.)
86 \dt \cw{\-cfg} \e{colour}
88 \dd Specify the foreground colour to use for text covered by the cursor.
90 \dt \cw{\-cbg} \e{colour}
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.
95 \dt \cw{\-title} \e{title}
97 \dd Specify the initial title of the terminal window. (This can be
98 changed under control of the server.)
100 \dt \cw{\-sb\-} or \cw{+sb}
102 \dd Tells \cw{putty} not to display a scroll bar.
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.
111 \dt \cw{\-log} \e{filename}
113 \dd This option makes \cw{putty} log all the terminal output to a file
114 as well as displaying it in the terminal.
117 \dt \cw{\-cs} \e{charset}
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.
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).
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.
135 Character set names are case-insensitive.
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
148 \dt \cw{\-help}, \cw{\-\-help}
150 \dd Display a message summarizing the available options.
152 \dt \cw{\-load} \e{session}
154 \dd Load a saved session by name. This allows you to run a saved session
155 straight from the command line without having to go through the
156 configuration box first.
158 \dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw}
160 \dd Select the protocol \cw{putty} will use to make the connection.
162 \dt \cw{\-l} \e{username}
164 \dd Specify the username to use when logging in to the server.
166 \dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
168 \dd Set up a local port forwarding: listen on \e{srcport} (or
169 \e{srcaddr}:\e{srcport} if specified), and forward any connections
170 over the SSH connection to the destination address
171 \e{desthost}:\e{destport}. Only works in SSH.
173 \dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport}
175 \dd Set up a remote port forwarding: ask the SSH server to listen on
176 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to
177 forward any connections back over the SSH connection where the
178 client will pass them on to the destination address
179 \e{desthost}:\e{destport}. Only works in SSH.
181 \dt \cw{\-D} [\e{srcaddr}:]\e{srcport}
183 \dd Set up dynamic port forwarding. The client listens on
184 \e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and
185 implements a SOCKS server. So you can point SOCKS-aware applications
186 at this port and they will automatically use the SSH connection to
187 tunnel all their connections. Only works in SSH.
189 \dt \cw{\-P} \e{port}
191 \dd Specify the port to connect to the server on.
193 \dt \cw{\-A}, \cw{\-a}
195 \dd Enable (\cw{\-A}) or disable (\cw{\-a}) SSH agent forwarding.
196 Currently this only works with OpenSSH and SSH-1.
198 \dt \cw{\-X}, \cw{\-x}
200 \dd Enable (\cw{\-X}) or disable (\cw{\-x}) X11 forwarding.
202 \dt \cw{\-T}, \cw{\-t}
204 \dd Enable (\cw{\-t}) or disable (\cw{\-T}) the allocation of a
205 pseudo-terminal at the server end.
209 \dd Enable zlib-style compression on the connection.
211 \dt \cw{\-1}, \cw{\-2}
213 \dd Select SSH protocol version 1 or 2.
215 \dt \cw{\-i} \e{keyfile}
217 \dd Specify a private key file to use for authentication. For SSH-2
218 keys, this key file must be in PuTTY's format, not OpenSSH's or
221 \S{putty-manpage-saved-sessions} SAVED SESSIONS
223 Saved sessions are stored in a \cw{.putty/sessions} subdirectory in
226 \S{putty-manpage-more-information} MORE INFORMATION
228 For more information on PuTTY, it's probably best to go and look at
229 the manual on the web page:
231 \W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/}
233 \S{putty-manpage-bugs} BUGS
235 This man page isn't terribly complete.