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