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