1putty(1) PuTTY tool suite putty(1)
2
6 putty - GUI SSH, Telnet and Rlogin client for X
7
9 putty [ options ] [ host ]
10
12 putty is a graphical SSH, Telnet and Rlogin client for X. It is a
13 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.
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 and you do not specify a bold font, putty will overprint
33 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.
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).
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).
66 (This colour is best thought of as the bold version of the back‐
67 ground colour; so it only appears when text is displayed in the
68 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 filename
91 This option makes putty log all the terminal output to a file as
92 well as displaying it in the terminal.
93 -cs charset
95 This option specifies the character set in which putty should
96 assume the session is operating. This character set will be used
97 to interpret all the data received from the session, and all
98 input you type or paste into putty will be converted into this
99 character set before being sent to the session.
100 Any character set name which is valid in a MIME header (and sup‐
102 ported by putty) should be valid here (examples are
103 `ISO-8859-1', `windows-1252' or `UTF-8'). Also, any character
104 encoding which is valid in an X logical font description should
105 be valid (`ibm-cp437', for example).
106 putty's default behaviour is to use the same character encoding
108 as its primary font. If you supply a Unicode (iso10646-1) font,
109 it will default to the UTF-8 character set.
110 Character set names are case-insensitive.
112 -nethack
114 Tells putty to enable NetHack keypad mode, in which the numeric
115 keypad generates the NetHack hjklyubn direction keys. This
116 enables you to play NetHack with the numeric keypad without hav‐
117 ing to use the NetHack number_pad option (which requires you to
118 press `n' before any repeat count). So you can move with the
119 numeric keypad, and enter repeat counts with the normal number
120 keys.
121 -help, --help
123 Display a message summarizing the available options.
124 -pgpfp Display the fingerprints of the PuTTY PGP Master Keys, to aid in
126 verifying new files released by the PuTTY team.
127 -load session
129 Load a saved session by name. This allows you to run a saved
130 session straight from the command line without having to go
131 through the configuration box first.
132 -ssh, -telnet, -rlogin, -raw, -serial
134 Select the protocol putty will use to make the connection.
135 -l username
137 Specify the username to use when logging in to the server.
138 -L [srcaddr:]srcport:desthost:destport
140 Set up a local port forwarding: listen on srcport (or
141 srcaddr:srcport if specified), and forward any connections over
142 the SSH connection to the destination address desthost:destport.
143 Only works in SSH.
144 -R [srcaddr:]srcport:desthost:destport
146 Set up a remote port forwarding: ask the SSH server to listen on
147 srcport (or srcaddr:srcport if specified), and to forward any
148 connections back over the SSH connection where the client will
149 pass them on to the destination address desthost:destport. Only
150 works in SSH.
151 -D [srcaddr:]srcport
153 Set up dynamic port forwarding. The client listens on srcport
154 (or srcaddr:srcport if specified), and implements a SOCKS
155 server. So you can point SOCKS-aware applications at this port
156 and they will automatically use the SSH connection to tunnel all
157 their connections. Only works in SSH.
158 -P port
160 Specify the port to connect to the server on.
161 -A, -a Enable (-A) or disable (-a) SSH agent forwarding. Currently this
163 only works with OpenSSH and SSH-1.
164 -X, -x Enable (-X) or disable (-x) X11 forwarding.
166 -T, -t Enable (-t) or disable (-T) the allocation of a pseudo-terminal
168 at the server end.
169 -C Enable zlib-style compression on the connection.
171 -1, -2 Select SSH protocol version 1 or 2.
173 -i keyfile
175 Specify a private key file to use for authentication. For SSH-2
176 keys, this key file must be in PuTTY's format, not OpenSSH's or
177 anyone else's.
178 -sercfg configuration-string
180 Specify the configuration parameters for the serial port, in
181 -serial mode. configuration-string should be a comma-separated
182 list of configuration parameters as follows:
183 · Any single digit from 5 to 9 sets the number of data
185 bits.
186 · `1', `1.5' or `2' sets the number of stop bits.
188 · Any other numeric string is interpreted as a baud rate.
190 · A single lower-case letter specifies the parity: `n' for
192 none, `o' for odd, `e' for even, `m' for mark and `s' for
193 space.
194 · A single upper-case letter specifies the flow control:
196 `N' for none, `X' for XON/XOFF, `R' for RTS/CTS and `D'
197 for DSR/DTR.
198
200 Saved sessions are stored in a .putty/sessions subdirectory in your
201 home directory.
202
204 For more information on PuTTY, it's probably best to go and look at the
205 manual on the web page:
206 http://www.chiark.greenend.org.uk/~sgtatham/putty/
208
210 This man page isn't terribly complete.
211PuTTY tool suite 2004‐03‐24 putty(1)