Stop proxying connections to localhost by default; should fix
[u/mdw/putty] / doc / config.but
1 \versionid $Id: config.but,v 1.46 2002/12/18 12:18:54 simon Exp $
2
3 \C{config} Configuring PuTTY
4
5 This chapter describes all the configuration options in PuTTY.
6
7 PuTTY is configured using the control panel that comes up before you
8 start a session. Some options can also be changed in the middle of a
9 session, by selecting \q{Change Settings} from the window menu.
10
11 \H{config-session} The Session panel
12
13 The Session configuration panel contains the basic options you need
14 to specify in order to open a session at all, and also allows you to
15 save your settings to be reloaded later.
16
17 \S{config-hostname} The host name section
18
19 \cfg{winhelp-topic}{session.hostname}
20
21 The top box on the Session panel, labelled \q{Specify your
22 connection by host name}, contains the details that need to be
23 filled in before PuTTY can open a session at all.
24
25 \b The \q{Host Name} box is where you type the name, or the IP
26 address, of the server you want to connect to.
27
28 \b The \q{Protocol} radio buttons let you choose what type of
29 connection you want to make: a raw connection, a Telnet connection, an
30 rlogin connection or an SSH connection. (See \k{which-one} for a
31 summary of the differences between SSH, Telnet and rlogin.)
32
33 \b The \q{Port} box lets you specify which port number on the server
34 to connect to. If you select Telnet, Rlogin, or SSH, this box will
35 be filled in automatically to the usual value, and you will only
36 need to change it if you have an unusual server. If you select Raw
37 mode (see \k{using-rawprot}), you will almost certainly need to fill
38 in the \q{Port} box.
39
40 \S{config-saving} Loading and storing saved sessions
41
42 \cfg{winhelp-topic}{session.saved}
43
44 The next part of the Session configuration panel allows you to save
45 your preferred PuTTY options so they will appear automatically the
46 next time you start PuTTY. It also allows you to create \e{saved
47 sessions}, which contain a full set of configuration options plus a
48 host name and protocol. A saved session contains all the information
49 PuTTY needs to start exactly the session you want.
50
51 \b To save your default settings: first set up the settings the way
52 you want them saved. Then come back to the Session panel. Select the
53 \q{Default Settings} entry in the saved sessions list, with a single
54 click. Then press the \q{Save} button.
55
56 Note that PuTTY does not allow you to save a host name into the
57 Default Settings entry. This ensures that when PuTTY is started up,
58 the host name box is always empty, so a user can always just type in
59 a host name and connect.
60
61 If there is a specific host you want to store the details of how to
62 connect to, you should create a saved session, which will be
63 separate from the Default Settings.
64
65 \b To save a session: first go through the rest of the configuration
66 box setting up all the options you want. Then come back to the
67 Session panel. Enter a name for the saved session in the \q{Saved
68 Sessions} input box. (The server name is often a good choice for a
69 saved session name.) Then press the \q{Save} button. Your saved
70 session name should now appear in the list box.
71
72 \b To reload a saved session: single-click to select the session
73 name in the list box, and then press the \q{Load} button. Your saved
74 settings should all appear in the configuration panel.
75
76 \b To modify a saved session: first load it as described above. Then
77 make the changes you want. Come back to the Session panel,
78 single-click to select the session name in the list box, and press
79 the \q{Save} button. The new settings will be saved over the top of
80 the old ones.
81
82 \b To start a saved session immediately: double-click on the session
83 name in the list box.
84
85 \b To delete a saved session: single-click to select the session
86 name in the list box, and then press the \q{Delete} button.
87
88 Each saved session is independent of the Default Settings
89 configuration. If you change your preferences and update Default
90 Settings, you must also update every saved session separately.
91
92 \S{config-closeonexit} \q{Close Window on Exit}
93
94 \cfg{winhelp-topic}{session.coe}
95
96 Finally in the Session panel, there is an option labelled \q{Close
97 Window on Exit}. This controls whether the PuTTY session window
98 disappears as soon as the session inside it terminates. If you are
99 likely to want to copy and paste text out of the session after it
100 has terminated, you should arrange this option to be off.
101
102 \q{Close Window On Exit} has three settings. \q{Always} means always
103 close the window on exit; \q{Never} means never close on exit
104 (always leave the window open). The third setting, and the default
105 one, is \q{Only on clean exit}. In this mode, a session which
106 terminates normally will cause its window to close, but one which is
107 aborted unexpectedly by network trouble or a confusing message from
108 the server will leave the window up.
109
110 \H{config-logging} The Logging panel
111
112 \cfg{winhelp-topic}{logging.main}
113
114 The Logging configuration panel allows you to save log files of your
115 PuTTY sessions, for debugging, analysis or future reference.
116
117 The main option is a radio-button set that specifies whether PuTTY
118 will log anything at all. The options are
119
120 \b \q{Logging turned off completely}. This is the default option; in
121 this mode PuTTY will not create a log file at all.
122
123 \b \q{Log printable output only}. In this mode, a log file will be
124 created and written to, but only printable text will be saved into
125 it. The various terminal control codes that are typically sent down
126 an interactive session alongside the printable text will be omitted.
127 This might be a useful mode if you want to read a log file in a text
128 editor and hope to be able to make sense of it.
129
130 \b \q{Log all session output}. In this mode, \e{everything} sent by
131 the server into your terminal session is logged. If you view the log
132 file in a text editor, therefore, you may well find it full of
133 strange control characters. This is a particularly useful mode if
134 you are experiencing problems with PuTTY's terminal handling: you
135 can record everything that went to the terminal, so that someone
136 else can replay the session later in slow motion and watch to see
137 what went wrong.
138
139 \b \q{Log SSH packet data}. In this mode (which is only used by SSH
140 connections), the SSH message packets sent over the encrypted
141 connection are written to the log file. You might need this to debug
142 a network-level problem, or more likely to send to the PuTTY authors
143 as part of a bug report. \e{BE WARNED} that if you log in using a
144 password, the password will appear in the log file, so be sure to
145 edit it out before sending the log file to anyone else!
146
147 \S{config-logfilename} \q{Log file name}
148
149 \cfg{winhelp-topic}{logging.filename}
150
151 In this edit box you enter the name of the file you want to log the
152 session to. The \q{Browse} button will let you look around your file
153 system to find the right place to put the file; or if you already
154 know exactly where you want it to go, you can just type a pathname
155 into the edit box.
156
157 There are a few special features in this box. If you use the \c{&}
158 character in the file name box, PuTTY will insert details of the
159 current session in the name of the file it actually opens. The
160 precise replacements it will do are:
161
162 \b \c{&Y} will be replaced by the current year, as four digits.
163
164 \b \c{&M} will be replaced by the current month, as two digits.
165
166 \b \c{&D} will be replaced by the current day of the month, as two
167 digits.
168
169 \b \c{&T} will be replaced by the current time, as six digits
170 (HHMMSS) with no punctuation.
171
172 \b \c{&H} will be replaced by the host name you are connecting to.
173
174 For example, if you enter the host name
175 \c{c:\\puttylogs\\log-&h-&y&m&d-&t.dat}, you will end up with files looking
176 like
177
178 \c log-server1.example.com-20010528-110859.dat
179 \c log-unixbox.somewhere.org-20010611-221001.dat
180
181 \S{config-logfileexists} \q{What to do if the log file already exists}
182
183 \cfg{winhelp-topic}{logging.exists}
184
185 This control allows you to specify what PuTTY should do if it tries
186 to start writing to a log file and it finds the file already exists.
187 You might want to automatically destroy the existing log file and
188 start a new one with the same name. Alternatively, you might want to
189 open the existing log file and add data to the \e{end} of it.
190 Finally (the default option), you might not want to have any
191 automatic behaviour, but to ask the user every time the problem
192 comes up.
193
194 \H{config-terminal} The Terminal panel
195
196 The Terminal configuration panel allows you to control the behaviour
197 of PuTTY's terminal emulation.
198
199 \S{config-autowrap} \q{Auto wrap mode initially on}
200
201 \cfg{winhelp-topic}{terminal.autowrap}
202
203 Auto wrap mode controls what happens when text printed in a PuTTY
204 window reaches the right-hand edge of the window.
205
206 With auto wrap mode on, if a long line of text reaches the
207 right-hand edge, it will wrap over on to the next line so you can
208 still see all the text. With auto wrap mode off, the cursor will
209 stay at the right-hand edge of the screen, and all the characters in
210 the line will be printed on top of each other.
211
212 If you are running a full-screen application and you occasionally
213 find the screen scrolling up when it looks as if it shouldn't, you
214 could try turning this option off.
215
216 Auto wrap mode can be turned on and off by control sequences sent by
217 the server. This configuration option only controls the \e{default}
218 state. If you modify this option in mid-session using \q{Change
219 Settings}, you will need to reset the terminal (see
220 \k{reset-terminal}) before the change takes effect.
221
222 \S{config-decom} \q{DEC Origin Mode initially on}
223
224 \cfg{winhelp-topic}{terminal.decom}
225
226 DEC Origin Mode is a minor option which controls how PuTTY
227 interprets cursor-position control sequences sent by the server.
228
229 The server can send a control sequence that restricts the scrolling
230 region of the display. For example, in an editor, the server might
231 reserve a line at the top of the screen and a line at the bottom,
232 and might send a control sequence that causes scrolling operations
233 to affect only the remaining lines.
234
235 With DEC Origin Mode on, cursor coordinates are counted from the top
236 of the scrolling region. With it turned off, cursor coordinates are
237 counted from the top of the whole screen regardless of the scrolling
238 region.
239
240 It is unlikely you would need to change this option, but if you find
241 a full-screen application is displaying pieces of text in what looks
242 like the wrong part of the screen, you could try turning DEC Origin
243 Mode on to see whether that helps.
244
245 DEC Origin Mode can be turned on and off by control sequences sent
246 by the server. This configuration option only controls the
247 \e{default} state. If you modify this option in mid-session using
248 \q{Change Settings}, you will need to reset the terminal (see
249 \k{reset-terminal}) before the change takes effect.
250
251 \S{config-crlf} \q{Implicit CR in every LF}
252
253 \cfg{winhelp-topic}{terminal.lfhascr}
254
255 Most servers send two control characters, CR and LF, to start a new
256 line of the screen. The CR character makes the cursor return to the
257 left-hand side of the screen. The LF character makes the cursor move
258 one line down (and might make the screen scroll).
259
260 Some servers only send LF, and expect the terminal to move the
261 cursor over to the left automatically. If you come across a server
262 that does this, you will see a stepped effect on the screen, like
263 this:
264
265 \c First line of text
266 \c Second line
267 \c Third line
268
269 If this happens to you, try enabling the \q{Implicit CR in every LF}
270 option, and things might go back to normal:
271
272 \c First line of text
273 \c Second line
274 \c Third line
275
276 \S{config-erase} \q{Use background colour to erase screen}
277
278 \cfg{winhelp-topic}{terminal.bce}
279
280 Not all terminals agree on what colour to turn the screen when the
281 server sends a \q{clear screen} sequence. Some terminals believe the
282 screen should always be cleared to the \e{default} background
283 colour. Others believe the screen should be cleared to whatever the
284 server has selected as a background colour.
285
286 There exist applications that expect both kinds of behaviour.
287 Therefore, PuTTY can be configured to do either.
288
289 With this option disabled, screen clearing is always done in the
290 default background colour. With this option enabled, it is done in
291 the \e{current} background colour.
292
293 Background-colour erase can be turned on and off by control
294 sequences sent by the server. This configuration option only
295 controls the \e{default} state. If you modify this option in
296 mid-session using \q{Change Settings}, you will need to reset the
297 terminal (see \k{reset-terminal}) before the change takes effect.
298
299 \S{config-blink} \q{Enable blinking text}
300
301 \cfg{winhelp-topic}{terminal.blink}
302
303 The server can ask PuTTY to display text that blinks on and off.
304 This is very distracting, so PuTTY allows you to turn blinking text
305 off completely.
306
307 When blinking text is disabled and the server attempts to make some
308 text blink, PuTTY will instead display the text with a bolded
309 background colour.
310
311 Blinking text can be turned on and off by control sequences sent by
312 the server. This configuration option only controls the \e{default}
313 state. If you modify this option in mid-session using \q{Change
314 Settings}, you will need to reset the terminal (see
315 \k{reset-terminal}) before the change takes effect.
316
317 \S{config-answerback} \q{Answerback to ^E}
318
319 \cfg{winhelp-topic}{terminal.answerback}
320
321 This option controls what PuTTY will send back to the server if the
322 server sends it the ^E enquiry character. Normally it just sends
323 the string \q{PuTTY}.
324
325 If you accidentally write the contents of a binary file to your
326 terminal, you will probably find that it contains more than one ^E
327 character, and as a result your next command line will probably read
328 \q{PuTTYPuTTYPuTTY...} as if you had typed the answerback string
329 multiple times at the keyboard. If you set the answerback string to
330 be empty, this problem should go away, but doing so might cause
331 other problems.
332
333 Note that this is \e{not} the feature of PuTTY which the server will
334 typically use to determine your terminal type. That feature is the
335 \q{Terminal-type string} in the Connection panel; see
336 \k{config-termtype} for details.
337
338 You can include control characters in the answerback string using
339 \c{^C} notation. (Use \c{^~} to get a literal \c{^}.)
340
341 \S{config-localecho} \q{Local echo}
342
343 \cfg{winhelp-topic}{terminal.localecho}
344
345 With local echo disabled, characters you type into the PuTTY window
346 are not echoed in the window \e{by PuTTY}. They are simply sent to
347 the server. (The \e{server} might choose to echo them back to you;
348 this can't be controlled from the PuTTY control panel.)
349
350 Some types of session need local echo, and many do not. In its
351 default mode, PuTTY will automatically attempt to deduce whether or
352 not local echo is appropriate for the session you are working in. If
353 you find it has made the wrong decision, you can use this
354 configuration option to override its choice: you can force local
355 echo to be turned on, or force it to be turned off, instead of
356 relying on the automatic detection.
357
358 \S{config-localedit} \q{Local line editing}
359
360 \cfg{winhelp-topic}{terminal.localedit}
361
362 Normally, every character you type into the PuTTY window is sent
363 immediately to the server the moment you type it.
364
365 If you enable local line editing, this changes. PuTTY will let you
366 edit a whole line at a time locally, and the line will only be sent
367 to the server when you press Return. If you make a mistake, you can
368 use the Backspace key to correct it before you press Return, and the
369 server will never see the mistake.
370
371 Since it is hard to edit a line locally without being able to see
372 it, local line editing is mostly used in conjunction with local echo
373 (\k{config-localecho}). This makes it ideal for use in raw mode
374 \#{FIXME} or when connecting to MUDs or talkers. (Although some more
375 advanced MUDs do occasionally turn local line editing on and turn
376 local echo off, in order to accept a password from the user.)
377
378 Some types of session need local line editing, and many do not. In
379 its default mode, PuTTY will automatically attempt to deduce whether
380 or not local line editing is appropriate for the session you are
381 working in. If you find it has made the wrong decision, you can use
382 this configuration option to override its choice: you can force
383 local line editing to be turned on, or force it to be turned off,
384 instead of relying on the automatic detection.
385
386 \S{config-printing} Remote-controlled printing
387
388 \cfg{winhelp-topic}{terminal.printing}
389
390 A lot of VT100-compatible terminals support printing under control
391 of the remote server. PuTTY supports this feature as well, but it is
392 turned off by default.
393
394 To enable remote-controlled printing, choose a printer from the
395 \q{Printer to send ANSI printer output to} drop-down list box. This
396 should allow you to select from all the printers you have installed
397 drivers for on your computer. Alternatively, you can type the
398 network name of a networked printer (for example,
399 \c{\\\\printserver\\printer1}) even if you haven't already
400 installed a driver for it on your own machine.
401
402 When the remote server attempts to print some data, PuTTY will send
403 that data to the printer \e{raw} - without translating it,
404 attempting to format it, or doing anything else to it. It is up to
405 you to ensure your remote server knows what type of printer it is
406 talking to.
407
408 Since PuTTY sends data to the printer raw, it cannot offer options
409 such as portrait versus landscape, print quality, or paper tray
410 selection. All these things would be done by your PC printer driver
411 (which PuTTY bypasses); if you need them done, you will have to find
412 a way to configure your remote server to do them.
413
414 To disable remote printing again, choose \q{None (printing
415 disabled)} from the printer selection list. This is the default
416 state.
417
418 \H{config-keyboard} The Keyboard panel
419
420 The Keyboard configuration panel allows you to control the behaviour
421 of the keyboard in PuTTY.
422
423 \S{config-backspace} Changing the action of the Backspace key
424
425 \cfg{winhelp-topic}{keyboard.backspace}
426
427 Some terminals believe that the Backspace key should send the same
428 thing to the server as Control-H (ASCII code 8). Other terminals
429 believe that the Backspace key should send ASCII code 127 (usually
430 known as Control-?) so that it can be distinguished from Control-H.
431 This option allows you to choose which code PuTTY generates when you
432 press Backspace.
433
434 If you are connecting to a Unix system, you will probably find that
435 the Unix \c{stty} command lets you configure which the server
436 expects to see, so you might not need to change which one PuTTY
437 generates. On other systems, the server's expectation might be fixed
438 and you might have no choice but to configure PuTTY.
439
440 If you do have the choice, we recommend configuring PuTTY to
441 generate Control-? and configuring the server to expect it, because
442 that allows applications such as \c{emacs} to use Control-H for
443 help.
444
445 \S{config-homeend} Changing the action of the Home and End keys
446
447 \cfg{winhelp-topic}{keyboard.homeend}
448
449 The Unix terminal emulator \c{rxvt} disagrees with the rest of the
450 world about what character sequences should be sent to the server by
451 the Home and End keys.
452
453 \c{xterm}, and other terminals, send \c{ESC [1~} for the Home key,
454 and \c{ESC [4~} for the End key. \c{rxvt} sends \c{ESC [H} for the
455 Home key and \c{ESC [Ow} for the End key.
456
457 If you find an application on which the Home and End keys aren't
458 working, you could try switching this option to see if it helps.
459
460 \S{config-funkeys} Changing the action of the function keys and keypad
461
462 \cfg{winhelp-topic}{keyboard.funkeys}
463
464 This option affects the function keys (F1 to F12) and the top row of
465 the numeric keypad.
466
467 \b In the default mode, labelled \c{ESC [n~}, the function keys
468 generate sequences like \c{ESC [11~}, \c{ESC [12~} and so on. This
469 matches the general behaviour of Digital's terminals.
470
471 \b In Linux mode, F6 to F12 behave just like the default mode, but
472 F1 to F5 generate \c{ESC [[A} through to \c{ESC [[E}. This mimics the
473 Linux virtual console.
474
475 \b In Xterm R6 mode, F5 to F12 behave like the default mode, but F1
476 to F4 generate \c{ESC OP} through to \c{ESC OS}, which are the
477 sequences produced by the top row of the \e{keypad} on Digital's
478 terminals.
479
480 \b In VT400 mode, all the function keys behave like the default
481 mode, but the actual top row of the numeric keypad generates \c{ESC
482 OP} through to \c{ESC OS}.
483
484 \b In VT100+ mode, the function keys generate \c{ESC OP} through to
485 \c{ESC O[}
486
487 \b In SCO mode, the function keys F1 to F12 generate \c{ESC [M}
488 through to \c{ESC [X}. Together with shift, they generate \c{ESC [Y}
489 through to \c{ESC [j}. With control they generate \c{ESC [k} through
490 to \c{ESC [v}, and with shift and control together they generate
491 \c{ESC [w} through to \c{ESC [\{}.
492
493 If you don't know what any of this means, you probably don't need to
494 fiddle with it.
495
496 \S{config-appcursor} Controlling Application Cursor Keys mode
497
498 \cfg{winhelp-topic}{keyboard.appcursor}
499
500 Application Cursor Keys mode is a way for the server to change the
501 control sequences sent by the arrow keys. In normal mode, the arrow
502 keys send \c{ESC [A} through to \c{ESC [D}. In application mode,
503 they send \c{ESC OA} through to \c{ESC OD}.
504
505 Application Cursor Keys mode can be turned on and off by the server,
506 depending on the application. PuTTY allows you to configure the
507 initial state.
508
509 You can also disable application cursor keys mode completely, using
510 the \q{Features} configuration panel; see
511 \k{config-features-application}.
512
513 \S{config-appkeypad} Controlling Application Keypad mode
514
515 \cfg{winhelp-topic}{keyboard.appkeypad}
516
517 Application Keypad mode is a way for the server to change the
518 behaviour of the numeric keypad.
519
520 In normal mode, the keypad behaves like a normal Windows keypad:
521 with NumLock on, the number keys generate numbers, and with NumLock
522 off they act like the arrow keys and Home, End etc.
523
524 In application mode, all the keypad keys send special control
525 sequences, \e{including} Num Lock. Num Lock stops behaving like Num
526 Lock and becomes another function key.
527
528 Depending on which version of Windows you run, you may find the Num
529 Lock light still flashes on and off every time you press Num Lock,
530 even when application mode is active and Num Lock is acting like a
531 function key. This is unavoidable.
532
533 Application keypad mode can be turned on and off by the server,
534 depending on the application. PuTTY allows you to configure the
535 initial state.
536
537 You can also disable application keypad mode completely, using the
538 \q{Features} configuration panel; see
539 \k{config-features-application}.
540
541 \S{config-nethack} Using NetHack keypad mode
542
543 \cfg{winhelp-topic}{keyboard.nethack}
544
545 PuTTY has a special mode for playing NetHack. You can enable it by
546 selecting \q{NetHack} in the \q{Initial state of numeric keypad}
547 control.
548
549 In this mode, the numeric keypad keys 1-9 generate the NetHack
550 movement commands (\cw{hjklyubn}). The 5 key generates the \c{.}
551 command (do nothing).
552
553 Better still, pressing Shift with the keypad keys generates the
554 capital forms of the commands (\cw{HJKLYUBN}), which tells NetHack
555 to keep moving you in the same direction until you encounter
556 something interesting.
557
558 For some reason, this feature only works properly when Num Lock is
559 on. We don't know why.
560
561 \S{config-compose} Enabling a DEC-like Compose key
562
563 \cfg{winhelp-topic}{keyboard.compose}
564
565 DEC terminals have a Compose key, which provides an easy-to-remember
566 way of typing accented characters. You press Compose and then type
567 two more characters. The two characters are \q{combined} to produce
568 an accented character. The choices of character are designed to be
569 easy to remember; for example, composing \q{e} and \q{`} produces
570 the \q{\u00e8{e-grave}} character.
571
572 If your keyboard has a Windows Application key, it acts as a Compose
573 key in PuTTY. Alternatively, if you enable the \q{AltGr acts as
574 Compose key} option, the AltGr key will become a Compose key.
575
576 \S{config-ctrlalt} \q{Control-Alt is different from AltGr}
577
578 \cfg{winhelp-topic}{keyboard.ctrlalt}
579
580 Some old keyboards do not have an AltGr key, which can make it
581 difficult to type some characters. PuTTY can be configured to treat
582 the key combination Ctrl + Left Alt the same way as the AltGr key.
583
584 By default, this checkbox is checked, and the key combination Ctrl +
585 Left Alt does something completely different. PuTTY's usual handling
586 of the left Alt key is to prefix the Escape (Control-\cw{[})
587 character to whatever character sequence the rest of the keypress
588 would generate. For example, Alt-A generates Escape followed by
589 \c{a}. So Alt-Ctrl-A would generate Escape, followed by Control-A.
590
591 If you uncheck this box, Ctrl-Alt will become a synonym for AltGr,
592 so you can use it to type extra graphic characters if your keyboard
593 has any.
594
595 (However, Ctrl-Alt will never act as a Compose key, regardless of the
596 setting of \q{AltGr acts as Compose key} described in
597 \k{config-compose}.)
598
599 \H{config-bell} The Bell panel
600
601 The Bell panel controls the terminal bell feature: the server's
602 ability to cause PuTTY to beep at you.
603
604 In the default configuration, when the server sends the character
605 with ASCII code 7 (Control-G), PuTTY will play the Windows Default
606 Beep sound. This is not always what you want the terminal bell
607 feature to do; the Bell panel allows you to configure alternative
608 actions.
609
610 \S{config-bellstyle} \q{Set the style of bell}
611
612 \cfg{winhelp-topic}{bell.style}
613
614 This control allows you to select various different actions to occur
615 on a terminal bell:
616
617 \b Selecting \q{None} disables the bell completely. In this mode,
618 the server can send as many Control-G characters as it likes and
619 nothing at all will happen.
620
621 \b \q{Play Windows Default Sound} is the default setting. It causes
622 the Windows \q{Default Beep} sound to be played. To change what this
623 sound is, or to test it if nothing seems to be happening, use the
624 Sound configurer in the Windows Control Panel.
625
626 \b \q{Play a custom sound file} allows you to specify a particular
627 sound file to be used by PuTTY alone, or even by a particular
628 individual PuTTY session. This allows you to distinguish your PuTTY
629 beeps from any other beeps on the system. If you select this option,
630 you will also need to enter the name of your sound file in the edit
631 control \q{Custom sound file to play as a bell}.
632
633 \b \q{Visual bell} is a silent alternative to a beeping computer. In
634 this mode, when the server sends a Control-G, the whole PuTTY window
635 will flash white for a fraction of a second.
636
637 \S{config-belltaskbar} \q{Taskbar/caption indication on bell}
638
639 \cfg{winhelp-topic}{bell.taskbar}
640
641 This feature controls what happens to the PuTTY window's entry in
642 the Windows Taskbar if a bell occurs while the window does not have
643 the input focus.
644
645 In the default state (\q{Disabled}) nothing unusual happens.
646
647 If you select \q{Steady}, then when a bell occurs and the window is
648 not in focus, the window's Taskbar entry and its title bar will
649 change colour to let you know that PuTTY session is asking for your
650 attention. The change of colour will persist until you select the
651 window, so you can leave several PuTTY windows minimised in your
652 terminal, go away from your keyboard, and be sure not to have missed
653 any important beeps when you get back.
654
655 \q{Flashing} is even more eye-catching: the Taskbar entry will
656 continuously flash on and off until you select the window.
657
658 \S{config-bellovl} \q{Control the bell overload behaviour}
659
660 \cfg{winhelp-topic}{bell.overload}
661
662 A common user error in a terminal session is to accidentally run the
663 Unix command \c{cat} (or equivalent) on an inappropriate file type,
664 such as an executable, image file, or ZIP file. This produces a huge
665 stream of non-text characters sent to the terminal, which typically
666 includes a lot of bell characters. As a result of this the terminal
667 often doesn't stop beeping for ten minutes, and everybody else in
668 the office gets annoyed.
669
670 To try to avoid this behaviour, or any other cause of excessive
671 beeping, PuTTY includes a bell overload management feature. In the
672 default configuration, receiving more than five bell characters in a
673 two-second period will cause the overload feature to activate. Once
674 the overload feature is active, further bells will have no effect at
675 all, so the rest of your binary file will be sent to the screen in
676 silence. After a period of five seconds during which no further
677 bells are received, the overload feature will turn itself off again
678 and bells will be re-enabled.
679
680 If you want this feature completely disabled, you can turn it off
681 using the checkbox \q{Bell is temporarily disabled when over-used}.
682
683 Alternatively, if you like the bell overload feature but don't agree
684 with the settings, you can configure the details: how many bells
685 constitute an overload, how short a time period they have to arrive
686 in to do so, and how much silent time is required before the
687 overload feature will deactivate itself.
688
689 Bell overload mode is always deactivated by any keypress in the
690 terminal. This means it can respond to large unexpected streams of
691 data, but does not interfere with ordinary command-line activities
692 that generate beeps (such as filename completion).
693
694 \H{config-features} The Features panel
695
696 PuTTY's terminal emulation is very highly featured, and can do a lot
697 of things under remote server control. Some of these features can
698 cause problems due to buggy or strangely configured server
699 applications.
700
701 The Features configuration panel allows you to disable some of
702 PuTTY's more advanced terminal features, in case they cause trouble.
703
704 \S{config-features-application} Disabling application keypad and cursor keys
705
706 \cfg{winhelp-topic}{features.application}
707
708 Application keypad mode (see \k{config-appkeypad}) and application
709 cursor keys mode (see \k{config-appcursor}) alter the behaviour of
710 the keypad and cursor keys. Some applications enable these modes but
711 then do not deal correctly with the modified keys. You can force
712 these modes to be permanently disabled no matter what the server
713 tries to do.
714
715 \S{config-features-mouse} Disabling \cw{xterm}-style mouse reporting
716
717 \cfg{winhelp-topic}{features.mouse}
718
719 PuTTY allows the server to send control codes that let it take over
720 the mouse and use it for purposes other than copy and paste.
721 Applications which use this feature include the text-mode web
722 browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
723 file manager \c{mc} (Midnight Commander).
724
725 If you find this feature inconvenient, you can disable it using the
726 \q{Disable xterm-style mouse reporting} control. With this box
727 ticked, the mouse will \e{always} do copy and paste in the normal
728 way.
729
730 Note that even if the application takes over the mouse, you can
731 still manage PuTTY's copy and paste by holding down the Shift key
732 while you select and paste, unless you have deliberately turned this
733 feature off (see \k{config-mouseshift}).
734
735 \S{config-features-resize} Disabling remote terminal resizing
736
737 \cfg{winhelp-topic}{features.resize}
738
739 PuTTY has the ability to change the terminal's size and position in
740 response to commands from the server. If you find PuTTY is doing
741 this unexpectedly or inconveniently, you can tell PuTTY not to
742 respond to those server commands.
743
744 \S{config-features-altscreen} Disabling switching to the alternate screen
745
746 \cfg{winhelp-topic}{features.altscreen}
747
748 Many terminals, including PuTTY, support an \q{alternate screen}.
749 This is the same size as the ordinary terminal screen, but separate.
750 Typically a screen-based program such as a text editor might switch
751 the terminal to the alternate screen before starting up. Then at the
752 end of the run, it switches back to the primary screen, and you see
753 the screen contents just as they were before starting the editor.
754
755 Some people prefer this not to happen. If you want your editor to
756 run in the same screen as the rest of your terminal activity, you
757 can disable the alternate screen feature completely.
758
759 \S{config-features-retitle} Disabling remote window title changing
760
761 \cfg{winhelp-topic}{features.retitle}
762
763 PuTTY has the ability to change the window title in response to
764 commands from the server. If you find PuTTY is doing this
765 unexpectedly or inconveniently, you can tell PuTTY not to respond to
766 those server commands.
767
768 \S{config-features-dbackspace} Disabling destructive backspace
769
770 \cfg{winhelp-topic}{features.dbackspace}
771
772 Normally, when PuTTY receives character 127 (^?) from the server, it
773 will perform a \q{destructive backspace}: move the cursor one space
774 left and delete the character under it. This can apparently cause
775 problems in some applications, so PuTTY provides the ability to
776 configure character 127 to perform a normal backspace (without
777 deleting a character) instead.
778
779 \S{config-features-charset} Disabling remote character set
780 configuration
781
782 \cfg{winhelp-topic}{features.charset}
783
784 PuTTY has the ability to change its character set configuration in
785 response to commands from the server. Some programs send these
786 commands unexpectedly or inconveniently. In particular, BitchX (an
787 IRC client) seems to have a habit of reconfiguring the character set
788 to something other than the user intended.
789
790 If you find that accented characters are not showing up the way you
791 expect them to, particularly if you're running BitchX, you could try
792 disabling the remote character set configuration commands.
793
794 \H{config-window} The Window panel
795
796 The Window configuration panel allows you to control aspects of the
797 PuTTY window.
798
799 \S{config-winsize} Setting the size of the PuTTY window
800
801 \cfg{winhelp-topic}{window.size}
802
803 The \q{Rows} and \q{Columns} boxes let you set the PuTTY window to a
804 precise size. Of course you can also drag the window to a new size
805 while a session is running.
806
807 \S{config-winsizelock} What to do when the window is resized
808
809 \cfg{winhelp-topic}{window.resize}
810
811 These options allow you to control what happens when the user tries
812 to resize the PuTTY window.
813
814 When you resize the PuTTY window, one of four things can happen:
815
816 \b Nothing (if you have completely disabled resizes).
817
818 \b The font size can stay the same and the number of rows and
819 columns in the terminal can change.
820
821 \b The number of rows and columns in the terminal can stay the same,
822 and the font size can change.
823
824 \b You can allow PuTTY to change \e{either} the terminal size or the
825 font size. In this mode it will change the terminal size most of the
826 time, but enlarge the font when you maximise the window.
827
828 You can control which of these happens using the \q{Lock terminal
829 size against resizing} and \q{Lock font size against resizing}
830 options. If you lock both, the window will refuse to be resized at
831 all. If you lock just the terminal size, the font size will change
832 when you resize the window. If you lock just the font size, the
833 terminal size will change when you resize the window.
834
835 \S{config-scrollback} Controlling scrollback
836
837 \cfg{winhelp-topic}{window.scrollback}
838
839 These options let you configure the way PuTTY keeps text after it
840 scrolls off the top of the screen (see \k{using-scrollback}).
841
842 The \q{Lines of scrollback} box lets you configure how many lines of
843 text PuTTY keeps. The \q{Display scrollbar} options allow you to
844 hide the scrollbar (although you can still view the scrollback using
845 Shift-PgUp and Shift-PgDn). You can separately configure whether the
846 scrollbar is shown in full-screen mode and in normal modes.
847
848 If you are viewing part of the scrollback when the server sends more
849 text to PuTTY, the screen will revert to showing the current
850 terminal contents. You can disable this behaviour by turning off
851 \q{Reset scrollback on display activity}. You can also make the
852 screen revert when you press a key, by turning on \q{Reset
853 scrollback on keypress}.
854
855 \H{config-appearance} The Appearance panel
856
857 The Appearance configuration panel allows you to control aspects of
858 the appearance of PuTTY's window.
859
860 \S{config-cursor} Controlling the appearance of the cursor
861
862 \cfg{winhelp-topic}{appearance.cursor}
863
864 The \q{Cursor appearance} option lets you configure the cursor to be
865 a block, an underline, or a vertical line. A block cursor becomes an
866 empty box when the window loses focus; an underline or a vertical
867 line becomes dotted.
868
869 The \q{Cursor blinks} option makes the cursor blink on and off. This
870 works in any of the cursor modes.
871
872 \S{config-font} Controlling the font used in the terminal window
873
874 \cfg{winhelp-topic}{appearance.font}
875
876 This option allows you to choose what font, in what size, the PuTTY
877 terminal window uses to display the text in the session. You will be
878 offered a choice from all the fixed-width fonts installed on the
879 system. (VT100-style terminal handling can only deal with fixed-
880 width fonts.)
881
882 \S{config-title} Controlling the window title
883
884 \cfg{winhelp-topic}{appearance.title}
885
886 The \q{Window title} edit box allows you to set the title of the
887 PuTTY window. By default the window title will contain the host name
888 followed by \q{PuTTY}, for example \c{server1.example.com - PuTTY}.
889 If you want a different window title, this is where to set it.
890
891 PuTTY allows the server to send \c{xterm} control sequences which
892 modify the title of the window in mid-session. There is also an
893 \c{xterm} sequence to modify the title of the window's \e{icon}.
894 This makes sense in a windowing system where the window becomes an
895 icon when minimised, such as Windows 3.1 or most X Window System
896 setups; but in the Windows 95-like user interface it isn't as
897 applicable. By default PuTTY's window title and Taskbar caption will
898 change into the server-supplied icon title if you minimise the PuTTY
899 window, and change back to the server-supplied window title if you
900 restore it. (If the server has not bothered to supply a window or
901 icon title, none of this will happen.) By checking the box marked
902 \q{Avoid ever using icon title}, you can arrange that PuTTY will
903 always display the window title, and completely ignore any icon
904 titles the server sends it.
905
906 \S{config-mouseptr} \q{Hide mouse pointer when typing in window}
907
908 \cfg{winhelp-topic}{appearance.hidemouse}
909
910 If you enable this option, the mouse pointer will disappear if the
911 PuTTY window is selected and you press a key. This way, it will not
912 obscure any of the text in the window while you work in your
913 session. As soon as you move the mouse, the pointer will reappear.
914
915 This option is disabled by default, so the mouse pointer remains
916 visible at all times.
917
918 \S{config-winborder} Controlling the window border
919
920 \cfg{winhelp-topic}{appearance.border}
921
922 PuTTY allows you to configure the appearance of the window border to
923 some extent.
924
925 The checkbox marked \q{Sunken-edge border} changes the appearance of
926 the window border to something more like a DOS box: the inside edge
927 of the border is highlighted as if it sank down to meet the surface
928 inside the window. This makes the border a little bit thicker as
929 well. It's hard to describe well. Try it and see if you like it.
930
931 You can also configure a completely blank gap between the text in
932 the window and the border, using the \q{Gap between text and window
933 edge} control. By default this is set at one pixel. You can reduce
934 it to zero, or increase it further.
935
936 \H{config-behaviour} The Behaviour panel
937
938 The Behaviour configuration panel allows you to control aspects of
939 the behaviour of PuTTY's window.
940
941 \S{config-warnonclose} \q{Warn before closing window}
942
943 \cfg{winhelp-topic}{behaviour.closewarn}
944
945 If you press the Close button in a PuTTY window that contains a
946 running session, PuTTY will put up a warning window asking if you
947 really meant to close the window. A window whose session has already
948 terminated can always be closed without a warning.
949
950 If you want to be able to close a window quickly, you can disable
951 the \q{Warn before closing window} option.
952
953 \S{config-altf4} \q{Window closes on ALT-F4}
954
955 \cfg{winhelp-topic}{behaviour.altf4}
956
957 By default, pressing ALT-F4 causes the window to close (or a warning
958 box to appear; see \k{config-warnonclose}). If you disable the
959 \q{Window closes on ALT-F4} option, then pressing ALT-F4 will simply
960 send a key sequence to the server.
961
962 \S{config-altspace} \q{System menu appears on ALT-Space}
963
964 \cfg{winhelp-topic}{behaviour.altspace}
965
966 If this option is enabled, then pressing ALT-Space will bring up the
967 PuTTY window's menu, like clicking on the top left corner. If it is
968 disabled, then pressing ALT-Space will just send \c{ESC SPACE} to
969 the server.
970
971 Some accessibility programs for Windows may need this option
972 enabling to be able to control PuTTY's window successfully. For
973 instance, Dragon NaturallySpeaking requires it both to open the
974 system menu via voice, and to close, minimise, maximise and restore
975 the window.
976
977 \S{config-altonly} \q{System menu appears on Alt alone}
978
979 \cfg{winhelp-topic}{behaviour.altonly}
980
981 If this option is enabled, then pressing and releasing ALT will
982 bring up the PuTTY window's menu, like clicking on the top left
983 corner. If it is disabled, then pressing and releasing ALT will have
984 no effect.
985
986 \S{config-alwaysontop} \q{Ensure window is always on top}
987
988 \cfg{winhelp-topic}{behaviour.alwaysontop}
989
990 If this option is enabled, the PuTTY window will stay on top of all
991 other windows.
992
993 \S{config-fullscreen} \q{Full screen on Alt-Enter}
994
995 \cfg{winhelp-topic}{behaviour.altenter}
996
997 If this option is enabled, then pressing Alt-Enter will cause the
998 PuTTY window to become full-screen. Pressing Alt-Enter again will
999 restore the previous window size.
1000
1001 The full-screen feature is also available from the System menu, even
1002 when it is configured not to be available on the Alt-Enter key. See
1003 \k{using-fullscreen}.
1004
1005 \H{config-translation} The Translation panel
1006
1007 The Translation configuration panel allows you to control the
1008 translation between the character set understood by the server and
1009 the character set understood by PuTTY.
1010
1011 \S{config-charset} Controlling character set translation
1012
1013 \cfg{winhelp-topic}{translation.codepage}
1014
1015 During an interactive session, PuTTY receives a stream of 8-bit
1016 bytes from the server, and in order to display them on the screen it
1017 needs to know what character set to interpret them in.
1018
1019 There are a lot of character sets to choose from. The \q{Received
1020 data assumed to be in which character set} option lets you select
1021 one. By default PuTTY will attempt to choose a character set that is
1022 right for your locale as reported by Windows; if it gets it wrong,
1023 you can select a different one using this control.
1024
1025 A few notable character sets are:
1026
1027 \b The ISO-8859 series are all standard character sets that include
1028 various accented characters appropriate for different sets of
1029 languages.
1030
1031 \b The Win125x series are defined by Microsoft, for similar
1032 purposes. In particular Win1252 is almost equivalent to ISO-8859-1,
1033 but contains a few extra characters such as matched quotes and the
1034 Euro symbol.
1035
1036 \b If you want the old IBM PC character set with block graphics and
1037 line-drawing characters, you can select \q{CP437}.
1038
1039 \b PuTTY also supports Unicode mode, in which the data coming from
1040 the server is interpreted as being in the UTF-8 encoding of Unicode.
1041 If you select \q{UTF-8} as a character set you can use this mode.
1042 Not all server-side applications will support it.
1043
1044 If you need support for a numeric code page which is not listed in
1045 the drop-down list, such as code page 866, then you should be able
1046 to enter its name manually (\c{CP866} for example) in the list box
1047 and get the right result.
1048
1049 \S{config-cyr} \q{Caps Lock acts as Cyrillic switch}
1050
1051 \cfg{winhelp-topic}{translation.cyrillic}
1052
1053 This feature allows you to switch between a US/UK keyboard layout
1054 and a Cyrillic keyboard layout by using the Caps Lock key, if you
1055 need to type (for example) Russian and English side by side in the
1056 same document.
1057
1058 Currently this feature is not expected to work properly if your
1059 native keyboard layout is not US or UK.
1060
1061 \S{config-linedraw} Controlling display of line drawing characters
1062
1063 \cfg{winhelp-topic}{translation.linedraw}
1064
1065 VT100-series terminals allow the server to send control sequences
1066 that shift temporarily into a separate character set for drawing
1067 lines and boxes. PuTTY has a variety of ways to support this
1068 capability. In general you should probably try lots of options until
1069 you find one that your particular font supports.
1070
1071 \b \q{Font has XWindows encoding} is for use with fonts that have a
1072 special encoding, where the lowest 32 character positions (below the
1073 ASCII printable range) contain the line-drawing characters. This is
1074 unlikely to be the case with any standard Windows font; it will
1075 probably only apply to custom-built fonts or fonts that have been
1076 automatically converted from the X Window System.
1077
1078 \b \q{Use font in both ANSI and OEM modes} tries to use the same
1079 font in two different character sets, to obtain a wider range of
1080 characters. This doesn't always work; some fonts claim to be a
1081 different size depending on which character set you try to use.
1082
1083 \b \q{Use font in OEM mode only} is more reliable than that, but can
1084 miss out other characters from the main character set.
1085
1086 \b \q{Poor man's line drawing} assumes that the font \e{cannot}
1087 generate the line and box characters at all, so it will use the
1088 \c{+}, \c{-} and \c{|} characters to draw approximations to boxes.
1089 You should use this option if none of the other options works.
1090
1091 \b \q{Unicode mode} tries to use the box characters that are present
1092 in Unicode. For good Unicode-supporting fonts this is probably the
1093 most reliable and functional option.
1094
1095 \H{config-selection} The Selection panel
1096
1097 The Selection panel allows you to control the way copy and paste
1098 work in the PuTTY window.
1099
1100 \S{config-linedrawpaste} Controlling the pasting of line drawing
1101 characters
1102
1103 \cfg{winhelp-topic}{selection.linedraw}
1104
1105 By default, when you copy and paste a piece of the PuTTY screen that
1106 contains VT100 line and box drawing characters, PuTTY will translate
1107 them into the \q{poor man's} line-drawing characters \c{+}, \c{-}
1108 and \c{|}. The checkbox \q{Don't translate line drawing chars}
1109 disables this feature, so line-drawing characters will be pasted as
1110 if they were in the normal character set. This will typically mean
1111 they come out mostly as \c{q} and \c{x}, with a scattering of
1112 \c{jklmntuvw} at the corners. This might be useful if you were
1113 trying to recreate the same box layout in another program, for
1114 example.
1115
1116 \S{config-rtfpaste} Pasting in Rich Text Format
1117
1118 \cfg{winhelp-topic}{selection.rtf}
1119
1120 If you enable \q{Paste to clipboard in RTF as well as plain text},
1121 PuTTY will write formatting information to the clipboard as well as
1122 the actual text you copy. Currently the only effect of this will be
1123 that if you paste into (say) a word processor, the text will appear
1124 in the word processor in the same font PuTTY was using to display
1125 it. In future it is likely that other formatting information (bold,
1126 underline, colours) will be copied as well.
1127
1128 This option can easily be inconvenient, so by default it is
1129 disabled.
1130
1131 \S{config-mouse} Changing the actions of the mouse buttons
1132
1133 \cfg{winhelp-topic}{selection.buttons}
1134
1135 PuTTY's copy and paste mechanism is modelled on the Unix \c{xterm}
1136 application. The X Window System uses a three-button mouse, and the
1137 convention is that the left button selects, the right button extends
1138 an existing selection, and the middle button pastes.
1139
1140 Windows typically only has two mouse buttons, so in PuTTY's default
1141 configuration, the \e{right} button pastes, and the \e{middle}
1142 button (if you have one) extends a selection.
1143
1144 If you have a three-button mouse and you are already used to the
1145 \c{xterm} arrangement, you can select it using the \q{Action of
1146 mouse buttons} control.
1147
1148 \S{config-mouseshift} \q{Shift overrides application's use of mouse}
1149
1150 \cfg{winhelp-topic}{selection.shiftdrag}
1151
1152 PuTTY allows the server to send control codes that let it take over
1153 the mouse and use it for purposes other than copy and paste.
1154 Applications which use this feature include the text-mode web
1155 browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
1156 file manager \c{mc} (Midnight Commander).
1157
1158 When running one of these applications, pressing the mouse buttons
1159 no longer performs copy and paste. If you do need to copy and paste,
1160 you can still do so if you hold down Shift while you do your mouse
1161 clicks.
1162
1163 However, it is possible in theory for applications to even detect
1164 and make use of Shift + mouse clicks. We don't know of any
1165 applications that do this, but in case someone ever writes one,
1166 unchecking the \q{Shift overrides application's use of mouse}
1167 checkbox will cause Shift + mouse clicks to go to the server as well
1168 (so that mouse-driven copy and paste will be completely disabled).
1169
1170 If you want to prevent the application from taking over the mouse at
1171 all, you can do this using the Features control panel; see
1172 \k{config-features-mouse}.
1173
1174 \S{config-rectselect} Default selection mode
1175
1176 \cfg{winhelp-topic}{selection.rect}
1177
1178 As described in \k{using-selection}, PuTTY has two modes of
1179 selecting text to be copied to the clipboard. In the default mode
1180 (\q{Normal}), dragging the mouse from point A to point B selects to
1181 the end of the line containing A, all the lines in between, and from
1182 the very beginning of the line containing B. In the other mode
1183 (\q{Rectangular block}), dragging the mouse between two points
1184 defines a rectangle, and everything within that rectangle is copied.
1185
1186 Normally, you have to hold down Alt while dragging the mouse to
1187 select a rectangular block. Using the \q{Default selection mode}
1188 control, you can set rectangular selection as the default, and then
1189 you have to hold down Alt to get the \e{normal} behaviour.
1190
1191 \S{config-charclasses} Configuring word-by-word selection
1192
1193 \cfg{winhelp-topic}{selection.charclasses}
1194
1195 PuTTY will select a word at a time in the terminal window if you
1196 double-click to begin the drag. This panel allows you to control
1197 precisely what is considered to be a word.
1198
1199 Each character is given a \e{class}, which is a small number
1200 (typically 0, 1 or 2). PuTTY considers a single word to be any
1201 number of adjacent characters in the same class. So by modifying the
1202 assignment of characters to classes, you can modify the word-by-word
1203 selection behaviour.
1204
1205 In the default configuration, the character classes are:
1206
1207 \b Class 0 contains white space and control characters.
1208
1209 \b Class 1 contains most punctuation.
1210
1211 \b Class 2 contains letters, numbers and a few pieces of punctuation
1212 (the double quote, minus sign, period, forward slash and
1213 underscore).
1214
1215 So, for example, if you assign the \c{@} symbol into character class
1216 2, you will be able to select an e-mail address with just a double
1217 click.
1218
1219 In order to adjust these assignments, you start by selecting a group
1220 of characters in the list box. Then enter a class number in the edit
1221 box below, and press the \q{Set} button.
1222
1223 This mechanism currently only covers ASCII characters, because it
1224 isn't feasible to expand the list to cover the whole of Unicode.
1225
1226 Character class definitions can be modified by control sequences
1227 sent by the server. This configuration option only controls the
1228 \e{default} state. If you modify this option in mid-session using
1229 \q{Change Settings}, you will need to reset the terminal (see
1230 \k{reset-terminal}) before the change takes effect.
1231
1232 \H{config-colours} The Colours panel
1233
1234 The Colours panel allows you to control PuTTY's use of colour.
1235
1236 \S{config-boldcolour} \q{Bolded text is a different colour}
1237
1238 \cfg{winhelp-topic}{colours.bold}
1239
1240 When the server sends a control sequence indicating that some text
1241 should be displayed in bold, PuTTY can handle this two ways. It can
1242 either change the font for a bold version, or use the same font in a
1243 brighter colour. This control lets you choose which.
1244
1245 By default the box is checked, so non-bold text is displayed in
1246 light grey and bold text is displayed in bright white (and similarly
1247 in other colours). If you uncheck the box, bold and non-bold text
1248 will be displayed in the same colour, and instead the font will
1249 change to indicate the difference.
1250
1251 \S{config-logpalette} \q{Attempt to use logical palettes}
1252
1253 \cfg{winhelp-topic}{colours.logpal}
1254
1255 Logical palettes are a mechanism by which a Windows application
1256 running on an 8-bit colour display can select precisely the colours
1257 it wants instead of going with the Windows standard defaults.
1258
1259 If you are not getting the colours you ask for on an 8-bit display,
1260 you can try enabling this option. However, be warned that it's never
1261 worked very well.
1262
1263 \S{config-colourcfg} Adjusting the colours in the terminal window
1264
1265 \cfg{winhelp-topic}{colours.config}
1266
1267 The main colour control allows you to specify exactly what colours
1268 things should be displayed in. To modify one of the PuTTY colours,
1269 use the list box to select which colour you want to modify. The RGB
1270 values for that colour will appear on the right-hand side of the
1271 list box. Now, if you press the \q{Modify} button, you will be
1272 presented with a colour selector, in which you can choose a new
1273 colour to go in place of the old one.
1274
1275 PuTTY allows you to set the cursor colour, the default foreground
1276 and background, and the precise shades of all the ANSI configurable
1277 colours (black, red, green, yellow, blue, magenta, cyan, and white).
1278 In addition, if you have selected \q{Bolded text is a different
1279 colour}, you can also modify the precise shades used for the bold
1280 versions of these colours.
1281
1282 \H{config-connection} The Connection panel
1283
1284 The Connection panel allows you to configure options that apply to
1285 more than one type of connection.
1286
1287 \S{config-termtype} \q{Terminal-type string}
1288
1289 \cfg{winhelp-topic}{connection.termtype}
1290
1291 Most servers you might connect to with PuTTY are designed to be
1292 connected to from lots of different types of terminal. In order to
1293 send the right control sequences to each one, the server will need
1294 to know what type of terminal it is dealing with. Therefore, each of
1295 the SSH, Telnet and Rlogin protocols allow a text string to be sent
1296 down the connection describing the terminal.
1297
1298 PuTTY attempts to emulate the Unix \c{xterm} program, and by default
1299 it reflects this by sending \c{xterm} as a terminal-type string. If
1300 you find this is not doing what you want - perhaps the remote
1301 terminal reports \q{Unknown terminal type} - you could try setting
1302 this to something different, such as \c{vt220}.
1303
1304 If you're not sure whether a problem is due to the terminal type
1305 setting or not, you probably need to consult the manual for your
1306 application or your server.
1307
1308 \S{config-username} \q{Auto-login username}
1309
1310 \cfg{winhelp-topic}{connection.username}
1311
1312 All three of the SSH, Telnet and Rlogin protocols allow you to
1313 specify what user name you want to log in as, without having to type
1314 it explicitly every time. (Some Telnet servers don't support this.)
1315
1316 In this box you can type that user name.
1317
1318 \S{config-keepalive} Using keepalives to prevent disconnection
1319
1320 \cfg{winhelp-topic}{connection.keepalive}
1321
1322 If you find your sessions are closing unexpectedly (\q{Connection
1323 reset by peer}) after they have been idle for a while, you might
1324 want to try using this option.
1325
1326 Some network routers and firewalls need to keep track of all
1327 connections through them. Usually, these firewalls will assume a
1328 connection is dead if no data is transferred in either direction
1329 after a certain time interval. This can cause PuTTY sessions to be
1330 unexpectedly closed by the firewall if no traffic is seen in the
1331 session for some time.
1332
1333 The keepalive option (\q{Seconds between keepalives}) allows you to
1334 configure PuTTY to send data through the session at regular
1335 intervals, in a way that does not disrupt the actual terminal
1336 session. If you find your firewall is cutting idle connections off,
1337 you can try entering a non-zero value in this field. The value is
1338 measured in seconds; so, for example, if your firewall cuts
1339 connections off after ten minutes then you might want to enter 300
1340 seconds (5 minutes) in the box.
1341
1342 Note that keepalives are not always helpful. They help if you have a
1343 firewall which drops your connection after an idle period; but if
1344 the network between you and the server suffers from breaks in
1345 connectivity then keepalives can actually make things worse. If a
1346 session is idle, and connectivity is temporarily lost between the
1347 endpoints, but the connectivity is restored before either side tries
1348 to send anything, then there will be no problem - neither endpoint
1349 will notice that anything was wrong. However, if one side does send
1350 something during the break, it will repeatedly try to re-send, and
1351 eventually give up and abandon the connection. Then when
1352 connectivity is restored, the other side will find that the first
1353 side doesn't believe there is an open connection any more.
1354 Keepalives can make this sort of problem worse, because they
1355 increase the probability that PuTTY will attempt to send data during
1356 a break in connectivity. Therefore, you might find they help
1357 connection loss, or you might find they make it worse, depending on
1358 what \e{kind} of network problems you have between you and the
1359 server.
1360
1361 Keepalives are only supported in Telnet and SSH; the Rlogin and Raw
1362 protocols offer no way of implementing them.
1363
1364 Note that if you are using SSH1 and the server has a bug that makes
1365 it unable to deal with SSH1 ignore messages (see
1366 \k{config-ssh-bug-ignore1}), enabling keepalives will have no effect.
1367
1368 \S{config-nodelay} \q{Disable Nagle's algorithm}
1369
1370 \cfg{winhelp-topic}{connection.nodelay}
1371
1372 Nagle's algorithm is a detail of TCP/IP implementations that tries
1373 to minimise the number of small data packets sent down a network
1374 connection. With Nagle's algorithm enabled, PuTTY's bandwidth usage
1375 will be slightly more efficient; with it disabled, you may find you
1376 get a faster response to your keystrokes when connecting to some
1377 types of server.
1378
1379 The Nagle algorithm is disabled by default.
1380
1381 \H{config-proxy} The Proxy panel
1382
1383 \cfg{winhelp-topic}{proxy.main}
1384
1385 The Proxy panel allows you to configure PuTTY to use various types
1386 of proxy in order to make its network connections. The settings in
1387 this panel affect the primary network connection forming your PuTTY
1388 session, but also any extra connections made as a result of SSH port
1389 forwarding (see \k{using-port-forwarding}).
1390
1391 \S{config-proxy-type} Setting the proxy type
1392
1393 \cfg{winhelp-topic}{proxy.type}
1394
1395 The \q{Proxy type} radio buttons allow you to configure what type of
1396 proxy you want PuTTY to use for its network connections. The default
1397 setting is \q{None}; in this mode no proxy is used for any
1398 connection.
1399
1400 \b Selecting \q{HTTP} allows you to proxy your connections through a
1401 web server supporting the HTTP \cw{CONNECT} command, as documented
1402 in \W{http://www.ietf.org/rfc/rfc2817.txt}{RFC 2817}.
1403
1404 \b Selecting \q{SOCKS} allows you to proxy your connections through
1405 a SOCKS server.
1406
1407 \b Many firewalls implement a less formal type of proxy in which a
1408 user can make a Telnet connection directly to the firewall machine
1409 and enter a command such as \c{connect myhost.com 22} to connect
1410 through to an external host. Selecting \q{Telnet} allows you to tell
1411 PuTTY to use this type of proxy.
1412
1413 \S{config-proxy-exclude} Excluding parts of the network from proxying
1414
1415 \cfg{winhelp-topic}{proxy.exclude}
1416
1417 Typically you will only need to use a proxy to connect to non-local
1418 parts of your network; for example, your proxy might be required for
1419 connections outside your company's internal network. In the
1420 \q{Exclude Hosts/IPs} box you can enter ranges of IP addresses, or
1421 ranges of DNS names, for which PuTTY will avoid using the proxy and
1422 make a direct connection instead.
1423
1424 The \q{Exclude Hosts/IPs} box may contain more than one exclusion
1425 range, separated by commas. Each range can be an IP address or a DNS
1426 name, with a \c{*} character allowing wildcards. For example:
1427
1428 \c *.example.com
1429
1430 This excludes any host with a name ending in \c{.example.com} from
1431 proxying.
1432
1433 \c 192.168.88.*
1434
1435 This excludes any host with an IP address starting with 192.168.88
1436 from proxying.
1437
1438 \c 192.168.88.*,*.example.com
1439
1440 This excludes both of the above ranges at once.
1441
1442 Connections to the local host (the host name \c{localhost}, and any
1443 loopback IP address) are never proxied, even if the proxy exclude
1444 list does not explicitly contain them. It is very unlikely that this
1445 behaviour would ever cause problems, but if it does you can change
1446 it by enabling \q{Consider proxying local host connections}.
1447
1448 \S{config-proxy-auth} Username and password
1449
1450 \cfg{winhelp-topic}{proxy.auth}
1451
1452 If your proxy requires authentication, you can enter a username and
1453 a password in the \q{Username} and \q{Password} boxes.
1454
1455 Authentication is not supported for all forms of proxy:
1456
1457 \b Username and password authentication is supported for HTTP
1458 proxies and SOCKS 5 proxies.
1459
1460 \b SOCKS 4 can use the \q{Username} field, but does not support
1461 passwords.
1462
1463 \b You can specify a way to include a username and password in the
1464 Telnet proxy command (see \k{config-proxy-command}).
1465
1466 \S{config-proxy-command} Specifying the Telnet proxy command
1467
1468 \cfg{winhelp-topic}{proxy.command}
1469
1470 If you are using the Telnet proxy type, the usual command required
1471 by the firewall's Telnet server is \c{connect}, followed by a host
1472 name and a port number. If your proxy needs a different command,
1473 you can enter an alternative here.
1474
1475 In this string, you can use \c{\\n} to represent a new-line, \c{\\r}
1476 to represent a carriage return, \c{\\t} to represent a tab
1477 character, and \c{\\x} followed by two hex digits to represent any
1478 other character. \c{\\\\} is used to encode the \c{\\} character
1479 itself.
1480
1481 Also, the special strings \c{%host} and \c{%port} will be replaced
1482 by the host name and port number you want to connect to. The strings
1483 \c{%user} and \c{%pass} will be replaced by the proxy username and
1484 password you specify. To get a literal \c{%} sign, enter \c{%%}.
1485
1486 If the Telnet proxy server prompts for a username and password
1487 before commands can be sent, you can use a command such as:
1488
1489 \c %user\\n%pass\\nconnect %host %port\\n
1490
1491 This will send your username and password as the first two lines to
1492 the proxy, followed by a command to connect to the desired host and
1493 port. Note that if you do not include the \c{%user} or \c{%pass}
1494 tokens in the Telnet command, then the \q{Username} and \q{Password}
1495 configuration fields will be ignored.
1496
1497 \S{config-proxy-socksver} Selecting the version of the SOCKS protocol
1498
1499 \cfg{winhelp-topic}{proxy.socksver}
1500
1501 SOCKS servers exist in two versions: version 5
1502 (\W{http://www.ietf.org/rfc/rfc1928.txt}{RFC 1928}) and the earlier
1503 version 4. The \q{SOCKS Version} radio buttons allow you to select
1504 which one to use, if you have selected the SOCKS proxy type.
1505
1506 \H{config-telnet} The Telnet panel
1507
1508 The Telnet panel allows you to configure options that only apply to
1509 Telnet sessions.
1510
1511 \S{config-termspeed} \q{Terminal-speed string}
1512
1513 \cfg{winhelp-topic}{telnet.termspeed}
1514
1515 Telnet allows the client to send a text string that describes the
1516 terminal speed. PuTTY lets you configure this, in case you find the
1517 server is reacting badly to the default value. (I'm not aware of any
1518 servers that do have a problem with it.)
1519
1520 \S{config-environ} Setting environment variables on the server
1521
1522 \cfg{winhelp-topic}{telnet.environ}
1523
1524 The Telnet protocol also provides a means for the client to pass
1525 environment variables to the server. Many Telnet servers have
1526 stopped supporting this feature due to security flaws, but PuTTY
1527 still supports it for the benefit of any servers which have found
1528 other ways around the security problems than just disabling the
1529 whole mechanism.
1530
1531 To add an environment variable to the list transmitted down the
1532 connection, you enter the variable name in the \q{Variable} box,
1533 enter its value in the \q{Value} box, and press the \q{Add} button.
1534 To remove one from the list, select it in the list box and press
1535 \q{Remove}.
1536
1537 \S{config-oldenviron} \q{Handling of OLD_ENVIRON ambiguity}
1538
1539 \cfg{winhelp-topic}{telnet.oldenviron}
1540
1541 The original Telnet mechanism for passing environment variables was
1542 badly specified. At the time the standard (RFC 1408) was written,
1543 BSD telnet implementations were already supporting the feature, and
1544 the intention of the standard was to describe the behaviour the BSD
1545 implementations were already using.
1546
1547 Sadly there was a typing error in the standard when it was issued,
1548 and two vital function codes were specified the wrong way round. BSD
1549 implementations did not change, and the standard was not corrected.
1550 Therefore, it's possible you might find either BSD or RFC-compliant
1551 implementations out there. This switch allows you to choose which
1552 one PuTTY claims to be.
1553
1554 The problem was solved by issuing a second standard, defining a new
1555 Telnet mechanism called \cw{NEW_ENVIRON}, which behaved exactly like
1556 the original \cw{OLD_ENVIRON} but was not encumbered by existing
1557 implementations. Most Telnet servers now support this, and it's
1558 unambiguous. This feature should only be needed if you have trouble
1559 passing environment variables to quite an old server.
1560
1561 \S{config-ptelnet} Passive and active Telnet negotiation modes
1562
1563 \cfg{winhelp-topic}{telnet.passive}
1564
1565 In a Telnet connection, there are two types of data passed between
1566 the client and the server: actual text, and \e{negotiations} about
1567 which Telnet extra features to use.
1568
1569 PuTTY can use two different strategies for negotiation:
1570
1571 \b In \e{active} mode, PuTTY starts to send negotiations as soon as
1572 the connection is opened.
1573
1574 \b In \e{passive} mode, PuTTY will wait to negotiate until it sees a
1575 negotiation from the server.
1576
1577 The obvious disadvantage of passive mode is that if the server is
1578 also operating in a passive mode, then negotiation will never begin
1579 at all. For this reason PuTTY defaults to active mode.
1580
1581 However, sometimes passive mode is required in order to successfully
1582 get through certain types of firewall and Telnet proxy server. If
1583 you have confusing trouble with a firewall, you could try enabling
1584 passive mode to see if it helps.
1585
1586 \S{config-telnetkey} \q{Keyboard sends telnet Backspace and Interrupt}
1587
1588 \cfg{winhelp-topic}{telnet.specialkeys}
1589
1590 If this box is checked, the Backspace key on the keyboard will send
1591 the Telnet special backspace code, and Control-C will send the
1592 Telnet special interrupt code. You probably shouldn't enable this
1593 unless you know what you're doing.
1594
1595 \S{config-telnetnl} \q{Return key sends telnet New Line instead of ^M}
1596
1597 \cfg{winhelp-topic}{telnet.newline}
1598
1599 Unlike most other remote login protocols, the Telnet protocol has a
1600 special \q{new line} code that is not the same as the usual line
1601 endings of Control-M or Control-J. By default, PuTTY sends the
1602 Telnet New Line code when you press Return, instead of sending
1603 Control-M as it does in most other protocols.
1604
1605 Most Unix-style Telnet servers don't mind whether they receive
1606 Telnet New Line or Control-M; some servers do expect New Line, and
1607 some servers prefer to see ^M. If you are seeing surprising
1608 behaviour when you press Return in a Telnet session, you might try
1609 turning this option off to see if it helps.
1610
1611 \H{config-rlogin} The Rlogin panel
1612
1613 The Rlogin panel allows you to configure options that only apply to
1614 Rlogin sessions.
1615
1616 \S{config-rlogin-termspeed} \q{Terminal-speed string}
1617
1618 \cfg{winhelp-topic}{rlogin.termspeed}
1619
1620 Like Telnet, Rlogin allows the client to send a text string that
1621 describes the terminal speed. PuTTY lets you configure this, in case
1622 you find the server is reacting badly to the default value. (I'm not
1623 aware of any servers that do have a problem with it.)
1624
1625 \S{config-rlogin-localuser} \q{Local username}
1626
1627 \cfg{winhelp-topic}{rlogin.localuser}
1628
1629 Rlogin allows an automated (password-free) form of login by means of
1630 a file called \c{.rhosts} on the server. You put a line in your
1631 \c{.rhosts} file saying something like \c{jbloggs@pc1.example.com},
1632 and then when you make an Rlogin connection the client transmits the
1633 username of the user running the Rlogin client. The server checks
1634 the username and hostname against \c{.rhosts}, and if they match it
1635 does not ask for a password.
1636
1637 This only works because Unix systems contain a safeguard to stop a
1638 user from pretending to be another user in an Rlogin connection.
1639 Rlogin connections have to come from port numbers below 1024, and
1640 Unix systems prohibit this to unprivileged processes; so when the
1641 server sees a connection from a low-numbered port, it assumes the
1642 client end of the connection is held by a privileged (and therefore
1643 trusted) process, so it believes the claim of who the user is.
1644
1645 Windows does not have this restriction: \e{any} user can initiate an
1646 outgoing connection from a low-numbered port. Hence, the Rlogin
1647 \c{.rhosts} mechanism is completely useless for securely
1648 distinguishing several different users on a Windows machine. If you
1649 have a \c{.rhosts} entry pointing at a Windows PC, you should assume
1650 that \e{anyone} using that PC can spoof your username in an Rlogin
1651 connection and access your account on the server.
1652
1653 The \q{Local username} control allows you to specify what user name
1654 PuTTY should claim you have, in case it doesn't match your Windows
1655 user name (or in case you didn't bother to set up a Windows user
1656 name).
1657
1658 \H{config-ssh} The SSH panel
1659
1660 The SSH panel allows you to configure options that only apply to
1661 SSH sessions.
1662
1663 \S{config-command} Executing a specific command on the server
1664
1665 \cfg{winhelp-topic}{ssh.command}
1666
1667 In SSH, you don't have to run a general shell session on the server.
1668 Instead, you can choose to run a single specific command (such as a
1669 mail user agent, for example). If you want to do this, enter the
1670 command in the \q{Remote command} box.
1671
1672 \S{config-ssh-pty} \q{Don't allocate a pseudo-terminal}
1673
1674 \cfg{winhelp-topic}{ssh.nopty}
1675
1676 When connecting to a Unix system, most interactive shell sessions
1677 are run in a \e{pseudo-terminal}, which allows the Unix system to
1678 pretend it's talking to a real physical terminal device but allows
1679 the SSH server to catch all the data coming from that fake device
1680 and send it back to the client.
1681
1682 Occasionally you might find you have a need to run a session \e{not}
1683 in a pseudo-terminal. In PuTTY, this is generally only useful for
1684 very specialist purposes; although in Plink (see \k{plink}) it is
1685 the usual way of working.
1686
1687 \S{config-ssh-comp} \q{Enable compression}
1688
1689 \cfg{winhelp-topic}{ssh.compress}
1690
1691 This enables data compression in the SSH connection: data sent by
1692 the server is compressed before sending, and decompressed at the
1693 client end. Likewise, data sent by PuTTY to the server is compressed
1694 first and the server decompresses it at the other end. This can help
1695 make the most of a low-bandwidth connection.
1696
1697 \S{config-ssh-prot} \q{Preferred SSH protocol version}
1698
1699 \cfg{winhelp-topic}{ssh.protocol}
1700
1701 This allows you to select whether you would like to use SSH protocol
1702 version 1 or version 2. \#{FIXME: say something about this elsewhere?}
1703
1704 PuTTY will attempt to use protocol 1 if the server you connect to
1705 does not offer protocol 2, and vice versa.
1706
1707 If you select \q{1 only} or \q{2 only} here, PuTTY will only connect
1708 if the server you connect to offers the SSH protocol version you
1709 have specified.
1710
1711 \S{config-ssh-encryption} Encryption algorithm selection
1712
1713 \cfg{winhelp-topic}{ssh.ciphers}
1714
1715 PuTTY supports a variety of different encryption algorithms, and
1716 allows you to choose which one you prefer to use. You can do this by
1717 dragging the algorithms up and down in the list box (or moving them
1718 using the Up and Down buttons) to specify a preference order. When
1719 you make an SSH connection, PuTTY will search down the list from the
1720 top until it finds an algorithm supported by the server, and then
1721 use that.
1722
1723 If the algorithm PuTTY finds is below the \q{warn below here} line,
1724 you will see a warning box when you make the connection:
1725
1726 \c The first cipher supported by the server
1727 \c is single-DES, which is below the configured
1728 \c warning threshold.
1729 \c Do you want to continue with this connection?
1730
1731 This warns you that the first available encryption is not a very
1732 secure one. Typically you would put the \q{warn below here} line
1733 between the encryptions you consider secure and the ones you
1734 consider substandard. By default, PuTTY supplies a preference order
1735 intended to reflect a reasonable preference in terms of security and
1736 speed.
1737
1738 In SSH-2, the encryption algorithm is negotiated independently for
1739 each direction of the connection, although PuTTY does not support
1740 separate configuration of the preference orders. As a result you may
1741 get two warnings similar to the one above, possibly with different
1742 encryptions.
1743
1744 Single-DES is not supported natively in the SSH 2 draft protocol
1745 standards. One or two server implementations do support it, by a
1746 non-standard name. PuTTY can use single-DES to interoperate with
1747 these servers if you enable the \q{Enable non-standard single-DES in
1748 SSH 2} option; by default this is disabled and PuTTY will stick to
1749 the standard.
1750
1751 \H{config-ssh-auth} The Auth panel
1752
1753 The Auth panel allows you to configure authentication options for
1754 SSH sessions.
1755
1756 \S{config-ssh-tis} \q{Attempt TIS or CryptoCard authentication}
1757
1758 \cfg{winhelp-topic}{ssh.auth.tis}
1759
1760 TIS and CryptoCard authentication are simple challenge/response
1761 forms of authentication available in SSH protocol version 1 only.
1762 You might use them if you were using S/Key one-time passwords, for
1763 example, or if you had a physical security token that generated
1764 responses to authentication challenges.
1765
1766 With this switch enabled, PuTTY will attempt these forms of
1767 authentication if the server is willing to try them. You will be
1768 presented with a challenge string (which will be different every
1769 time) and must supply the correct response in order to log in. If
1770 your server supports this, you should talk to your system
1771 administrator about precisely what form these challenges and
1772 responses take.
1773
1774 \S{config-ssh-ki} \q{Attempt keyboard-interactive authentication}
1775
1776 \cfg{winhelp-topic}{ssh.auth.ki}
1777
1778 The SSH 2 equivalent of TIS authentication is called
1779 \q{keyboard-interactive}. It is a flexible authentication method
1780 using an arbitrary sequence of requests and responses; so it is not
1781 only useful for challenge/response mechanisms such as S/Key, but it
1782 can also be used for (for example) asking the user for a new
1783 password when the old one has expired.
1784
1785 PuTTY leaves this option enabled by default, but supplies a switch
1786 to turn it off in case you should have trouble with it.
1787
1788 \S{config-ssh-agentfwd} \q{Allow agent forwarding}
1789
1790 \cfg{winhelp-topic}{ssh.auth.agentfwd}
1791
1792 This option allows the SSH server to open forwarded connections back
1793 to your local copy of Pageant. If you are not running Pageant, this
1794 option will do nothing.
1795
1796 See \k{pageant} for general information on Pageant, and
1797 \k{pageant-forward} for information on agent forwarding. Note that
1798 there is a security risk involved with enabling this option; see
1799 \k{pageant-security} for details.
1800
1801 \S{config-ssh-changeuser} \q{Allow attempted changes of username in SSH2}
1802
1803 \cfg{winhelp-topic}{ssh.auth.changeuser}
1804
1805 In the SSH 1 protocol, it is impossible to change username after
1806 failing to authenticate. So if you mis-type your username at the
1807 PuTTY \q{login as:} prompt, you will not be able to change it except
1808 by restarting PuTTY.
1809
1810 The SSH 2 protocol \e{does} allow changes of username, in principle,
1811 but does not make it mandatory for SSH 2 servers to accept them. In
1812 particular, OpenSSH does not accept a change of username; once you
1813 have sent one username, it will reject attempts to try to
1814 authenticate as another user. (Depending on the version of OpenSSH,
1815 it may quietly return failure for all login attempts, or it may send
1816 an error message.)
1817
1818 For this reason, PuTTY will by default not prompt you for your
1819 username more than once, in case the server complains. If you know
1820 your server can cope with it, you can enable the \q{Allow attempted
1821 changes of username} option to modify PuTTY's behaviour.
1822
1823 \S{config-ssh-privkey} \q{Private key file for authentication}
1824
1825 \cfg{winhelp-topic}{ssh.auth.privkey}
1826
1827 This box is where you enter the name of your private key file if you
1828 are using public key authentication. See \k{pubkey} for information
1829 about public key authentication in SSH.
1830
1831 \H{config-ssh-tunnels} The Tunnels panel
1832
1833 The Tunnels panel allows you to configure tunnelling of other
1834 connection types through an SSH connection.
1835
1836 \S{config-ssh-x11} X11 forwarding
1837
1838 \cfg{winhelp-topic}{ssh.tunnels.x11}
1839
1840 If your server lets you run X Window System applications, X11
1841 forwarding allows you to securely give those applications access to
1842 a local X display on your PC.
1843
1844 To enable X11 forwarding, check the \q{Enable X11 forwarding} box.
1845 If your X display is not the primary display on your local machine
1846 (which it almost certainly will be unless you have deliberately
1847 arranged otherwise), you need to enter its location in the \q{X
1848 display location} box.
1849
1850 See \k{using-x-forwarding} for more information about X11
1851 forwarding.
1852
1853 \S{config-ssh-portfwd} Port forwarding
1854
1855 \cfg{winhelp-topic}{ssh.tunnels.portfwd}
1856
1857 Port forwarding allows you to tunnel other types of network
1858 connection down an SSH session. See \k{using-port-forwarding} for a
1859 general discussion of port forwarding and how it works.
1860
1861 The port forwarding section in the Tunnels panel shows a list of all
1862 the port forwardings that PuTTY will try to set up when it connects
1863 to the server. By default no port forwardings are set up, so this
1864 list is empty.
1865
1866 To add a port forwarding:
1867
1868 \b Set one of the \q{Local} or \q{Remote} radio buttons, depending
1869 on whether you want to forward a local port to a remote destination
1870 (\q{Local}) or forward a remote port to a local destination
1871 (\q{Remote}).
1872
1873 \b Enter a source port number into the \q{Source port} box. For
1874 local forwardings, PuTTY will listen on this port of your PC. For
1875 remote forwardings, your SSH server will listen on this port of the
1876 remote machine. Note that most servers will not allow you to listen
1877 on port numbers less than 1024.
1878
1879 \b Enter a hostname and port number separated by a colon, in the
1880 \q{Destination} box. Connections received on the source port will be
1881 directed to this destination. For example, to connect to a POP-3
1882 server, you might enter \c{popserver.example.com:110}.
1883
1884 \b Click the \q{Add} button. Your forwarding details should appear
1885 in the list box.
1886
1887 To remove a port forwarding, simply select its details in the list
1888 box, and click the \q{Remove} button.
1889
1890 In the \q{Source port} box, you can also optionally enter an IP
1891 address to listen on. Typically a Windows machine can be asked to
1892 listen on any single IP address in the \cw{127.*.*.*} range, and all
1893 of these are loopback addresses available only to the local machine.
1894 So if you forward (for example) \c{127.0.0.5:79} to a remote
1895 machine's \cw{finger} port, then you should be able to run commands
1896 such as \c{finger fred@127.0.0.5}. This can be useful if the program
1897 connecting to the forwarded port doesn't allow you to change the
1898 port number it uses. This feature is available for local-to-remote
1899 forwarded ports; SSH1 is unable to support it for remote-to-local
1900 ports, while SSH2 can support it in theory but servers will not
1901 necessarily cooperate.
1902
1903 \S{config-ssh-portfwd-localhost} Controlling the visibility of
1904 forwarded ports
1905
1906 \cfg{winhelp-topic}{ssh.tunnels.portfwd.localhost}
1907
1908 The source port for a forwarded connection usually does not accept
1909 connections from any machine except the SSH client or server machine
1910 itself (for local and remote forwardings respectively). There are
1911 controls in the Tunnels panel to change this:
1912
1913 \b The \q{Local ports accept connections from other hosts} option
1914 allows you to set up local-to-remote port forwardings in such a way
1915 that machines other than your client PC can connect to the forwarded
1916 port.
1917
1918 \b The \q{Remote ports do the same} option does the same thing for
1919 remote-to-local port forwardings (so that machines other than the
1920 SSH server machine can connect to the forwarded port.) Note that
1921 this feature is only available in the SSH 2 protocol, and not all
1922 SSH 2 servers support it (OpenSSH 3.0 does not, for example).
1923
1924 \H{config-ssh-bugs} The Bugs panel
1925
1926 Not all SSH servers work properly. Various existing servers have
1927 bugs in them, which can make it impossible for a client to talk to
1928 them unless it knows about the bug and works around it.
1929
1930 Since most servers announce their software version number at the
1931 beginning of the SSH connection, PuTTY will attempt to detect which
1932 bugs it can expect to see in the server and automatically enable
1933 workarounds. However, sometimes it will make mistakes; if the server
1934 has been deliberately configured to conceal its version number, or
1935 if the server is a version which PuTTY's bug database does not know
1936 about, then PuTTY will not know what bugs to expect.
1937
1938 The Bugs panel allows you to manually configure the bugs PuTTY
1939 expects to see in the server. Each bug can be configured in three
1940 states:
1941
1942 \b \q{Off}: PuTTY will assume the server does not have the bug.
1943
1944 \b \q{On}: PuTTY will assume the server \e{does} have the bug.
1945
1946 \b \q{Auto}: PuTTY will use the server's version number announcement
1947 to try to guess whether or not the server has the bug.
1948
1949 \S{config-ssh-bug-ignore1} \q{Chokes on SSH1 ignore messages}
1950
1951 \cfg{winhelp-topic}{ssh.bugs.ignore1}
1952
1953 An ignore message (SSH_MSG_IGNORE) is a message in the SSH protocol
1954 which can be sent from the client to the server, or from the server
1955 to the client, at any time. Either side is required to ignore the
1956 message whenever it receives it. PuTTY uses ignore messages to hide
1957 the password packet in SSH1, so that a listener cannot tell the
1958 length of the user's password; it also uses ignore messages for
1959 connection keepalives (see \k{config-keepalive}).
1960
1961 If this bug is detected, PuTTY will stop using ignore messages. This
1962 means that keepalives will stop working, and PuTTY will have to fall
1963 back to a secondary defence against SSH1 password-length
1964 eavesdropping. See \k{config-ssh-bug-plainpw1}. If this bug is
1965 enabled when talking to a correct server, the session will succeed,
1966 but keepalives will not work and the session might be more
1967 vulnerable to eavesdroppers than it could be.
1968
1969 This is an SSH1-specific bug. No known SSH2 server fails to deal
1970 with SSH2 ignore messages.
1971
1972 \S{config-ssh-bug-plainpw1} \q{Refuses all SSH1 password camouflage}
1973
1974 \cfg{winhelp-topic}{ssh.bugs.plainpw1}
1975
1976 When talking to an SSH1 server which cannot deal with ignore
1977 messages (see \k{config-ssh-bug-ignore1}), PuTTY will attempt to
1978 disguise the length of the user's password by sending additional
1979 padding \e{within} the password packet. This is technically a
1980 violation of the SSH1 specification, and so PuTTY will only do it
1981 when it cannot use standards-compliant ignore messages as
1982 camouflage. In this sense, for a server to refuse to accept a padded
1983 password packet is not really a bug, but it does make life
1984 inconvenient if the server can also not handle ignore messages.
1985
1986 If this \q{bug} is detected, PuTTY will have no choice but to send
1987 the user's password with no form of camouflage, so that an
1988 eavesdropping user will be easily able to find out the exact length
1989 of the password. If this bug is enabled when talking to a correct
1990 server, the session will succeed, but will be more vulnerable to
1991 eavesdroppers than it could be.
1992
1993 This is an SSH1-specific bug. SSH2 is secure against this type of
1994 attack.
1995
1996 \S{config-ssh-bug-rsa1} \q{Chokes on SSH1 RSA authentication}
1997
1998 \cfg{winhelp-topic}{ssh.bugs.rsa1}
1999
2000 Some SSH1 servers cannot deal with RSA authentication messages at
2001 all. If Pageant is running and contains any SSH1 keys, PuTTY will
2002 normally automatically try RSA authentication before falling back to
2003 passwords, so these servers will crash when they see the RSA attempt.
2004
2005 If this bug is detected, PuTTY will go straight to password
2006 authentication. If this bug is enabled when talking to a correct
2007 server, the session will succeed, but of course RSA authentication
2008 will be impossible.
2009
2010 This is an SSH1-specific bug.
2011
2012 \S{config-ssh-bug-hmac2} \q{Miscomputes SSH2 HMAC keys}
2013
2014 \cfg{winhelp-topic}{ssh.bugs.hmac2}
2015
2016 Versions 2.3.0 and below of the SSH server software from
2017 \cw{ssh.com} compute the keys for their HMAC message authentication
2018 codes incorrectly. A typical symptom of this problem is that PuTTY
2019 dies unexpectedly at the beginning of the session, saying
2020 \q{Incorrect MAC received on packet}.
2021
2022 If this bug is detected, PuTTY will compute its HMAC keys in the
2023 same way as the buggy server, so that communication will still be
2024 possible. If this bug is enabled when talking to a correct server,
2025 communication will fail.
2026
2027 This is an SSH2-specific bug.
2028
2029 \S{config-ssh-bug-derivekey2} \q{Miscomputes SSH2 encryption keys}
2030
2031 \cfg{winhelp-topic}{ssh.bugs.derivekey2}
2032
2033 Versions below 2.1.0 of the SSH server software from \cw{ssh.com}
2034 compute the keys for the session encryption incorrectly. This
2035 problem can cause various error messages, such as \q{Incoming packet
2036 was garbled on decryption}, or possibly even \q{Out of memory}.
2037
2038 If this bug is detected, PuTTY will compute its encryption keys in
2039 the same way as the buggy server, so that communication will still
2040 be possible. If this bug is enabled when talking to a correct
2041 server, communication will fail.
2042
2043 This is an SSH2-specific bug.
2044
2045 \S{config-ssh-bug-sig} \q{Requires padding on SSH2 RSA signatures}
2046
2047 \cfg{winhelp-topic}{ssh.bugs.rsapad2}
2048
2049 Versions below 3.3 of OpenSSH require SSH2 RSA signatures to be
2050 padded with zero bytes to the same length as the RSA key modulus.
2051 The SSH2 draft specification says that an unpadded signature MUST be
2052 accepted, so this is a bug. A typical symptom of this problem is
2053 that PuTTY mysteriously fails RSA authentication once in every few
2054 hundred attempts, and falls back to passwords.
2055
2056 If this bug is detected, PuTTY will pad its signatures in the way
2057 OpenSSH expects. If this bug is enabled when talking to a correct
2058 server, it is likely that no damage will be done, since correct
2059 servers usually still accept padded signatures because they're used
2060 to talking to OpenSSH.
2061
2062 This is an SSH2-specific bug.
2063
2064 \S{config-ssh-bug-dhgex} \q{Chokes on Diffie-Hellman group exchange}
2065
2066 \cfg{winhelp-topic}{ssh.bugs.dhgex2}
2067
2068 We have anecdotal evidence that some SSH servers claim to be able to
2069 perform Diffie-Hellman group exchange, but fail to actually do so
2070 when PuTTY tries to. If your SSH2 sessions spontaneously close
2071 immediately after opening the PuTTY window, it might be worth
2072 enabling the workaround for this bug to see if it helps.
2073
2074 We have no hard evidence that any specific version of specific
2075 server software reliably demonstrates this bug. Therefore, PuTTY
2076 will never \e{assume} a server has this bug; if you want the
2077 workaround, you need to enable it manually.
2078
2079 This is an SSH2-specific bug.
2080
2081 \H{config-file} Storing configuration in a file
2082
2083 PuTTY does not currently support storing its configuration in a file
2084 instead of the Registry. However, you can work around this with a
2085 couple of batch files.
2086
2087 You will need a file called (say) \c{PUTTY.BAT} which imports the
2088 contents of a file into the Registry, then runs PuTTY, exports the
2089 contents of the Registry back into the file, and deletes the
2090 Registry entries. This can all be done using the Regedit command
2091 line options, so it's all automatic. Here is what you need in
2092 \c{PUTTY.BAT}:
2093
2094 \c @ECHO OFF
2095 \c regedit /s putty.reg
2096 \c regedit /s puttyrnd.reg
2097 \c start /w putty.exe
2098 \c regedit /e puttynew.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
2099 \c copy puttynew.reg putty.reg
2100 \c del puttynew.reg
2101 \c regedit /s puttydel.reg
2102
2103 This batch file needs two auxiliary files: \c{PUTTYRND.REG} which
2104 sets up an initial safe location for the \c{PUTTY.RND} random seed
2105 file, and \c{PUTTYDEL.REG} which destroys everything in the Registry
2106 once it's been successfully saved back to the file.
2107
2108 Here is \c{PUTTYDEL.REG}:
2109
2110 \c REGEDIT4
2111 \c
2112 \c [-HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
2113
2114 Here is an example \c{PUTTYRND.REG} file:
2115
2116 \c REGEDIT4
2117 \c
2118 \c [HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
2119 \c "RandSeedFile"="a:\putty.rnd"
2120
2121 You should replace \c{a:\\putty.rnd} with the location where you
2122 want to store your random number data. If the aim is to carry around
2123 PuTTY and its settings on one floppy, you probably want to store it
2124 on the floppy.