Fix Makefile dependencies.
[u/mdw/putty] / doc / config.but
1 \versionid $Id: config.but,v 1.28 2002/03/09 11:47:39 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 \S{config-localecho} \q{Local echo}
339
340 \cfg{winhelp-topic}{terminal.localecho}
341
342 With local echo disabled, characters you type into the PuTTY window
343 are not echoed in the window \e{by PuTTY}. They are simply sent to
344 the server. (The \e{server} might choose to echo them back to you;
345 this can't be controlled from the PuTTY control panel.)
346
347 Some types of session need local echo, and many do not. In its
348 default mode, PuTTY will automatically attempt to deduce whether or
349 not local echo is appropriate for the session you are working in. If
350 you find it has made the wrong decision, you can use this
351 configuration option to override its choice: you can force local
352 echo to be turned on, or force it to be turned off, instead of
353 relying on the automatic detection.
354
355 \S{config-localedit} \q{Local line editing}
356
357 \cfg{winhelp-topic}{terminal.localedit}
358
359 Normally, every character you type into the PuTTY window is sent
360 immediately to the server the moment you type it.
361
362 If you enable local line editing, this changes. PuTTY will let you
363 edit a whole line at a time locally, and the line will only be sent
364 to the server when you press Return. If you make a mistake, you can
365 use the Backspace key to correct it before you press Return, and the
366 server will never see the mistake.
367
368 Since it is hard to edit a line locally without being able to see
369 it, local line editing is mostly used in conjunction with local echo
370 (\k{config-localecho}). This makes it ideal for use in raw mode
371 \#{FIXME} or when connecting to MUDs or talkers. (Although some more
372 advanced MUDs do occasionally turn local line editing on and turn
373 local echo off, in order to accept a password from the user.)
374
375 Some types of session need local line editing, and many do not. In
376 its default mode, PuTTY will automatically attempt to deduce whether
377 or not local line editing is appropriate for the session you are
378 working in. If you find it has made the wrong decision, you can use
379 this configuration option to override its choice: you can force
380 local line editing to be turned on, or force it to be turned off,
381 instead of relying on the automatic detection.
382
383 \H{config-keyboard} The Keyboard panel
384
385 The Keyboard configuration panel allows you to control the behaviour
386 of the keyboard in PuTTY.
387
388 \S{config-backspace} Changing the action of the Backspace key
389
390 \cfg{winhelp-topic}{keyboard.backspace}
391
392 Some terminals believe that the Backspace key should send the same
393 thing to the server as Control-H (ASCII code 8). Other terminals
394 believe that the Backspace key should send ASCII code 127 (usually
395 known as Control-?) so that it can be distinguished from Control-H.
396 This option allows you to choose which code PuTTY generates when you
397 press Backspace.
398
399 If you are connecting to a Unix system, you will probably find that
400 the Unix \c{stty} command lets you configure which the server
401 expects to see, so you might not need to change which one PuTTY
402 generates. On other systems, the server's expectation might be fixed
403 and you might have no choice but to configure PuTTY.
404
405 If you do have the choice, we recommend configuring PuTTY to
406 generate Control-? and configuring the server to expect it, because
407 that allows applications such as \c{emacs} to use Control-H for
408 help.
409
410 \S{config-homeend} Changing the action of the Home and End keys
411
412 \cfg{winhelp-topic}{keyboard.homeend}
413
414 The Unix terminal emulator \c{rxvt} disagrees with the rest of the
415 world about what character sequences should be sent to the server by
416 the Home and End keys.
417
418 \c{xterm}, and other terminals, send \c{ESC [1~} for the Home key,
419 and \c{ESC [4~} for the End key. \c{rxvt} sends \c{ESC [H} for the
420 Home key and \c{ESC [Ow} for the End key.
421
422 If you find an application on which the Home and End keys aren't
423 working, you could try switching this option to see if it helps.
424
425 \S{config-funkeys} Changing the action of the function keys and keypad
426
427 \cfg{winhelp-topic}{keyboard.funkeys}
428
429 This option affects the function keys (F1 to F12) and the top row of
430 the numeric keypad.
431
432 \b In the default mode, labelled \c{ESC [n~}, the function keys
433 generate sequences like \c{ESC [11~}, \c{ESC [12~} and so on. This
434 matches the general behaviour of Digital's terminals.
435
436 \b In Linux mode, F6 to F12 behave just like the default mode, but
437 F1 to F5 generate \c{ESC [[A} through to \c{ESC [[E}. This mimics the
438 Linux virtual console.
439
440 \b In Xterm R6 mode, F5 to F12 behave like the default mode, but F1
441 to F4 generate \c{ESC OP} through to \c{ESC OS}, which are the
442 sequences produced by the top row of the \e{keypad} on Digital's
443 terminals.
444
445 \b In VT400 mode, all the function keys behave like the default
446 mode, but the actual top row of the numeric keypad generates \c{ESC
447 OP} through to \c{ESC OS}.
448
449 \b In VT100+ mode, the function keys generate \c{ESC OP} through to
450 \c{ESC O[}
451
452 \b In SCO mode, the function keys F1 to F12 generate \c{ESC [M}
453 through to \c{ESC [X}. Together with shift, they generate \c{ESC [Y}
454 through to \c{ESC [j}. With control they generate \c{ESC [k} through
455 to \c{ESC [v}, and with shift and control together they generate
456 \c{ESC [w} through to \c{ESC [\{}.
457
458 If you don't know what any of this means, you probably don't need to
459 fiddle with it.
460
461 \S{config-appcursor} Controlling Application Cursor Keys mode
462
463 \cfg{winhelp-topic}{keyboard.appcursor}
464
465 Application Cursor Keys mode is a way for the server to change the
466 control sequences sent by the arrow keys. In normal mode, the arrow
467 keys send \c{ESC [A} through to \c{ESC [D}. In application mode,
468 they send \c{ESC OA} through to \c{ESC OD}.
469
470 Application Cursor Keys mode can be turned on and off by the server,
471 depending on the application. PuTTY allows you to configure the
472 initial state.
473
474 You can also disable application cursor keys mode completely, using
475 the \q{Features} configuration panel; see
476 \k{config-features-application}.
477
478 \S{config-appkeypad} Controlling Application Keypad mode
479
480 \cfg{winhelp-topic}{keyboard.appkeypad}
481
482 Application Keypad mode is a way for the server to change the
483 behaviour of the numeric keypad.
484
485 In normal mode, the keypad behaves like a normal Windows keypad:
486 with NumLock on, the number keys generate numbers, and with NumLock
487 off they act like the arrow keys and Home, End etc.
488
489 In application mode, all the keypad keys send special control
490 sequences, \e{including} Num Lock. Num Lock stops behaving like Num
491 Lock and becomes another function key.
492
493 Depending on which version of Windows you run, you may find the Num
494 Lock light still flashes on and off every time you press Num Lock,
495 even when application mode is active and Num Lock is acting like a
496 function key. This is unavoidable.
497
498 Application keypad mode can be turned on and off by the server,
499 depending on the application. PuTTY allows you to configure the
500 initial state.
501
502 You can also disable application keypad mode completely, using the
503 \q{Features} configuration panel; see
504 \k{config-features-application}.
505
506 \S{config-nethack} Using NetHack keypad mode
507
508 \cfg{winhelp-topic}{keyboard.nethack}
509
510 PuTTY has a special mode for playing NetHack. You can enable it by
511 selecting \q{NetHack} in the \q{Initial state of numeric keypad}
512 control.
513
514 In this mode, the numeric keypad keys 1-9 generate the NetHack
515 movement commands (\cw{hjklyubn}). The 5 key generates the \c{.}
516 command (do nothing).
517
518 Better still, pressing Shift with the keypad keys generates the
519 capital forms of the commands (\cw{HJKLYUBN}), which tells NetHack
520 to keep moving you in the same direction until you encounter
521 something interesting.
522
523 For some reason, this feature only works properly when Num Lock is
524 on. We don't know why.
525
526 \S{config-compose} Enabling a DEC-like Compose key
527
528 \cfg{winhelp-topic}{keyboard.compose}
529
530 DEC terminals have a Compose key, which provides an easy-to-remember
531 way of typing accented characters. You press Compose and then type
532 two more characters. The two characters are \q{combined} to produce
533 an accented character. The choices of character are designed to be
534 easy to remember; for example, composing \q{e} and \q{`} produces
535 the \q{\u00e8{e-grave}} character.
536
537 If you enable the \q{Application and AltGr act as Compose key}
538 option, the Windows Application key and the AltGr key will both have
539 this behaviour.
540
541 \S{config-ctrlalt} \q{Control-Alt is different from AltGr}
542
543 \cfg{winhelp-topic}{keyboard.ctrlalt}
544
545 Some old keyboards do not have an AltGr key, which can make it
546 difficult to type some characters. PuTTY can be configured to treat
547 the key combination Ctrl + Left Alt the same way as the AltGr key.
548
549 By default, this checkbox is checked, and the key combination Ctrl +
550 Left Alt does something completely different. PuTTY's usual handling
551 of the left Alt key is to prefix the Escape (Control-\cw{[})
552 character to whatever character sequence the rest of the keypress
553 would generate. For example, Alt-A generates Escape followed by
554 \c{a}. So Alt-Ctrl-A would generate Escape, followed by Control-A.
555
556 If you uncheck this box, Ctrl-Alt will become a synonym for AltGr,
557 so you can use it to type extra graphic characters if your keyboard
558 has any.
559
560 \H{config-bell} The Bell panel
561
562 The Bell panel controls the terminal bell feature: the server's
563 ability to cause PuTTY to beep at you.
564
565 In the default configuration, when the server sends the character
566 with ASCII code 7 (Control-G), PuTTY will play the Windows Default
567 Beep sound. This is not always what you want the terminal bell
568 feature to do; the Bell panel allows you to configure alternative
569 actions.
570
571 \S{config-bellstyle} \q{Set the style of bell}
572
573 \cfg{winhelp-topic}{bell.style}
574
575 This control allows you to select various different actions to occur
576 on a terminal bell:
577
578 \b Selecting \q{None} disables the bell completely. In this mode,
579 the server can send as many Control-G characters as it likes and
580 nothing at all will happen.
581
582 \b \q{Play Windows Default Sound} is the default setting. It causes
583 the Windows \q{Default Beep} sound to be played. To change what this
584 sound is, or to test it if nothing seems to be happening, use the
585 Sound configurer in the Windows Control Panel.
586
587 \b \q{Play a custom sound file} allows you to specify a particular
588 sound file to be used by PuTTY alone, or even by a particular
589 individual PuTTY session. This allows you to distinguish your PuTTY
590 beeps from any other beeps on the system. If you select this option,
591 you will also need to enter the name of your sound file in the edit
592 control \q{Custom sound file to play as a bell}.
593
594 \b \q{Visual bell} is a silent alternative to a beeping computer. In
595 this mode, when the server sends a Control-G, the whole PuTTY window
596 will flash white for a fraction of a second.
597
598 \S{config-belltaskbar} \q{Taskbar/caption indication on bell}
599
600 \cfg{winhelp-topic}{bell.taskbar}
601
602 This feature controls what happens to the PuTTY window's entry in
603 the Windows Taskbar if a bell occurs while the window does not have
604 the input focus.
605
606 In the default state (\q{Disabled}) nothing unusual happens.
607
608 If you select \q{Steady}, then when a bell occurs and the window is
609 not in focus, the window's Taskbar entry and its title bar will
610 change colour to let you know that PuTTY session is asking for your
611 attention. The change of colour will persist until you select the
612 window, so you can leave several PuTTY windows minimised in your
613 terminal, go away from your keyboard, and be sure not to have missed
614 any important beeps when you get back.
615
616 \q{Flashing} is even more eye-catching: the Taskbar entry will
617 continuously flash on and off until you select the window.
618
619 \S{config-bellovl} \q{Control the bell overload behaviour}
620
621 \cfg{winhelp-topic}{bell.overload}
622
623 A common user error in a terminal session is to accidentally run the
624 Unix command \c{cat} (or equivalent) on an inappropriate file type,
625 such as an executable, image file, or ZIP file. This produces a huge
626 stream of non-text characters sent to the terminal, which typically
627 includes a lot of bell characters. As a result of this the terminal
628 often doesn't stop beeping for ten minutes, and everybody else in
629 the office gets annoyed.
630
631 To try to avoid this behaviour, or any other cause of excessive
632 beeping, PuTTY includes a bell overload management feature. In the
633 default configuration, receiving more than five bell characters in a
634 two-second period will cause the overload feature to activate. Once
635 the overload feature is active, further bells will have no effect at
636 all, so the rest of your binary file will be sent to the screen in
637 silence. After a period of five seconds during which no further
638 bells are received, the overload feature will turn itself off again
639 and bells will be re-enabled.
640
641 If you want this feature completely disabled, you can turn it off
642 using the checkbox \q{Bell is temporarily disabled when over-used}.
643
644 Alternatively, if you like the bell overload feature but don't agree
645 with the settings, you can configure the details: how many bells
646 constitute an overload, how short a time period they have to arrive
647 in to do so, and how much silent time is required before the
648 overload feature will deactivate itself.
649
650 \H{config-features} The Features panel
651
652 PuTTY's terminal emulation is very highly featured, and can do a lot
653 of things under remote server control. Some of these features can
654 cause problems due to buggy or strangely configured server
655 applications.
656
657 The Features configuration panel allows you to disable some of
658 PuTTY's more advanced terminal features, in case they cause trouble.
659
660 \S{config-features-application} Disabling application keypad and cursor keys
661
662 \cfg{winhelp-topic}{features.application}
663
664 Application keypad mode (see \k{config-appkeypad}) and application
665 cursor keys mode (see \k{config-appcursor}) alter the behaviour of
666 the keypad and cursor keys. Some applications enable these modes but
667 then do not deal correctly with the modified keys. You can force
668 these modes to be permanently disabled no matter what the server
669 tries to do.
670
671 \S{config-features-mouse} Disabling \cw{xterm}-style mouse reporting
672
673 \cfg{winhelp-topic}{features.mouse}
674
675 PuTTY allows the server to send control codes that let it take over
676 the mouse and use it for purposes other than copy and paste.
677 Applications which use this feature include the text-mode web
678 browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
679 file manager \c{mc} (Midnight Commander).
680
681 If you find this feature inconvenient, you can disable it using the
682 \q{Disable xterm-style mouse reporting} control. With this box
683 ticked, the mouse will \e{always} do copy and paste in the normal
684 way.
685
686 Note that even if the application takes over the mouse, you can
687 still manage PuTTY's copy and paste by holding down the Shift key
688 while you select and paste, unless you have deliberately turned this
689 feature off (see \k{config-mouseshift}).
690
691 \S{config-features-resize} Disabling remote terminal resizing
692
693 \cfg{winhelp-topic}{features.resize}
694
695 PuTTY has the ability to change the terminal's size and position in
696 response to commands from the server. If you find PuTTY is doing
697 this unexpectedly or inconveniently, you can tell PuTTY not to
698 respond to those server commands.
699
700 \S{config-features-altscreen} Disabling switching to the alternate screen
701
702 \cfg{winhelp-topic}{features.altscreen}
703
704 Many terminals, including PuTTY, support an \q{alternate screen}.
705 This is the same size as the ordinary terminal screen, but separate.
706 Typically a screen-based program such as a text editor might switch
707 the terminal to the alternate screen before starting up. Then at the
708 end of the run, it switches back to the primary screen, and you see
709 the screen contents just as they were before starting the editor.
710
711 Some people prefer this not to happen. If you want your editor to
712 run in the same screen as the rest of your terminal activity, you
713 can disable the alternate screen feature completely.
714
715 \S{config-features-retitle} Disabling remote window title changing
716
717 \cfg{winhelp-topic}{features.retitle}
718
719 PuTTY has the ability to change the window title in response to
720 commands from the server. If you find PuTTY is doing this
721 unexpectedly or inconveniently, you can tell PuTTY not to respond to
722 those server commands.
723
724 \S{config-features-dbackspace} Disabling destructive backspace
725
726 \cfg{winhelp-topic}{features.dbackspace}
727
728 Normally, when PuTTY receives character 127 (^?) from the server, it
729 will perform a \q{destructive backspace}: move the cursor one space
730 left and delete the character under it. This can apparently cause
731 problems in some applications, so PuTTY provides the ability to
732 configure character 127 to perform a normal backspace (without
733 deleting a character) instead.
734
735 \S{config-features-charset} Disabling remote character set
736 configuration
737
738 \cfg{winhelp-topic}{features.charset}
739
740 PuTTY has the ability to change its character set configuration in
741 response to commands from the server. Some programs send these
742 commands unexpectedly or inconveniently. In particular, BitchX (an
743 IRC client) seems to have a habit of reconfiguring the character set
744 to something other than the user intended.
745
746 If you find that accented characters are not showing up the way you
747 expect them to, particularly if you're running BitchX, you could try
748 disabling the remote character set configuration commands.
749
750 \H{config-window} The Window panel
751
752 The Window configuration panel allows you to control aspects of the
753 PuTTY window.
754
755 \S{config-winsize} Setting the size of the PuTTY window
756
757 \cfg{winhelp-topic}{window.size}
758
759 The \q{Rows} and \q{Columns} boxes let you set the PuTTY window to a
760 precise size. Of course you can also drag the window to a new size
761 while a session is running.
762
763 \S{config-winsizelock} What to do when the window is resized
764
765 \cfg{winhelp-topic}{window.resize}
766
767 These options allow you to control what happens when the user tries
768 to resize the PuTTY window.
769
770 When you resize the PuTTY window, one of four things can happen:
771
772 \b Nothing (if you have completely disabled resizes).
773
774 \b The font size can stay the same and the number of rows and
775 columns in the terminal can change.
776
777 \b The number of rows and columns in the terminal can stay the same,
778 and the font size can change.
779
780 \b You can allow PuTTY to change \e{either} the terminal size or the
781 font size. In this mode it will change the terminal size most of the
782 time, but enlarge the font when you maximise the window.
783
784 You can control which of these happens using the \q{Lock terminal
785 size against resizing} and \q{Lock font size against resizing}
786 options. If you lock both, the window will refuse to be resized at
787 all. If you lock just the terminal size, the font size will change
788 when you resize the window. If you lock just the font size, the
789 terminal size will change when you resize the window.
790
791 \S{config-scrollback} Controlling scrollback
792
793 \cfg{winhelp-topic}{window.scrollback}
794
795 These options let you configure the way PuTTY keeps text after it
796 scrolls off the top of the screen (see \k{using-scrollback}).
797
798 The \q{Lines of scrollback} box lets you configure how many lines of
799 text PuTTY keeps. The \q{Display scrollbar} options allow you to
800 hide the scrollbar (although you can still view the scrollback using
801 Shift-PgUp and Shift-PgDn). You can separately configure whether the
802 scrollbar is shown in full-screen mode and in normal modes.
803
804 If you are viewing part of the scrollback when the server sends more
805 text to PuTTY, the screen will revert to showing the current
806 terminal contents. You can disable this behaviour by turning off
807 \q{Reset scrollback on display activity}. You can also make the
808 screen revert when you press a key, by turning on \q{Reset
809 scrollback on keypress}.
810
811 \H{config-appearance} The Appearance panel
812
813 The Appearance configuration panel allows you to control aspects of
814 the appearance of PuTTY's window.
815
816 \S{config-cursor} Controlling the appearance of the cursor
817
818 \cfg{winhelp-topic}{appearance.cursor}
819
820 The \q{Cursor appearance} option lets you configure the cursor to be
821 a block, an underline, or a vertical line. A block cursor becomes an
822 empty box when the window loses focus; an underline or a vertical
823 line becomes dotted.
824
825 The \q{Cursor blinks} option makes the cursor blink on and off. This
826 works in any of the cursor modes.
827
828 \S{config-font} Controlling the font used in the terminal window
829
830 \cfg{winhelp-topic}{appearance.font}
831
832 This option allows you to choose what font, in what size, the PuTTY
833 terminal window uses to display the text in the session. You will be
834 offered a choice from all the fixed-width fonts installed on the
835 system. (VT100-style terminal handling can only deal with fixed-
836 width fonts.)
837
838 \S{config-title} Controlling the window title
839
840 \cfg{winhelp-topic}{appearance.title}
841
842 The \q{Window title} edit box allows you to set the title of the
843 PuTTY window. By default the window title will contain the host name
844 followed by \q{PuTTY}, for example \c{server1.example.com - PuTTY}.
845 If you want a different window title, this is where to set it.
846
847 PuTTY allows the server to send \c{xterm} control sequences which
848 modify the title of the window in mid-session. There is also an
849 \c{xterm} sequence to modify the title of the window's \e{icon}.
850 This makes sense in a windowing system where the window becomes an
851 icon when minimised, such as Windows 3.1 or most X Window System
852 setups; but in the Windows 95-like user interface it isn't as
853 applicable. By default PuTTY's window title and Taskbar caption will
854 change into the server-supplied icon title if you minimise the PuTTY
855 window, and change back to the server-supplied window title if you
856 restore it. (If the server has not bothered to supply a window or
857 icon title, none of this will happen.) By checking the box marked
858 \q{Avoid ever using icon title}, you can arrange that PuTTY will
859 always display the window title, and completely ignore any icon
860 titles the server sends it.
861
862 \S{config-mouseptr} \q{Hide mouse pointer when typing in window}
863
864 \cfg{winhelp-topic}{appearance.hidemouse}
865
866 If you enable this option, the mouse pointer will disappear if the
867 PuTTY window is selected and you press a key. This way, it will not
868 obscure any of the text in the window while you work in your
869 session. As soon as you move the mouse, the pointer will reappear.
870
871 This option is disabled by default, so the mouse pointer remains
872 visible at all times.
873
874 \S{config-winborder} Controlling the window border
875
876 \cfg{winhelp-topic}{appearance.border}
877
878 PuTTY allows you to configure the appearance of the window border to
879 some extent.
880
881 The checkbox marked \q{Sunken-edge border} changes the appearance of
882 the window border to something more like a DOS box: the inside edge
883 of the border is highlighted as if it sank down to meet the surface
884 inside the window. This makes the border a little bit thicker as
885 well. It's hard to describe well. Try it and see if you like it.
886
887 You can also configure a completely blank gap between the text in
888 the window and the border, using the \q{Gap between text and window
889 edge} control. By default this is set at one pixel. You can reduce
890 it to zero, or increase it further.
891
892 \H{config-behaviour} The Behaviour panel
893
894 The Behaviour configuration panel allows you to control aspects of
895 the behaviour of PuTTY's window.
896
897 \S{config-warnonclose} \q{Warn before closing window}
898
899 \cfg{winhelp-topic}{behaviour.closewarn}
900
901 If you press the Close button in a PuTTY window that contains a
902 running session, PuTTY will put up a warning window asking if you
903 really meant to close the window. A window whose session has already
904 terminated can always be closed without a warning.
905
906 If you want to be able to close a window quickly, you can disable
907 the \q{Warn before closing window} option.
908
909 \S{config-altf4} \q{Window closes on ALT-F4}
910
911 \cfg{winhelp-topic}{behaviour.altf4}
912
913 By default, pressing ALT-F4 causes the window to close (or a warning
914 box to appear; see \k{config-warnonclose}). If you disable the
915 \q{Window closes on ALT-F4} option, then pressing ALT-F4 will simply
916 send a key sequence to the server.
917
918 \S{config-altspace} \q{System menu appears on ALT-Space}
919
920 \cfg{winhelp-topic}{behaviour.altspace}
921
922 If this option is enabled, then pressing ALT-Space will bring up the
923 PuTTY window's menu, like clicking on the top left corner. If it is
924 disabled, then pressing ALT-Space will just send \c{ESC SPACE} to
925 the server.
926
927 Some accessibility programs for Windows may need this option
928 enabling to be able to control PuTTY's window successfully. For
929 instance, Dragon NaturallySpeaking requires it both to open the
930 system menu via voice, and to close, minimise, maximise and restore
931 the window.
932
933 \S{config-altonly} \q{System menu appears on Alt alone}
934
935 \cfg{winhelp-topic}{behaviour.altonly}
936
937 If this option is enabled, then pressing and releasing ALT will
938 bring up the PuTTY window's menu, like clicking on the top left
939 corner. If it is disabled, then pressing and releasing ALT will have
940 no effect.
941
942 \S{config-alwaysontop} \q{Ensure window is always on top}
943
944 \cfg{winhelp-topic}{behaviour.alwaysontop}
945
946 If this option is enabled, the PuTTY window will stay on top of all
947 other windows.
948
949 \S{config-fullscreen} \q{Full screen on Alt-Enter}
950
951 \cfg{winhelp-topic}{behaviour.altenter}
952
953 If this option is enabled, then pressing Alt-Enter will cause the
954 PuTTY window to become full-screen. Pressing Alt-Enter again will
955 restore the previous window size.
956
957 The full-screen feature is also available from the System menu, even
958 when it is configured not to be available on the Alt-Enter key. See
959 \k{using-fullscreen}.
960
961 \H{config-translation} The Translation panel
962
963 The Translation configuration panel allows you to control the
964 translation between the character set understood by the server and
965 the character set understood by PuTTY.
966
967 \S{config-charset} Controlling character set translation
968
969 \cfg{winhelp-topic}{translation.codepage}
970
971 During an interactive session, PuTTY receives a stream of 8-bit
972 bytes from the server, and in order to display them on the screen it
973 needs to know what character set to interpret them in.
974
975 There are a lot of character sets to choose from. The \q{Received
976 data assumed to be in which character set} option lets you select
977 one. By default PuTTY will attempt to choose a character set that is
978 right for your locale as reported by Windows; if it gets it wrong,
979 you can select a different one using this control.
980
981 A few notable character sets are:
982
983 \b The ISO-8859 series are all standard character sets that include
984 various accented characters appropriate for different sets of
985 languages.
986
987 \b The Win125x series are defined by Microsoft, for similar
988 purposes. In particular Win1252 is almost equivalent to ISO-8859-1,
989 but contains a few extra characters such as matched quotes and the
990 Euro symbol.
991
992 \b If you want the old IBM PC character set with block graphics and
993 line-drawing characters, you can select \q{CP437}.
994
995 \b PuTTY also supports Unicode mode, in which the data coming from
996 the server is interpreted as being in the UTF-8 encoding of Unicode.
997 If you select \q{UTF-8} as a character set you can use this mode.
998 Not all server-side applications will support it.
999
1000 \S{config-cyr} \q{Caps Lock acts as Cyrillic switch}
1001
1002 \cfg{winhelp-topic}{translation.cyrillic}
1003
1004 This feature allows you to switch between a US/UK keyboard layout
1005 and a Cyrillic keyboard layout by using the Caps Lock key, if you
1006 need to type (for example) Russian and English side by side in the
1007 same document.
1008
1009 Currently this feature is not expected to work properly if your
1010 native keyboard layout is not US or UK.
1011
1012 \S{config-linedraw} Controlling display of line drawing characters
1013
1014 \cfg{winhelp-topic}{translation.linedraw}
1015
1016 VT100-series terminals allow the server to send control sequences
1017 that shift temporarily into a separate character set for drawing
1018 lines and boxes. PuTTY has a variety of ways to support this
1019 capability. In general you should probably try lots of options until
1020 you find one that your particular font supports.
1021
1022 \b \q{Font has XWindows encoding} is for use with fonts that have a
1023 special encoding, where the lowest 32 character positions (below the
1024 ASCII printable range) contain the line-drawing characters. This is
1025 unlikely to be the case with any standard Windows font; it will
1026 probably only apply to custom-built fonts or fonts that have been
1027 automatically converted from the X Window System.
1028
1029 \b \q{Use font in both ANSI and OEM modes} tries to use the same
1030 font in two different character sets, to obtain a wider range of
1031 characters. This doesn't always work; some fonts claim to be a
1032 different size depending on which character set you try to use.
1033
1034 \b \q{Use font in OEM mode only} is more reliable than that, but can
1035 miss out other characters from the main character set.
1036
1037 \b \q{Poor man's line drawing} assumes that the font \e{cannot}
1038 generate the line and box characters at all, so it will use the
1039 \c{+}, \c{-} and \c{|} characters to draw approximations to boxes.
1040 You should use this option if none of the other options works.
1041
1042 \b \q{Unicode mode} tries to use the box characters that are present
1043 in Unicode. For good Unicode-supporting fonts this is probably the
1044 most reliable and functional option.
1045
1046 \H{config-selection} The Selection panel
1047
1048 The Selection panel allows you to control the way copy and paste
1049 work in the PuTTY window.
1050
1051 \S{config-linedrawpaste} Controlling the pasting of line drawing
1052 characters
1053
1054 \cfg{winhelp-topic}{selection.linedraw}
1055
1056 By default, when you copy and paste a piece of the PuTTY screen that
1057 contains VT100 line and box drawing characters, PuTTY will translate
1058 them into the \q{poor man's} line-drawing characters \c{+}, \c{-}
1059 and \c{|}. The checkbox \q{Don't translate line drawing chars}
1060 disables this feature, so line-drawing characters will be pasted as
1061 if they were in the normal character set. This will typically mean
1062 they come out mostly as \c{q} and \c{x}, with a scattering of
1063 \c{jklmntuvw} at the corners. This might be useful if you were
1064 trying to recreate the same box layout in another program, for
1065 example.
1066
1067 \S{config-rtfpaste} Pasting in Rich Text Format
1068
1069 \cfg{winhelp-topic}{selection.rtf}
1070
1071 If you enable \q{Paste to clipboard in RTF as well as plain text},
1072 PuTTY will write formatting information to the clipboard as well as
1073 the actual text you copy. Currently the only effect of this will be
1074 that if you paste into (say) a word processor, the text will appear
1075 in the word processor in the same font PuTTY was using to display
1076 it. In future it is likely that other formatting information (bold,
1077 underline, colours) will be copied as well.
1078
1079 This option can easily be inconvenient, so by default it is
1080 disabled.
1081
1082 \S{config-mouse} Changing the actions of the mouse buttons
1083
1084 \cfg{winhelp-topic}{selection.buttons}
1085
1086 PuTTY's copy and paste mechanism is modelled on the Unix \c{xterm}
1087 application. The X Window System uses a three-button mouse, and the
1088 convention is that the left button selects, the right button extends
1089 an existing selection, and the middle button pastes.
1090
1091 Windows typically only has two mouse buttons, so in PuTTY's default
1092 configuration, the \e{right} button pastes, and the \e{middle}
1093 button (if you have one) extends a selection.
1094
1095 If you have a three-button mouse and you are already used to the
1096 \c{xterm} arrangement, you can select it using the \q{Action of
1097 mouse buttons} control.
1098
1099 \S{config-mouseshift} \q{Shift overrides application's use of mouse}
1100
1101 \cfg{winhelp-topic}{selection.shiftdrag}
1102
1103 PuTTY allows the server to send control codes that let it take over
1104 the mouse and use it for purposes other than copy and paste.
1105 Applications which use this feature include the text-mode web
1106 browser \c{links}, the Usenet newsreader \c{trn} version 4, and the
1107 file manager \c{mc} (Midnight Commander).
1108
1109 When running one of these applications, pressing the mouse buttons
1110 no longer performs copy and paste. If you do need to copy and paste,
1111 you can still do so if you hold down Shift while you do your mouse
1112 clicks.
1113
1114 However, it is possible in theory for applications to even detect
1115 and make use of Shift + mouse clicks. We don't know of any
1116 applications that do this, but in case someone ever writes one,
1117 unchecking the \q{Shift overrides application's use of mouse}
1118 checkbox will cause Shift + mouse clicks to go to the server as well
1119 (so that mouse-driven copy and paste will be completely disabled).
1120
1121 If you want to prevent the application from taking over the mouse at
1122 all, you can do this using the Features control panel; see
1123 \k{config-features-mouse}.
1124
1125 \S{config-rectselect} Default selection mode
1126
1127 \cfg{winhelp-topic}{selection.rect}
1128
1129 As described in \k{using-selection}, PuTTY has two modes of
1130 selecting text to be copied to the clipboard. In the default mode
1131 (\q{Normal}), dragging the mouse from point A to point B selects to
1132 the end of the line containing A, all the lines in between, and from
1133 the very beginning of the line containing B. In the other mode
1134 (\q{Rectangular block}), dragging the mouse between two points
1135 defines a rectangle, and everything within that rectangle is copied.
1136
1137 Normally, you have to hold down Alt while dragging the mouse to
1138 select a rectangular block. Using the \q{Default selection mode}
1139 control, you can set rectangular selection as the default, and then
1140 you have to hold down Alt to get the \e{normal} behaviour.
1141
1142 \S{config-charclasses} Configuring word-by-word selection
1143
1144 \cfg{winhelp-topic}{selection.charclasses}
1145
1146 PuTTY will select a word at a time in the terminal window if you
1147 double-click to begin the drag. This panel allows you to control
1148 precisely what is considered to be a word.
1149
1150 Each character is given a \e{class}, which is a small number
1151 (typically 0, 1 or 2). PuTTY considers a single word to be any
1152 number of adjacent characters in the same class. So by modifying the
1153 assignment of characters to classes, you can modify the word-by-word
1154 selection behaviour.
1155
1156 In the default configuration, the character classes are:
1157
1158 \b Class 0 contains white space and control characters.
1159
1160 \b Class 1 contains most punctuation.
1161
1162 \b Class 2 contains letters, numbers and a few pieces of punctuation
1163 (the double quote, minus sign, period, forward slash and
1164 underscore).
1165
1166 So, for example, if you assign the \c{@} symbol into character class
1167 2, you will be able to select an e-mail address with just a double
1168 click.
1169
1170 In order to adjust these assignments, you start by selecting a group
1171 of characters in the list box. Then enter a class number in the edit
1172 box below, and press the \q{Set} button.
1173
1174 This mechanism currently only covers ASCII characters, because it
1175 isn't feasible to expand the list to cover the whole of Unicode.
1176
1177 Character class definitions can be modified by control sequences
1178 sent by the server. This configuration option only controls the
1179 \e{default} state. If you modify this option in mid-session using
1180 \q{Change Settings}, you will need to reset the terminal (see
1181 \k{reset-terminal}) before the change takes effect.
1182
1183 \H{config-colours} The Colours panel
1184
1185 The Colours panel allows you to control PuTTY's use of colour.
1186
1187 \S{config-boldcolour} \q{Bolded text is a different colour}
1188
1189 \cfg{winhelp-topic}{colours.bold}
1190
1191 When the server sends a control sequence indicating that some text
1192 should be displayed in bold, PuTTY can handle this two ways. It can
1193 either change the font for a bold version, or use the same font in a
1194 brighter colour. This control lets you choose which.
1195
1196 By default the box is checked, so non-bold text is displayed in
1197 light grey and bold text is displayed in bright white (and similarly
1198 in other colours). If you uncheck the box, bold and non-bold text
1199 will be displayed in the same colour, and instead the font will
1200 change to indicate the difference.
1201
1202 \S{config-logpalette} \q{Attempt to use logical palettes}
1203
1204 \cfg{winhelp-topic}{colours.logpal}
1205
1206 Logical palettes are a mechanism by which a Windows application
1207 running on an 8-bit colour display can select precisely the colours
1208 it wants instead of going with the Windows standard defaults.
1209
1210 If you are not getting the colours you ask for on an 8-bit display,
1211 you can try enabling this option. However, be warned that it's never
1212 worked very well.
1213
1214 \S{config-colourcfg} Adjusting the colours in the terminal window
1215
1216 \cfg{winhelp-topic}{colours.config}
1217
1218 The main colour control allows you to specify exactly what colours
1219 things should be displayed in. To modify one of the PuTTY colours,
1220 use the list box to select which colour you want to modify. The RGB
1221 values for that colour will appear on the right-hand side of the
1222 list box. Now, if you press the \q{Modify} button, you will be
1223 presented with a colour selector, in which you can choose a new
1224 colour to go in place of the old one.
1225
1226 PuTTY allows you to set the cursor colour, the default foreground
1227 and background, and the precise shades of all the ANSI configurable
1228 colours (black, red, green, yellow, blue, magenta, cyan, and white).
1229 In addition, if you have selected \q{Bolded text is a different
1230 colour}, you can also modify the precise shades used for the bold
1231 versions of these colours.
1232
1233 \H{config-connection} The Connection panel
1234
1235 The Connection panel allows you to configure options that apply to
1236 more than one type of connection.
1237
1238 \S{config-termtype} \q{Terminal-type string}
1239
1240 \cfg{winhelp-topic}{connection.termtype}
1241
1242 Most servers you might connect to with PuTTY are designed to be
1243 connected to from lots of different types of terminal. In order to
1244 send the right control sequences to each one, the server will need
1245 to know what type of terminal it is dealing with. Therefore, each of
1246 the SSH, Telnet and Rlogin protocols allow a text string to be sent
1247 down the connection describing the terminal.
1248
1249 PuTTY attempts to emulate the Unix \c{xterm} program, and by default
1250 it reflects this by sending \c{xterm} as a terminal-type string. If
1251 you find this is not doing what you want - perhaps the remote
1252 terminal reports \q{Unknown terminal type} - you could try setting
1253 this to something different, such as \c{vt220}.
1254
1255 If you're not sure whether a problem is due to the terminal type
1256 setting or not, you probably need to consult the manual for your
1257 application or your server.
1258
1259 \S{config-username} \q{Auto-login username}
1260
1261 \cfg{winhelp-topic}{connection.username}
1262
1263 All three of the SSH, Telnet and Rlogin protocols allow you to
1264 specify what user name you want to log in as, without having to type
1265 it explicitly every time. (Some Telnet servers don't support this.)
1266
1267 In this box you can type that user name.
1268
1269 \S{config-keepalive} Using keepalives to prevent disconnection
1270
1271 \cfg{winhelp-topic}{connection.keepalive}
1272
1273 If you find your sessions are closing unexpectedly (\q{Connection
1274 reset by peer}) after they have been idle for a while, you might
1275 want to try using this option.
1276
1277 Some network routers and firewalls need to keep track of all
1278 connections through them. Usually, these firewalls will assume a
1279 connection is dead if no data is transferred in either direction
1280 after a certain time interval. This can cause PuTTY sessions to be
1281 unexpectedly closed by the firewall if no traffic is seen in the
1282 session for some time.
1283
1284 The keepalive option (\q{Seconds between keepalives}) allows you to
1285 configure PuTTY to send data through the session at regular
1286 intervals, in a way that does not disrupt the actual terminal
1287 session. If you find your firewall is cutting idle connections off,
1288 you can try entering a non-zero value in this field. The value is
1289 measured in seconds; so, for example, if your firewall cuts
1290 connections off after ten minutes then you might want to enter 300
1291 seconds (5 minutes) in the box.
1292
1293 Note that keepalives are not always helpful. They help if you have a
1294 firewall which drops your connection after an idle period; but if
1295 the network between you and the server suffers from breaks in
1296 connectivity then keepalives can actually make things worse. If a
1297 session is idle, and connectivity is temporarily lost between the
1298 endpoints, but the connectivity is restored before either side tries
1299 to send anything, then there will be no problem - neither endpoint
1300 will notice that anything was wrong. However, if one side does send
1301 something during the break, it will repeatedly try to re-send, and
1302 eventually give up and abandon the connection. Then when
1303 connectivity is restored, the other side will find that the first
1304 side doesn't believe there is an open connection any more.
1305 Keepalives can make this sort of problem worse, because they
1306 increase the probability that PuTTY will attempt to send data during
1307 a break in connectivity. Therefore, you might find they help
1308 connection loss, or you might find they make it worse, depending on
1309 what \e{kind} of network problems you have between you and the
1310 server.
1311
1312 Keepalives are only supported in Telnet and SSH; the Rlogin and Raw
1313 protocols offer no way of implementing them.
1314
1315 \S{config-nodelay} \q{Disable Nagle's algorithm}
1316
1317 \cfg{winhelp-topic}{connection.nodelay}
1318
1319 Nagle's algorithm is a detail of TCP/IP implementations that tries
1320 to minimise the number of small data packets sent down a network
1321 connection. With Nagle's algorithm enabled, PuTTY's bandwidth usage
1322 will be slightly more efficient; with it disabled, you may find you
1323 get a faster response to your keystrokes when connecting to some
1324 types of server.
1325
1326 The Nagle algorithm is disabled by default.
1327
1328 \H{config-telnet} The Telnet panel
1329
1330 The Telnet panel allows you to configure options that only apply to
1331 Telnet sessions.
1332
1333 \S{config-termspeed} \q{Terminal-speed string}
1334
1335 \cfg{winhelp-topic}{telnet.termspeed}
1336
1337 Telnet allows the client to send a text string that describes the
1338 terminal speed. PuTTY lets you configure this, in case you find the
1339 server is reacting badly to the default value. (I'm not aware of any
1340 servers that do have a problem with it.)
1341
1342 \S{config-environ} Setting environment variables on the server
1343
1344 \cfg{winhelp-topic}{telnet.environ}
1345
1346 The Telnet protocol also provides a means for the client to pass
1347 environment variables to the server. Many Telnet servers have
1348 stopped supporting this feature due to security flaws, but PuTTY
1349 still supports it for the benefit of any servers which have found
1350 other ways around the security problems than just disabling the
1351 whole mechanism.
1352
1353 To add an environment variable to the list transmitted down the
1354 connection, you enter the variable name in the \q{Variable} box,
1355 enter its value in the \q{Value} box, and press the \q{Add} button.
1356 To remove one from the list, select it in the list box and press
1357 \q{Remove}.
1358
1359 \S{config-oldenviron} \q{Handling of OLD_ENVIRON ambiguity}
1360
1361 \cfg{winhelp-topic}{telnet.oldenviron}
1362
1363 The original Telnet mechanism for passing environment variables was
1364 badly specified. At the time the standard (RFC 1408) was written,
1365 BSD telnet implementations were already supporting the feature, and
1366 the intention of the standard was to describe the behaviour the BSD
1367 implementations were already using.
1368
1369 Sadly there was a typing error in the standard when it was issued,
1370 and two vital function codes were specified the wrong way round. BSD
1371 implementations did not change, and the standard was not corrected.
1372 Therefore, it's possible you might find either BSD or RFC-compliant
1373 implementations out there. This switch allows you to choose which
1374 one PuTTY claims to be.
1375
1376 The problem was solved by issuing a second standard, defining a new
1377 Telnet mechanism called \cw{NEW_ENVIRON}, which behaved exactly like
1378 the original \cw{OLD_ENVIRON} but was not encumbered by existing
1379 implementations. Most Telnet servers now support this, and it's
1380 unambiguous. This feature should only be needed if you have trouble
1381 passing environment variables to quite an old server.
1382
1383 \S{config-ptelnet} Passive and active Telnet negotiation modes
1384
1385 \cfg{winhelp-topic}{telnet.passive}
1386
1387 In a Telnet connection, there are two types of data passed between
1388 the client and the server: actual text, and \e{negotiations} about
1389 which Telnet extra features to use.
1390
1391 PuTTY can use two different strategies for negotiation:
1392
1393 \b In \e{active} mode, PuTTY starts to send negotiations as soon as
1394 the connection is opened.
1395
1396 \b In \e{passive} mode, PuTTY will wait to negotiate until it sees a
1397 negotiation from the server.
1398
1399 The obvious disadvantage of passive mode is that if the server is
1400 also operating in a passive mode, then negotiation will never begin
1401 at all. For this reason PuTTY defaults to active mode.
1402
1403 However, sometimes passive mode is required in order to successfully
1404 get through certain types of firewall and Telnet proxy server. If
1405 you have confusing trouble with a firewall, you could try enabling
1406 passive mode to see if it helps.
1407
1408 \S{config-telnetkey} \q{Keyboard sends telnet Backspace and Interrupt}
1409
1410 \cfg{winhelp-topic}{telnet.specialkeys}
1411
1412 If this box is checked, the Backspace key on the keyboard will send
1413 the Telnet special backspace code, and Control-C will send the
1414 Telnet special interrupt code. You probably shouldn't enable this
1415 unless you know what you're doing.
1416
1417 \S{config-telnetnl} \q{Return key sends telnet New Line instead of ^M}
1418
1419 \cfg{winhelp-topic}{telnet.newline}
1420
1421 Unlike most other remote login protocols, the Telnet protocol has a
1422 special \q{new line} code that is not the same as the usual line
1423 endings of Control-M or Control-J. By default, PuTTY sends the
1424 Telnet New Line code when you press Return, instead of sending
1425 Control-M as it does in most other protocols.
1426
1427 Most Unix-style Telnet servers don't mind whether they receive
1428 Telnet New Line or Control-M; some servers do expect New Line, and
1429 some servers prefer to see ^M. If you are seeing surprising
1430 behaviour when you press Return in a Telnet session, you might try
1431 turning this option off to see if it helps.
1432
1433 \H{config-rlogin} The Rlogin panel
1434
1435 The Rlogin panel allows you to configure options that only apply to
1436 Rlogin sessions.
1437
1438 \S{config-rlogin-termspeed} \q{Terminal-speed string}
1439
1440 \cfg{winhelp-topic}{rlogin.termspeed}
1441
1442 Like Telnet, Rlogin allows the client to send a text string that
1443 describes the terminal speed. PuTTY lets you configure this, in case
1444 you find the server is reacting badly to the default value. (I'm not
1445 aware of any servers that do have a problem with it.)
1446
1447 \S{config-rlogin-localuser} \q{Local username}
1448
1449 \cfg{winhelp-topic}{rlogin.localuser}
1450
1451 Rlogin allows an automated (password-free) form of login by means of
1452 a file called \c{.rhosts} on the server. You put a line in your
1453 \c{.rhosts} file saying something like \c{jbloggs@pc1.example.com},
1454 and then when you make an Rlogin connection the client transmits the
1455 username of the user running the Rlogin client. The server checks
1456 the username and hostname against \c{.rhosts}, and if they match it
1457 does not ask for a password.
1458
1459 This only works because Unix systems contain a safeguard to stop a
1460 user from pretending to be another user in an Rlogin connection.
1461 Rlogin connections have to come from port numbers below 1024, and
1462 Unix systems prohibit this to unprivileged processes; so when the
1463 server sees a connection from a low-numbered port, it assumes the
1464 client end of the connection is held by a privileged (and therefore
1465 trusted) process, so it believes the claim of who the user is.
1466
1467 Windows does not have this restriction: \e{any} user can initiate an
1468 outgoing connection from a low-numbered port. Hence, the Rlogin
1469 \c{.rhosts} mechanism is completely useless for securely
1470 distinguishing several different users on a Windows machine. If you
1471 have a \c{.rhosts} entry pointing at a Windows PC, you should assume
1472 that \e{anyone} using that PC can spoof your username in an Rlogin
1473 connection and access your account on the server.
1474
1475 The \q{Local username} control allows you to specify what user name
1476 PuTTY should claim you have, in case it doesn't match your Windows
1477 user name (or in case you didn't bother to set up a Windows user
1478 name).
1479
1480 \H{config-ssh} The SSH panel
1481
1482 The SSH panel allows you to configure options that only apply to
1483 SSH sessions.
1484
1485 \S{config-command} Executing a specific command on the server
1486
1487 \cfg{winhelp-topic}{ssh.command}
1488
1489 In SSH, you don't have to run a general shell session on the server.
1490 Instead, you can choose to run a single specific command (such as a
1491 mail user agent, for example). If you want to do this, enter the
1492 command in the \q{Remote command} box.
1493
1494 \S{config-ssh-pty} \q{Don't allocate a pseudo-terminal}
1495
1496 \cfg{winhelp-topic}{ssh.nopty}
1497
1498 When connecting to a Unix system, most interactive shell sessions
1499 are run in a \e{pseudo-terminal}, which allows the Unix system to
1500 pretend it's talking to a real physical terminal device but allows
1501 the SSH server to catch all the data coming from that fake device
1502 and send it back to the client.
1503
1504 Occasionally you might find you have a need to run a session \e{not}
1505 in a pseudo-terminal. In PuTTY, this is generally only useful for
1506 very specialist purposes; although in Plink (see \k{plink}) it is
1507 the usual way of working.
1508
1509 \S{config-ssh-comp} \q{Enable compression}
1510
1511 \cfg{winhelp-topic}{ssh.compress}
1512
1513 This enables data compression in the SSH connection: data sent by
1514 the server is compressed before sending, and decompressed at the
1515 client end. Likewise, data sent by PuTTY to the server is compressed
1516 first and the server decompresses it at the other end. This can help
1517 make the most of a low-bandwidth connection.
1518
1519 \S{config-ssh-prot} \q{Preferred SSH protocol version}
1520
1521 \cfg{winhelp-topic}{ssh.protocol}
1522
1523 This allows you to select whether you would like to use SSH protocol
1524 version 1 or version 2. \#{FIXME: say something about this elsewhere?}
1525
1526 PuTTY will attempt to use protocol 1 if the server you connect to
1527 does not offer protocol 2, and vice versa.
1528
1529 \S{config-ssh-macbug} \q{Imitate SSH 2 MAC bug}
1530
1531 \cfg{winhelp-topic}{ssh.buggymac}
1532
1533 This option \e{should} now be unnecessary. It existed in order to
1534 work around a bug in early versions (2.3.0 and below) of the SSH
1535 server software from \cw{ssh.com}. The symptom of this problem would
1536 be that PuTTY would die unexpectedly at the beginning of the
1537 session, saying \q{Incorrect MAC received on packet}.
1538
1539 Current versions of PuTTY attempt to detect these faulty servers and
1540 enable the bug compatibility automatically, so you should never need
1541 to use this option any more.
1542
1543 \S{config-ssh-encryption} Encryption algorithm selection
1544
1545 \cfg{winhelp-topic}{ssh.ciphers}
1546
1547 PuTTY supports a variety of different encryption algorithms, and
1548 allows you to choose which one you prefer to use. You can do this by
1549 dragging the algorithms up and down in the list box (or moving them
1550 using the Up and Down buttons) to specify a preference order. When
1551 you make an SSH connection, PuTTY will search down the list from the
1552 top until it finds an algorithm supported by the server, and then
1553 use that.
1554
1555 If the algorithm PuTTY finds is below the \q{warn below here} line,
1556 you will see a warning box when you make the connection:
1557
1558 \c The first cipher supported by the server
1559 \c is single-DES, which is below the configured
1560 \c warning threshold.
1561 \c Do you want to continue with this connection?
1562
1563 This warns you that the first available encryption is not a very
1564 secure one. Typically you would put the \q{warn below here} line
1565 between the encryptions you consider secure and the ones you
1566 consider substandard. By default, PuTTY supplies a preference order
1567 intended to reflect a reasonable preference in terms of security and
1568 speed.
1569
1570 Single-DES is not supported natively in the SSH 2 draft protocol
1571 standards. One or two server implementations do support it, by a
1572 non-standard name. PuTTY can use single-DES to interoperate with
1573 these servers if you enable the \q{Enable non-standard single-DES in
1574 SSH 2} option; by default this is disabled and PuTTY will stick to
1575 the standard.
1576
1577 \H{config-ssh-auth} The Auth panel
1578
1579 The Auth panel allows you to configure authentication options for
1580 SSH sessions.
1581
1582 \S{config-ssh-tis} \q{Attempt TIS or CryptoCard authentication}
1583
1584 \cfg{winhelp-topic}{ssh.auth.tis}
1585
1586 TIS and CryptoCard authentication are simple challenge/response
1587 forms of authentication available in SSH protocol version 1 only.
1588 You might use them if you were using S/Key one-time passwords, for
1589 example, or if you had a physical security token that generated
1590 responses to authentication challenges.
1591
1592 With this switch enabled, PuTTY will attempt these forms of
1593 authentication if the server is willing to try them. You will be
1594 presented with a challenge string (which will be different every
1595 time) and must supply the correct response in order to log in. If
1596 your server supports this, you should talk to your system
1597 administrator about precisely what form these challenges and
1598 responses take.
1599
1600 \S{config-ssh-ki} \q{Attempt keyboard-interactive authentication}
1601
1602 \cfg{winhelp-topic}{ssh.auth.ki}
1603
1604 The SSH 2 equivalent of TIS authentication is called
1605 \q{keyboard-interactive}. It is a flexible authentication method
1606 using an arbitrary sequence of requests and responses; so it is not
1607 only useful for challenge/response mechanisms such as S/Key, but it
1608 can also be used for (for example) asking the user for a new
1609 password when the old one has expired.
1610
1611 PuTTY leaves this option enabled by default, but supplies a switch
1612 to turn it off in case you should have trouble with it.
1613
1614 \S{config-ssh-agentfwd} \q{Allow agent forwarding}
1615
1616 \cfg{winhelp-topic}{ssh.auth.agentfwd}
1617
1618 This option allows the SSH server to open forwarded connections back
1619 to your local copy of Pageant. If you are not running Pageant, this
1620 option will do nothing.
1621
1622 See \k{pageant} for general information on Pageant, and
1623 \k{pageant-forward} for information on agent forwarding. Note that
1624 there is a security risk involved with enabling this option; see
1625 \k{pageant-security} for details.
1626
1627 \S{config-ssh-changeuser} \q{Allow attempted changes of username in SSH2}
1628
1629 \cfg{winhelp-topic}{ssh.auth.changeuser}
1630
1631 In the SSH 1 protocol, it is impossible to change username after
1632 failing to authenticate. So if you mis-type your username at the
1633 PuTTY \q{login as:} prompt, you will not be able to change it except
1634 by restarting PuTTY.
1635
1636 The SSH 2 protocol \e{does} allow changes of username, in principle,
1637 but does not make it mandatory for SSH 2 servers to accept them. In
1638 particular, OpenSSH does not accept a change of username; once you
1639 have sent one username, it will reject attempts to try to
1640 authenticate as another user. (Depending on the version of OpenSSH,
1641 it may quietly return failure for all login attempts, or it may send
1642 an error message.)
1643
1644 For this reason, PuTTY will by default not prompt you for your
1645 username more than once, in case the server complains. If you know
1646 your server can cope with it, you can enable the \q{Allow attempted
1647 changes of username} option to modify PuTTY's behaviour.
1648
1649 \S{config-ssh-privkey} \q{Private key file for authentication}
1650
1651 \cfg{winhelp-topic}{ssh.auth.privkey}
1652
1653 This box is where you enter the name of your private key file if you
1654 are using public key authentication. See \k{pubkey} for information
1655 about public key authentication in SSH.
1656
1657 \H{config-ssh-tunnels} The Tunnels panel
1658
1659 The Tunnels panel allows you to configure tunnelling of other
1660 connection types through an SSH connection.
1661
1662 \S{config-ssh-x11} X11 forwarding
1663
1664 \cfg{winhelp-topic}{ssh.tunnels.x11}
1665
1666 If your server lets you run X Window System applications, X11
1667 forwarding allows you to securely give those applications access to
1668 a local X display on your PC.
1669
1670 To enable X11 forwarding, check the \q{Enable X11 forwarding} box.
1671 If your X display is not the primary display on your local machine
1672 (which it almost certainly will be unless you have deliberately
1673 arranged otherwise), you need to enter its location in the \q{X
1674 display location} box.
1675
1676 See \k{using-x-forwarding} for more information about X11
1677 forwarding.
1678
1679 \S{config-ssh-portfwd} Port forwarding
1680
1681 \cfg{winhelp-topic}{ssh.tunnels.portfwd}
1682
1683 Port forwarding allows you to tunnel other types of network
1684 connection down an SSH session. See \k{using-port-forwarding} for a
1685 general discussion of port forwarding and how it works.
1686
1687 The port forwarding section in the Tunnels panel shows a list of all
1688 the port forwardings that PuTTY will try to set up when it connects
1689 to the server. By default no port forwardings are set up, so this
1690 list is empty.
1691
1692 To add a port forwarding:
1693
1694 \b Set one of the \q{Local} or \q{Remote} radio buttons, depending
1695 on whether you want to forward a local port to a remote destination
1696 (\q{Local}) or forward a remote port to a local destination
1697 (\q{Remote}).
1698
1699 \b Enter a source port number into the \q{Source port} box. For
1700 local forwardings, PuTTY will listen on this port of your PC. For
1701 remote forwardings, your SSH server will listen on this port of the
1702 remote machine. Note that most servers will not allow you to listen
1703 on port numbers less than 1024.
1704
1705 \b Enter a hostname and port number separated by a colon, in the
1706 \q{Destination} box. Connections received on the source port will be
1707 directed to this destination. For example, to connect to a POP-3
1708 server, you might enter \c{popserver.example.com:110}.
1709
1710 \b Click the \q{Add} button. Your forwarding details should appear
1711 in the list box.
1712
1713 To remove a port forwarding, simply select its details in the list
1714 box, and click the \q{Remove} button.
1715
1716 \S{config-ssh-portfwd-localhost} Controlling the visibility of
1717 forwarded ports
1718
1719 \cfg{winhelp-topic}{ssh.tunnels.portfwd.localhost}
1720
1721 The source port for a forwarded connection usually does not accept
1722 connections from any machine except the SSH client or server machine
1723 itself (for local and remote forwardings respectively). There are
1724 controls in the Tunnels panel to change this:
1725
1726 \b The \q{Local ports accept connections from other hosts} option
1727 allows you to set up local-to-remote port forwardings in such a way
1728 that machines other than your client PC can connect to the forwarded
1729 port.
1730
1731 \b The \q{Remote ports do the same} option does the same thing for
1732 remote-to-local port forwardings (so that machines other than the
1733 SSH server machine can connect to the forwarded port.) Note that
1734 this feature is only available in the SSH 2 protocol, and not all
1735 SSH 2 servers support it (OpenSSH 3.0 does not, for example).
1736
1737 \H{config-file} Storing configuration in a file
1738
1739 PuTTY does not currently support storing its configuration in a file
1740 instead of the Registry. However, you can work around this with a
1741 couple of batch files.
1742
1743 You will need a file called (say) \c{PUTTY.BAT} which imports the
1744 contents of a file into the Registry, then runs PuTTY, exports the
1745 contents of the Registry back into the file, and deletes the
1746 Registry entries. This can all be done using the Regedit command
1747 line options, so it's all automatic. Here is what you need in
1748 \c{PUTTY.BAT}:
1749
1750 \c @ECHO OFF
1751 \c regedit /s putty.reg
1752 \c regedit /s puttyrnd.reg
1753 \c start /w putty.exe
1754 \c regedit /e puttynew.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
1755 \c copy puttynew.reg putty.reg
1756 \c del puttynew.reg
1757 \c regedit /s puttydel.reg
1758
1759 This batch file needs two auxiliary files: \c{PUTTYRND.REG} which
1760 sets up an initial safe location for the \c{PUTTY.RND} random seed
1761 file, and \c{PUTTYDEL.REG} which destroys everything in the Registry
1762 once it's been successfully saved back to the file.
1763
1764 Here is \c{PUTTYDEL.REG}:
1765
1766 \c REGEDIT4
1767 \c
1768 \c [-HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
1769
1770 Here is an example \c{PUTTYRND.REG} file:
1771
1772 \c REGEDIT4
1773 \c
1774 \c [HKEY_CURRENT_USER\Software\SimonTatham\PuTTY]
1775 \c "RandSeedFile"="a:\putty.rnd"
1776
1777 You should replace \c{a:\\putty.rnd} with the location where you
1778 want to store your random number data. If the aim is to carry around
1779 PuTTY and its settings on one floppy, you probably want to store it
1780 on the floppy.