1putty(1) PuTTY tool suite putty(1)
2
6 putty - GUI SSH, Telnet, Rlogin, and SUPDUP client for X
7
9 putty [ options ] [ host ]
10
12 putty is a graphical SSH, Telnet, Rlogin, and SUPDUP client for X. It
13 is a direct port of the Windows SSH client of the same name.
14
16 The command-line options supported by putty are:
17 --display display-name
19 Specify the X display on which to open putty. (Note this option
20 has a double minus sign, even though none of the others do. This
21 is because this option is supplied automatically by GTK. Sorry.)
22 -fn font-name
24 Specify the font to use for normal text displayed in the termi‐
25 nal. For example, -fn fixed, -fn "Monospace 12".
26 -fb font-name
28 Specify the font to use for bold text displayed in the terminal.
29 If the BoldAsColour resource is set to 1 (the default), bold
30 text will be displayed in different colours instead of a differ‐
31 ent font, so this option will be ignored. If BoldAsColour is set
32 to 0 or 2 and you do not specify a bold font, putty will over‐
33 print the normal font to make it look bolder.
34 -fw font-name
36 Specify the font to use for double-width characters (typically
37 Chinese, Japanese and Korean text) displayed in the terminal.
38 -fwb font-name
40 Specify the font to use for bold double-width characters (typi‐
41 cally Chinese, Japanese and Korean text). Like -fb, this will be
42 ignored unless the BoldAsColour resource is set to 0 or 2.
43 -geometry geometry
45 Specify the size of the terminal, in rows and columns of text.
46 See X(7) for more information on the syntax of geometry specifi‐
47 cations.
48 -sl lines
50 Specify the number of lines of scrollback to save off the top of
51 the terminal.
52 -fg colour
54 Specify the foreground colour to use for normal text.
55 -bg colour
57 Specify the background colour to use for normal text.
58 -bfg colour
60 Specify the foreground colour to use for bold text, if the
61 BoldAsColour resource is set to 1 (the default) or 2.
62 -bbg colour
64 Specify the foreground colour to use for bold reverse-video
65 text, if the BoldAsColour resource is set to 1 (the default) or
66 2. (This colour is best thought of as the bold version of the
67 background colour; so it only appears when text is displayed in
68 the background colour.)
69 -cfg colour
71 Specify the foreground colour to use for text covered by the
72 cursor.
73 -cbg colour
75 Specify the background colour to use for text covered by the
76 cursor. In other words, this is the main colour of the cursor.
77 -title title
79 Specify the initial title of the terminal window. (This can be
80 changed under control of the server.)
81 -sb- or +sb
83 Tells putty not to display a scroll bar.
84 -sb Tells putty to display a scroll bar: this is the opposite of
86 -sb-. This is the default option: you will probably only need to
87 specify it explicitly if you have changed the default using the
88 ScrollBar resource.
89 -log logfile, -sessionlog logfile
91 This option makes putty log all the terminal output to a file as
92 well as displaying it in the terminal.
93 -sshlog logfile
95 -sshrawlog logfile
98 For SSH connections, these options make putty log protocol de‐
99 tails to a file. (Some of these may be sensitive, although by
100 default an effort is made to suppress obvious passwords.)
101 -sshlog logs decoded SSH packets and other events (those that -v
103 would print). -sshrawlog additionally logs the raw encrypted
104 packet data.
105 -logoverwrite
107 If putty is configured to write to a log file that already ex‐
108 ists, discard the existing file.
109 -logappend
111 If putty is configured to write to a log file that already ex‐
112 ists, append new log data to the existing file.
113 -cs charset
115 This option specifies the character set in which putty should
116 assume the session is operating. This character set will be used
117 to interpret all the data received from the session, and all in‐
118 put you type or paste into putty will be converted into this
119 character set before being sent to the session.
120 Any character set name which is valid in a MIME header (and sup‐
122 ported by putty) should be valid here (examples are
123 `ISO-8859-1', `windows-1252' or `UTF-8'). Also, any character
124 encoding which is valid in an X logical font description should
125 be valid (`ibm-cp437', for example).
126 putty's default behaviour is to use the same character encoding
128 as its primary font. If you supply a Unicode (iso10646-1) font,
129 it will default to the UTF-8 character set.
130 Character set names are case-insensitive.
132 -nethack
134 Tells putty to enable NetHack keypad mode, in which the numeric
135 keypad generates the NetHack hjklyubn direction keys. This en‐
136 ables you to play NetHack with the numeric keypad without having
137 to use the NetHack number_pad option (which requires you to
138 press `n' before any repeat count). So you can move with the nu‐
139 meric keypad, and enter repeat counts with the normal number
140 keys.
141 -help, --help
143 Display a message summarizing the available options.
144 -pgpfp Display the fingerprints of the PuTTY PGP Master Keys, to aid in
146 verifying new files released by the PuTTY team.
147 -load session
149 Load a saved session by name. This allows you to run a saved
150 session straight from the command line without having to go
151 through the configuration box first.
152 -ssh, -telnet, -rlogin, -supdup, -raw, -ssh-connection, -serial
154 Select the protocol putty will use to make the connection.
155 -proxycmd command
157 Instead of making a TCP connection, use command as a proxy; net‐
158 work traffic will be redirected to the standard input and output
159 of command. command must be a single word, so is likely to need
160 quoting by the shell.
161 The special strings %host and %port in command will be replaced
163 by the hostname and port number you want to connect to; to get a
164 literal % sign, enter %%.
165 Backslash escapes are also supported, such as sequences like \n
167 being replaced by a literal newline; to get a literal backslash,
168 enter \\. (Further escaping may be required by the shell.)
169 (See the main PuTTY manual for full details of the supported %-
171 and backslash-delimited tokens, although most of them are proba‐
172 bly not very useful in this context.)
173 -l username
175 Specify the username to use when logging in to the server.
176 -L [srcaddr:]srcport:desthost:destport
178 Set up a local port forwarding: listen on srcport (or sr‐
179 caddr:srcport if specified), and forward any connections over
180 the SSH connection to the destination address desthost:destport.
181 Only works in SSH.
182 -R [srcaddr:]srcport:desthost:destport
184 Set up a remote port forwarding: ask the SSH server to listen on
185 srcport (or srcaddr:srcport if specified), and to forward any
186 connections back over the SSH connection where the client will
187 pass them on to the destination address desthost:destport. Only
188 works in SSH.
189 -D [srcaddr:]srcport
191 Set up dynamic port forwarding. The client listens on srcport
192 (or srcaddr:srcport if specified), and implements a SOCKS
193 server. So you can point SOCKS-aware applications at this port
194 and they will automatically use the SSH connection to tunnel all
195 their connections. Only works in SSH.
196 -P port
198 Specify the port to connect to the server on.
199 -A, -a Enable (-A) or disable (-a) SSH agent forwarding. Currently this
201 only works with OpenSSH and SSH-1.
202 -X, -x Enable (-X) or disable (-x) X11 forwarding.
204 -T, -t Enable (-t) or disable (-T) the allocation of a pseudo-terminal
206 at the server end.
207 -C Enable zlib-style compression on the connection.
209 -1, -2 Select SSH protocol version 1 or 2.
211 -4, -6 Force use of IPv4 or IPv6 for network connections.
213 -i keyfile
215 Private key file for user authentication. For SSH-2 keys, this
216 key file must be in PuTTY's PPK format, not OpenSSH's format or
217 anyone else's.
218 If you are using an authentication agent, you can also specify a
220 public key here (in RFC 4716 or OpenSSH format), to identify
221 which of the agent's keys to use.
222 -noagent
224 Don't try to use an authentication agent for local authentica‐
225 tion. (This doesn't affect agent forwarding.)
226 -agent Allow use of an authentication agent. (This option is only nec‐
228 essary to override a setting in a saved session.)
229 -hostkey key
231 Specify an acceptable host public key. This option may be speci‐
232 fied multiple times; each key can be either a fingerprint
233 (SHA256:AbCdE..., 99:aa:bb:..., etc) or a base64-encoded blob in
234 OpenSSH's one-line format.
235 Specifying this option overrides automated host key management;
237 only the key(s) specified on the command-line will be accepted
238 (unless a saved session also overrides host keys, in which case
239 those will be added to), and the host key cache will not be
240 written.
241 -sercfg configuration-string
243 Specify the configuration parameters for the serial port, in
244 -serial mode. configuration-string should be a comma-separated
245 list of configuration parameters as follows:
246 • Any single digit from 5 to 9 sets the number of data
248 bits.
249 • `1', `1.5' or `2' sets the number of stop bits.
251 • Any other numeric string is interpreted as a baud rate.
253 • A single lower-case letter specifies the parity: `n' for
255 none, `o' for odd, `e' for even, `m' for mark and `s' for
256 space.
257 • A single upper-case letter specifies the flow control:
259 `N' for none, `X' for XON/XOFF, `R' for RTS/CTS and `D'
260 for DSR/DTR.
261
263 Saved sessions are stored in a .putty/sessions subdirectory in your
264 home directory.
265
267 For more information on PuTTY, it's probably best to go and look at the
268 manual on the web page:
269 https://www.chiark.greenend.org.uk/~sgtatham/putty/
271
273 This man page isn't terribly complete.
274PuTTY tool suite 2004‐03‐24 putty(1)