1putty(1)                       PuTTY tool suite                       putty(1)
2
3
4

NAME

6       putty - GUI SSH, Telnet and Rlogin client for X
7

SYNOPSIS

9       putty [ options ] [ host ]
10

DESCRIPTION

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

OPTIONS

16       The command-line options supported by putty are:
17
18       --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
23       -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
27       -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
35       -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
39       -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
44       -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
49       -sl lines
50              Specify the number of lines of scrollback to save off the top of
51              the terminal.
52
53       -fg colour
54              Specify the foreground colour to use for normal text.
55
56       -bg colour
57              Specify the background colour to use for normal text.
58
59       -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
63       -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
70       -cfg colour
71              Specify  the  foreground  colour  to use for text covered by the
72              cursor.
73
74       -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
78       -title title
79              Specify  the  initial title of the terminal window. (This can be
80              changed under control of the server.)
81
82       -sb- or +sb
83              Tells putty not to display a scroll bar.
84
85       -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
90       -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
94       -sshlog logfile
95
96
97       -sshrawlog logfile
98              For SSH connections,  these  options  make  putty  log  protocol
99              details  to a file. (Some of these may be sensitive, although by
100              default an effort is made to suppress obvious passwords.)
101
102              -sshlog logs decoded SSH packets and other events (those that -v
103              would  print).  -sshrawlog  additionally  logs the raw encrypted
104              packet data.
105
106       -cs charset
107              This option specifies the character set in  which  putty  should
108              assume the session is operating. This character set will be used
109              to interpret all the data received from  the  session,  and  all
110              input  you  type or paste into putty will be converted into this
111              character set before being sent to the session.
112
113              Any character set name which is valid in a MIME header (and sup‐
114              ported   by   putty)   should   be   valid  here  (examples  are
115              `ISO-8859-1', `windows-1252' or `UTF-8').  Also,  any  character
116              encoding  which is valid in an X logical font description should
117              be valid (`ibm-cp437', for example).
118
119              putty's default behaviour is to use the same character  encoding
120              as  its primary font. If you supply a Unicode (iso10646-1) font,
121              it will default to the UTF-8 character set.
122
123              Character set names are case-insensitive.
124
125       -nethack
126              Tells putty to enable NetHack keypad mode, in which the  numeric
127              keypad  generates  the  NetHack  hjklyubn  direction  keys. This
128              enables you to play NetHack with the numeric keypad without hav‐
129              ing  to use the NetHack number_pad option (which requires you to
130              press `n' before any repeat count). So you  can  move  with  the
131              numeric  keypad,  and enter repeat counts with the normal number
132              keys.
133
134       -help, --help
135              Display a message summarizing the available options.
136
137       -pgpfp Display the fingerprints of the PuTTY PGP Master Keys, to aid in
138              verifying new files released by the PuTTY team.
139
140       -load session
141              Load  a  saved  session  by name. This allows you to run a saved
142              session straight from the command  line  without  having  to  go
143              through the configuration box first.
144
145       -ssh, -telnet, -rlogin, -raw, -serial
146              Select the protocol putty will use to make the connection.
147
148       -proxycmd command
149              Instead of making a TCP connection, use command as a proxy; net‐
150              work traffic will be redirected to the standard input and output
151              of  command. command must be a single word, so is likely to need
152              quoting by the shell.
153
154              The special strings %host and %port in command will be  replaced
155              by the hostname and port number you want to connect to; to get a
156              literal % sign, enter %%.
157
158              Backslash escapes are also supported, such as sequences like  \n
159              being replaced by a literal newline; to get a literal backslash,
160              enter \\. (Further escaping may be required by the shell.)
161
162              (See the main PuTTY manual for full details of the supported  %-
163              and backslash-delimited tokens, although most of them are proba‐
164              bly not very useful in this context.)
165
166       -l username
167              Specify the username to use when logging in to the server.
168
169       -L [srcaddr:]srcport:desthost:destport
170              Set  up  a  local  port  forwarding:  listen  on   srcport   (or
171              srcaddr:srcport  if specified), and forward any connections over
172              the SSH connection to the destination address desthost:destport.
173              Only works in SSH.
174
175       -R [srcaddr:]srcport:desthost:destport
176              Set up a remote port forwarding: ask the SSH server to listen on
177              srcport (or srcaddr:srcport if specified), and  to  forward  any
178              connections  back  over the SSH connection where the client will
179              pass them on to the destination address desthost:destport.  Only
180              works in SSH.
181
182       -D [srcaddr:]srcport
183              Set  up  dynamic  port forwarding. The client listens on srcport
184              (or  srcaddr:srcport  if  specified),  and  implements  a  SOCKS
185              server.  So  you can point SOCKS-aware applications at this port
186              and they will automatically use the SSH connection to tunnel all
187              their connections. Only works in SSH.
188
189       -P port
190              Specify the port to connect to the server on.
191
192       -A, -a Enable (-A) or disable (-a) SSH agent forwarding. Currently this
193              only works with OpenSSH and SSH-1.
194
195       -X, -x Enable (-X) or disable (-x) X11 forwarding.
196
197       -T, -t Enable (-t) or disable (-T) the allocation of a  pseudo-terminal
198              at the server end.
199
200       -C     Enable zlib-style compression on the connection.
201
202       -1, -2 Select SSH protocol version 1 or 2.
203
204       -4, -6 Force use of IPv4 or IPv6 for network connections.
205
206       -i keyfile
207              Private  key  file for user authentication. For SSH-2 keys, this
208              key file must be in PuTTY's PPK format, not OpenSSH's format  or
209              anyone else's.
210
211              If you are using an authentication agent, you can also specify a
212              public key here (in RFC 4716 or  OpenSSH  format),  to  identify
213              which of the agent's keys to use.
214
215       -noagent
216              Don't  try  to use an authentication agent for local authentica‐
217              tion. (This doesn't affect agent forwarding.)
218
219       -agent Allow use of an authentication agent. (This option is only  nec‐
220              essary to override a setting in a saved session.)
221
222       -hostkey key
223              Specify an acceptable host public key. This option may be speci‐
224              fied multiple times;  each  key  can  be  either  a  fingerprint
225              (99:aa:bb:...)  or  a  base64-encoded blob in OpenSSH's one-line
226              format.
227
228              Specifying this option overrides automated host key  management;
229              only  the  key(s) specified on the command-line will be accepted
230              (unless a saved session also overrides host keys, in which  case
231              those  will  be  added  to),  and the host key cache will not be
232              written.
233
234       -sercfg configuration-string
235              Specify the configuration parameters for  the  serial  port,  in
236              -serial  mode.  configuration-string should be a comma-separated
237              list of configuration parameters as follows:
238
239              ·      Any single digit from 5 to 9  sets  the  number  of  data
240                     bits.
241
242              ·      `1', `1.5' or `2' sets the number of stop bits.
243
244              ·      Any other numeric string is interpreted as a baud rate.
245
246              ·      A  single lower-case letter specifies the parity: `n' for
247                     none, `o' for odd, `e' for even, `m' for mark and `s' for
248                     space.
249
250              ·      A  single  upper-case  letter specifies the flow control:
251                     `N' for none, `X' for XON/XOFF, `R' for RTS/CTS  and  `D'
252                     for DSR/DTR.
253

SAVED SESSIONS

255       Saved  sessions  are  stored  in a .putty/sessions subdirectory in your
256       home directory.
257

MORE INFORMATION

259       For more information on PuTTY, it's probably best to go and look at the
260       manual on the web page:
261
262       https://www.chiark.greenend.org.uk/~sgtatham/putty/
263

BUGS

265       This man page isn't terribly complete.
266
267
268
269PuTTY tool suite                  2004‐03‐24                          putty(1)
Impressum