fc5a8711 |
1 | \versionid $Id: config.but,v 1.14 2001/11/25 18:59:12 simon Exp $ |
8f1529bc |
2 | |
e5b0d077 |
3 | \C{config} Configuring PuTTY |
4 | |
55ba634a |
5 | This chapter describes all the configuration options in PuTTY. |
6 | |
7 | PuTTY is configured using the control panel that comes up before you |
8 | start a session. Some options can also be changed in the middle of a |
d60c975d |
9 | session, by selecting \q{Change Settings} from the window menu. |
55ba634a |
10 | |
11 | \H{config-session} The Session panel |
12 | |
13 | The Session configuration panel contains the basic options you need |
14 | to specify in order to open a session at all, and also allows you to |
15 | save your settings to be reloaded later. |
16 | |
17 | \S{config-hostname} The host name section |
18 | |
19 | The top box on the Session panel, labelled \q{Specify your |
20 | connection by host name}, contains the details that need to be |
21 | filled in before PuTTY can open a session at all. |
22 | |
d60c975d |
23 | \b The \q{Host Name} box is where you type the name, or the IP |
55ba634a |
24 | address, of the server you want to connect to. |
25 | |
d60c975d |
26 | \b The \q{Protocol} radio buttons let you choose what type of |
350ee898 |
27 | connection you want to make: a raw connection, a Telnet connection, an |
add788fc |
28 | rlogin connection or an SSH connection. (See \k{which-one} for a |
29 | summary of the differences between SSH, Telnet and rlogin.) |
55ba634a |
30 | |
d60c975d |
31 | \b The \q{Port} box lets you specify which port number on the server |
350ee898 |
32 | to connect to. If you select Telnet, Rlogin, or SSH, this box will be |
33 | filled in automatically to the usual value, and you will only need to |
55ba634a |
34 | change it if you have an unusual server. If you select Raw mode, you |
d60c975d |
35 | will almost certainly need to fill in the \q{Port} box. |
55ba634a |
36 | |
37 | \S{config-saving} Loading and storing saved sessions |
38 | |
39 | The next part of the Session configuration panel allows you to save |
40 | your preferred PuTTY options so they will appear automatically the |
41 | next time you start PuTTY. It also allows you to create \e{saved |
42 | sessions}, which contain a full set of configuration options plus a |
43 | host name and protocol. A saved session contains all the information |
44 | PuTTY needs to start exactly the session you want. |
45 | |
46 | \b To save your default settings: first set up the settings the way |
47 | you want them saved. Then come back to the Session panel. Select the |
48 | \q{Default Settings} entry in the saved sessions list, with a single |
d60c975d |
49 | click. Then press the \q{Save} button. |
55ba634a |
50 | |
e0cff44d |
51 | Note that PuTTY does not allow you to save a host name into the |
52 | Default Settings entry. This ensures that when PuTTY is started up, |
53 | the host name box is always empty, so a user can always just type in |
54 | a host name and connect. |
55 | |
56 | If there is a specific host you want to store the details of how to |
57 | connect to, you should create a saved session, which will be |
58 | separate from the Default Settings. |
59 | |
55ba634a |
60 | \b To save a session: first go through the rest of the configuration |
61 | box setting up all the options you want. Then come back to the |
d60c975d |
62 | Session panel. Enter a name for the saved session in the \q{Saved |
55ba634a |
63 | Sessions} input box. (The server name is often a good choice for a |
d60c975d |
64 | saved session name.) Then press the \q{Save} button. Your saved |
55ba634a |
65 | session name should now appear in the list box. |
66 | |
67 | \b To reload a saved session: single-click to select the session |
d60c975d |
68 | name in the list box, and then press the \q{Load} button. Your saved |
55ba634a |
69 | settings should all appear in the configuration panel. |
70 | |
71 | \b To modify a saved session: first load it as described above. Then |
72 | make the changes you want. Come back to the Session panel, |
73 | single-click to select the session name in the list box, and press |
d60c975d |
74 | the \q{Save} button. The new settings will be saved over the top of |
55ba634a |
75 | the old ones. |
76 | |
77 | \b To start a saved session immediately: double-click on the session |
78 | name in the list box. |
79 | |
80 | \b To delete a saved session: single-click to select the session |
d60c975d |
81 | name in the list box, and then press the \q{Delete} button. |
55ba634a |
82 | |
83 | Each saved session is independent of the Default Settings |
84 | configuration. If you change your preferences and update Default |
85 | Settings, you must also update every saved session separately. |
86 | |
87 | \S{config-closeonexit} \q{Close Window on Exit} |
88 | |
add788fc |
89 | Finally in the Session panel, there is an option labelled \q{Close |
90 | Window on Exit}. This controls whether the PuTTY session window |
91 | disappears as soon as the session inside it terminates. If you are |
92 | likely to want to copy and paste text out of the session after it |
93 | has terminated, you should arrange this option to be off. |
94 | |
95 | \q{Close Window On Exit} has three settings. \q{Always} means always |
96 | close the window on exit; \q{Never} means never close on exit |
97 | (always leave the window open). The third setting, and the default |
98 | one, is \q{Only on clean exit}. In this mode, a session which |
99 | terminates normally will cause its window to close, but one which is |
100 | aborted unexpectedly by network trouble or a confusing message from |
101 | the server will leave the window up. |
102 | |
103 | \H{config-logging} The Logging panel |
104 | |
105 | The Logging configuration panel allows you to save log files of your |
106 | PuTTY sessions, for debugging, analysis or future reference. |
107 | |
108 | The main option is a radio-button set that specifies whether PuTTY |
109 | will log anything at all. The options are |
110 | |
111 | \b \q{Logging turned off completely}. This is the default option; in |
112 | this mode PuTTY will not create a log file at all. |
113 | |
114 | \b \q{Log printable output only}. In this mode, a log file will be |
115 | created and written to, but only printable text will be saved into |
116 | it. The various terminal control codes that are typically sent down |
117 | an interactive session alongside the printable text will be omitted. |
118 | This might be a useful mode if you want to read a log file in a text |
119 | editor and hope to be able to make sense of it. |
120 | |
121 | \b \q{Log all session output}. In this mode, \e{everything} sent by |
122 | the server into your terminal session is logged. If you view the log |
123 | file in a text editor, therefore, you may well find it full of |
124 | strange control characters. This is a particularly useful mode if |
125 | you are experiencing problems with PuTTY's terminal handling: you |
126 | can record everything that went to the terminal, so that someone |
127 | else can replay the session later in slow motion and watch to see |
128 | what went wrong. |
129 | |
130 | \S{config-logfilename} \q{Log file name} |
131 | |
132 | In this edit box you enter the name of the file you want to log the |
133 | session to. The \q{Browse} button will let you look around your file |
134 | system to find the right place to put the file; or if you already |
135 | know exactly where you want it to go, you can just type a pathname |
136 | into the edit box. |
137 | |
138 | There are a few special features in this box. If you use the \c{&} |
139 | character in the file name box, PuTTY will insert details of the |
140 | current session in the name of the file it actually opens. The |
141 | precise replacements it will do are: |
142 | |
143 | \b \c{&Y} will be replaced by the current year, as four digits. |
144 | |
145 | \b \c{&M} will be replaced by the current month, as two digits. |
146 | |
147 | \b \c{&D} will be replaced by the current day of the month, as two |
148 | digits. |
149 | |
150 | \b \c{&T} will be replaced by the current time, as six digits |
151 | (HHMMSS) with no punctuation. |
152 | |
153 | \b \c{&H} will be replaced by the host name you are connecting to. |
154 | |
155 | For example, if you enter the host name |
156 | \c{c:\\puttylogs\\log-&h-&y&m&d-&t.dat}, you will end up with files looking |
157 | like |
158 | |
159 | \c log-server1.example.com-20010528-110859.dat |
160 | \c log-unixbox.somewhere.org-20010611-221001.dat |
161 | |
162 | \S{config-logfileexists} \q{What to do if the log file already exists} |
163 | |
164 | This control allows you to specify what PuTTY should do if it tries |
165 | to start writing to a log file and it finds the file already exists. |
166 | You might want to automatically destroy the existing log file and |
167 | start a new one with the same name. Alternatively, you might want to |
168 | open the existing log file and add data to the \e{end} of it. |
169 | Finally (the default option), you might not want to have any |
170 | automatic behaviour, but to ask the user every time the problem |
171 | comes up. |
55ba634a |
172 | |
173 | \H{config-terminal} The Terminal panel |
174 | |
175 | The Terminal configuration panel allows you to control the behaviour |
176 | of PuTTY's terminal emulation. |
177 | |
178 | \S{config-autowrap} \q{Auto wrap mode initially on} |
179 | |
180 | Auto wrap mode controls what happens when text printed in a PuTTY |
181 | window reaches the right-hand edge of the window. |
182 | |
183 | With auto wrap mode on, if a long line of text reaches the |
184 | right-hand edge, it will wrap over on to the next line so you can |
185 | still see all the text. With auto wrap mode off, the cursor will |
186 | stay at the right-hand edge of the screen, and all the characters in |
187 | the line will be printed on top of each other. |
188 | |
189 | If you are running a full-screen application and you occasionally |
190 | find the screen scrolling up when it looks as if it shouldn't, you |
191 | could try turning this option off. |
192 | |
193 | Auto wrap mode can be turned on and off by control sequences sent by |
194 | the server. This configuration option only controls the \e{default} |
d60c975d |
195 | state. If you modify this option in mid-session using \q{Change |
55ba634a |
196 | Settings}, you will need to reset the terminal \#{ FIXME } before |
197 | the change takes effect. |
198 | |
199 | \S{config-decom} \q{DEC Origin Mode initially on} |
200 | |
201 | DEC Origin Mode is a minor option which controls how PuTTY |
202 | interprets cursor-position control sequences sent by the server. |
203 | |
204 | The server can send a control sequence that restricts the scrolling |
205 | region of the display. For example, in an editor, the server might |
206 | reserve a line at the top of the screen and a line at the bottom, |
207 | and might send a control sequence that causes scrolling operations |
208 | to affect only the remaining lines. |
209 | |
210 | With DEC Origin Mode on, cursor coordinates are counted from the top |
211 | of the scrolling region. With it turned off, cursor coordinates are |
212 | counted from the top of the whole screen regardless of the scrolling |
213 | region. |
214 | |
215 | It is unlikely you would need to change this option, but if you find |
216 | a full-screen application is displaying pieces of text in what looks |
217 | like the wrong part of the screen, you could try turning DEC Origin |
218 | Mode on to see whether that helps. |
219 | |
220 | DEC Origin Mode can be turned on and off by control sequences sent by |
221 | the server. This configuration option only controls the \e{default} |
d60c975d |
222 | state. If you modify this option in mid-session using \q{Change |
55ba634a |
223 | Settings}, you will need to reset the terminal \#{ FIXME } before |
224 | the change takes effect. |
225 | |
226 | \S{config-crlf} \q{Implicit CR in every LF} |
227 | |
228 | Most servers send two control characters, CR and LF, to start a new |
229 | line of the screen. The CR character makes the cursor return to the |
230 | left-hand side of the screen. The LF character makes the cursor move |
231 | one line down (and might make the screen scroll). |
232 | |
233 | Some servers only send LF, and expect the terminal to move the |
234 | cursor over to the left automatically. If you come across a server |
235 | that does this, you will see a stepped effect on the screen, like |
236 | this: |
237 | |
238 | \c First line of text |
239 | \c Second line |
240 | \c Third line |
241 | |
242 | If this happens to you, try enabling the \q{Implicit CR in every LF} |
243 | option, and things might go back to normal: |
244 | |
245 | \c First line of text |
246 | \c Second line |
247 | \c Third line |
248 | |
55ba634a |
249 | \S{config-erase} \q{Use background colour to erase screen} |
250 | |
251 | Not all terminals agree on what colour to turn the screen when the |
252 | server sends a \q{clear screen} sequence. Some terminals believe the |
253 | screen should always be cleared to the \e{default} background |
254 | colour. Others believe the screen should be cleared to whatever the |
255 | server has selected as a background colour. |
256 | |
257 | There exist applications that expect both kinds of behaviour. |
258 | Therefore, PuTTY can be configured to do either. |
259 | |
260 | With this option disabled, screen clearing is always done in the |
261 | default background colour. With this option enabled, it is done in |
262 | the \e{current} background colour. |
263 | |
264 | \S{config-blink} \q{Enable blinking text} |
265 | |
266 | The server can ask PuTTY to display text that blinks on and off. |
267 | This is very distracting, so PuTTY allows you to turn blinking text |
268 | off completely. |
269 | |
add788fc |
270 | \S{config-localecho} \q{Local echo} |
55ba634a |
271 | |
add788fc |
272 | With local echo disabled, characters you type into the PuTTY window |
273 | are not echoed in the window \e{by PuTTY}. They are simply sent to |
274 | the server. (The \e{server} might choose to echo them back to you; |
275 | this can't be controlled from the PuTTY control panel.) |
55ba634a |
276 | |
add788fc |
277 | Some types of session need local echo, and many do not. In its |
278 | default mode, PuTTY will automatically attempt to deduce whether or |
279 | not local echo is appropriate for the session you are working in. If |
280 | you find it has made the wrong decision, you can use this |
281 | configuration option to override its choice: you can force local |
282 | echo to be turned on, or force it to be turned off, instead of |
283 | relying on the automatic detection. |
55ba634a |
284 | |
add788fc |
285 | \S{config-localedit} \q{Local line editing} |
55ba634a |
286 | |
add788fc |
287 | Normally, every character you type into the PuTTY window is sent |
288 | immediately to the server the moment you type it. |
289 | |
290 | If you enable local line editing, this changes. PuTTY will let you |
291 | edit a whole line at a time locally, and the line will only be sent |
292 | to the server when you press Return. If you make a mistake, you can |
293 | use the Backspace key to correct it before you press Return, and the |
294 | server will never see the mistake. |
295 | |
296 | Since it is hard to edit a line locally without being able to see |
297 | it, local line editing is mostly used in conjunction with local echo |
298 | (\k{config-localecho}). This makes it ideal for use in raw mode |
299 | \#{FIXME} or when connecting to MUDs or talkers. (Although some more |
300 | advanced MUDs do occasionally turn local line editing on and turn |
301 | local echo off, in order to accept a password from the user.) |
302 | |
303 | Some types of session need local line editing, and many do not. In |
304 | its default mode, PuTTY will automatically attempt to deduce whether |
305 | or not local line editing is appropriate for the session you are |
306 | working in. If you find it has made the wrong decision, you can use |
307 | this configuration option to override its choice: you can force |
308 | local line editing to be turned on, or force it to be turned off, |
309 | instead of relying on the automatic detection. |
55ba634a |
310 | |
add788fc |
311 | \H{config-bell} The Bell panel |
55ba634a |
312 | |
add788fc |
313 | The Bell panel controls the terminal bell feature: the server's |
314 | ability to cause PuTTY to beep at you. |
315 | |
316 | In the default configuration, when the server sends the character |
317 | with ASCII code 7 (Control-G), PuTTY will play the Windows Default |
318 | Beep sound. This is not always what you want the terminal bell |
319 | feature to do; the Bell panel allows you to configure alternative |
320 | actions. |
321 | |
322 | \S{config-bellstyle} \q{Set the style of bell} |
323 | |
324 | This control allows you to select various different actions to occur |
325 | on a terminal bell: |
326 | |
327 | \b Selecting \q{None} disables the bell completely. In this mode, |
328 | the server can send as many Control-G characters as it likes and |
329 | nothing at all will happen. |
330 | |
331 | \b \q{Play Windows Default Sound} is the default setting. It causes |
332 | the Windows \q{Default Beep} sound to be played. To change what this |
333 | sound is, or to test it if nothing seems to be happening, use the |
334 | Sound configurer in the Windows Control Panel. |
335 | |
336 | \b \q{Play a custom sound file} allows you to specify a particular |
337 | sound file to be used by PuTTY alone, or even by a particular |
338 | individual PuTTY session. This allows you to distinguish your PuTTY |
339 | beeps from any other beeps on the system. If you select this option, |
340 | you will also need to enter the name of your sound file in the edit |
341 | control \q{Custom sound file to play as a bell}. |
342 | |
343 | \b \q{Visual bell} is a silent alternative to a beeping computer. In |
344 | this mode, when the server sends a Control-G, the whole PuTTY window |
345 | will flash white for a fraction of a second. |
346 | |
347 | \S{config-belltaskbar} \q{Taskbar/caption indication on bell} |
348 | |
349 | This feature controls what happens to the PuTTY window's entry in |
350 | the Windows Taskbar if a bell occurs while the window does not have |
351 | the input focus. |
352 | |
353 | In the default state (\q{Disabled}) nothing unusual happens. |
354 | |
355 | If you select \q{Steady}, then when a bell occurs and the window is |
356 | not in focus, the window's Taskbar entry and its title bar will |
357 | change colour to let you know that PuTTY session is asking for your |
358 | attention. The change of colour will persist until you select the |
359 | window, so you can leave several PuTTY windows minimised in your |
360 | terminal, go away from your keyboard, and be sure not to have missed |
361 | any important beeps when you get back. |
362 | |
363 | \q{Flashing} is even more eye-catching: the Taskbar entry will |
364 | continuously flash on and off until you select the window. |
365 | |
366 | \S{config-bellovl} \q{Control the bell overload behaviour} |
367 | |
368 | A common user error in a terminal session is to accidentally run the |
369 | Unix command \c{cat} (or equivalent) on an inappropriate file type, |
370 | such as an executable, image file, or ZIP file. This produces a huge |
371 | stream of non-text characters sent to the terminal, which typically |
372 | includes a lot of bell characters. As a result of this the terminal |
373 | often doesn't stop beeping for ten minutes, and everybody else in |
374 | the office gets annoyed. |
375 | |
376 | To try to avoid this behaviour, or any other cause of excessive |
377 | beeping, PuTTY includes a bell overload management feature. In the |
378 | default configuration, receiving more than five bell characters in a |
379 | two-second period will cause the overload feature to activate. Once |
380 | the overload feature is active, further bells will have no effect at |
381 | all, so the rest of your binary file will be sent to the screen in |
382 | silence. After a period of five seconds during which no further |
383 | bells are received, the overload feature will turn itself off again |
384 | and bells will be re-enabled. |
385 | |
386 | If you want this feature completely disabled, you can turn it off |
387 | using the checkbox \q{Bell is temporarily disabled when over-used}. |
388 | |
389 | Alternatively, if you like the bell overload feature but don't agree |
390 | with the settings, you can configure the details: how many bells |
391 | constitute an overload, how short a time period they have to arrive |
392 | in to do so, and how much silent time is required before the |
393 | overload feature will deactivate itself. |
55ba634a |
394 | |
395 | \H{config-keyboard} The Keyboard panel |
396 | |
1630bb61 |
397 | The Keyboard configuration panel allows you to control the behaviour |
398 | of the keyboard in PuTTY. |
399 | |
55ba634a |
400 | \S{config-backspace} Changing the action of the Backspace key |
401 | |
1630bb61 |
402 | Some terminals believe that the Backspace key should send the same |
403 | thing to the server as Control-H (ASCII code 8). Other terminals |
404 | believe that the Backspace key should send ASCII code 127 (usually |
405 | known as Control-?) so that it can be distinguished from Control-H. |
406 | This option allows you to choose which code PuTTY generates when you |
407 | press Backspace. |
408 | |
409 | If you are connecting to a Unix system, you will probably find that |
410 | the Unix \c{stty} command lets you configure which the server |
411 | expects to see, so you might not need to change which one PuTTY |
412 | generates. On other systems, the server's expectation might be fixed |
413 | and you might have no choice but to configure PuTTY. |
414 | |
415 | If you do have the choice, we recommend configuring PuTTY to |
416 | generate Control-? and configuring the server to expect it, because |
417 | that allows applications such as \c{emacs} to use Control-H for |
418 | help. |
419 | |
55ba634a |
420 | \S{config-homeend} Changing the action of the Home and End keys |
421 | |
1630bb61 |
422 | The Unix terminal emulator \c{rxvt} disagrees with the rest of the |
423 | world about what character sequences should be sent to the server by |
424 | the Home and End keys. |
425 | |
426 | \c{xterm}, and other terminals, send \c{ESC [1~} for the Home key, |
427 | and \c{ESC [4~} for the End key. \c{rxvt} sends \c{ESC [H} for the |
428 | Home key and \c{ESC [Ow} for the End key. |
429 | |
430 | If you find an application on which the Home and End keys aren't |
431 | working, you could try switching this option to see if it helps. |
432 | |
55ba634a |
433 | \S{config-funkeys} Changing the action of the function keys and keypad |
434 | |
1630bb61 |
435 | This option affects the function keys (F1 to F12) and the top row of |
436 | the numeric keypad. |
437 | |
438 | \b In the default mode, labelled \c{ESC [n~}, the function keys |
439 | generate sequences like \c{ESC [11~}, \c{ESC [12~} and so on. This |
440 | matches the general behaviour of Digital's terminals. |
441 | |
442 | \b In Linux mode, F6 to F12 behave just like the default mode, but |
443 | F1 to F5 generate \c{ESC [[A} through to \c{ESC [[E}. This mimics the |
444 | Linux virtual console. |
445 | |
446 | \b In Xterm R6 mode, F5 to F12 behave like the default mode, but F1 |
447 | to F4 generate \c{ESC OP} through to \c{ESC OS}, which are the |
448 | sequences produced by the top row of the \e{keypad} on Digital's |
449 | terminals. |
450 | |
451 | \b In VT400 mode, all the function keys behave like the default |
452 | mode, but the actual top row of the numeric keypad generates \c{ESC |
453 | OP} through to \c{ESC OS}. |
454 | |
350ee898 |
455 | \b In VT100+ mode, the function keys generate \c{ESC OP} through to |
456 | \c{ESC O[} |
457 | |
458 | \b In SCO mode, the function keys F1 to F12 generate \c{ESC [M} |
459 | through to \c{ESC [X}. Together with shift, they generate \c{ESC [Y} |
460 | through to \c{ESC [j}. With control they generate \c{ESC [k} through |
461 | to \c{ESC [v}, and with shift and control together they generate |
462 | \c{ESC [w} through to \c{ESC [\{}. |
463 | |
1630bb61 |
464 | If you don't know what any of this means, you probably don't need to |
465 | fiddle with it. |
466 | |
55ba634a |
467 | \S{config-appcursor} Controlling Application Cursor Keys mode |
468 | |
1630bb61 |
469 | Application Cursor Keys mode is a way for the server to change the |
470 | control sequences sent by the arrow keys. In normal mode, the arrow |
471 | keys send \c{ESC [A} through to \c{ESC [D}. In application mode, |
472 | they send \c{ESC OA} through to \c{ESC OD}. |
473 | |
474 | Application Cursor Keys mode can be turned on and off by the server, |
475 | depending on the application. PuTTY allows you to configure the |
476 | initial state, and also allows you to disable application mode |
477 | completely. |
478 | |
55ba634a |
479 | \S{config-appkeypad} Controlling Application Keypad mode |
480 | |
1630bb61 |
481 | Application Keypad mode is a way for the server to change the |
482 | behaviour of the numeric keypad. |
483 | |
484 | In normal mode, the keypad behaves like a normal Windows keypad: |
485 | with NumLock on, the number keys generate numbers, and with NumLock |
486 | off they act like the arrow keys and Home, End etc. |
487 | |
488 | In application mode, all the keypad keys send special control |
489 | sequences, \e{including} Num Lock. Num Lock stops behaving like Num |
490 | Lock and becomes another function key. |
491 | |
492 | Depending on which version of Windows you run, you may find the Num |
493 | Lock light still flashes on and off every time you press Num Lock, |
494 | even when application mode is active and Num Lock is acting like a |
495 | function key. This is unavoidable. |
496 | |
497 | Application keypad mode can be turned on and off by the server, |
498 | depending on the application. PuTTY allows you to configure the |
499 | initial state, and also allows you to disable application mode |
500 | completely. |
501 | |
55ba634a |
502 | \S{config-nethack} Using NetHack keypad mode |
503 | |
1630bb61 |
504 | PuTTY has a special mode for playing NetHack. You can enable it by |
505 | selecting \q{NetHack} in the \q{Initial state of numeric keypad} |
506 | control. |
507 | |
508 | In this mode, the numeric keypad keys 1-9 generate the NetHack |
509 | movement commands (\cw{hjklyubn}). The 5 key generates the \c{.} |
510 | command (do nothing). |
511 | |
512 | Better still, pressing Shift with the keypad keys generates the |
513 | capital forms of the commands (\cw{HJKLYUBN}), which tells NetHack |
514 | to keep moving you in the same direction until you encounter |
515 | something interesting. |
516 | |
517 | For some reason, this feature only works properly when Num Lock is |
518 | on. We don't know why. |
519 | |
55ba634a |
520 | \S{config-compose} Enabling a DEC-like Compose key |
521 | |
1630bb61 |
522 | DEC terminals have a Compose key, which provides an easy-to-remember |
523 | way of typing accented characters. You press Compose and then type |
524 | two more characters. The two characters are \q{combined} to produce |
525 | an accented character. The choices of character are designed to be |
526 | easy to remember; for example, composing \q{e} and \q{`} produces |
527 | the \q{\u00e8{e-grave}} character. |
528 | |
529 | If you enable the \q{Application and AltGr act as Compose key} |
530 | option, the Windows Application key and the AltGr key will both have |
531 | this behaviour. |
532 | |
add788fc |
533 | \S{config-ctrlalt} \q{Control-Alt is different from AltGr} |
b5752f1b |
534 | |
add788fc |
535 | Some old keyboards do not have an AltGr key, which can make it |
536 | difficult to type some characters. PuTTY can be configured to treat |
537 | the key combination Ctrl + Left Alt the same way as the AltGr key. |
b5752f1b |
538 | |
add788fc |
539 | By default, this checkbox is checked, and the key combination Ctrl + |
540 | Left Alt does something completely different. PuTTY's usual handling |
541 | of the left Alt key is to prefix the Escape (Control-\cw{[}) |
542 | character to whatever character sequence the rest of the keypress |
543 | would generate. For example, Alt-A generates Escape followed by |
544 | \c{a}. So Alt-Ctrl-A would generate Escape, followed by Control-A. |
b5752f1b |
545 | |
add788fc |
546 | If you uncheck this box, Ctrl-Alt will become a synonym for AltGr, |
547 | so you can use it to type extra graphic characters if your keyboard |
548 | has any. |
b5752f1b |
549 | |
55ba634a |
550 | \H{config-window} The Window panel |
551 | |
1630bb61 |
552 | The Window configuration panel allows you to control aspects of the |
553 | PuTTY window and its behaviour. |
554 | |
55ba634a |
555 | \S{config-winsize} Setting the size of the PuTTY window |
556 | |
d60c975d |
557 | The \q{Rows} and \q{Columns} boxes let you set the PuTTY window to a |
1630bb61 |
558 | precise size. Of course you can also drag the window to a new size |
559 | while a session is running. |
560 | |
add788fc |
561 | \S{config-winsizelock} Locking the size of the PuTTY window |
562 | |
563 | These options allow you to control what happens when the user tries |
564 | to resize the PuTTY window. |
565 | |
566 | When you resize the PuTTY window, one of three things can happen: |
567 | |
568 | \b Nothing (if you have completely disabled resizes). |
569 | |
570 | \b The font size can stay the same and the number of rows and |
571 | columns in the terminal can change. |
572 | |
573 | \b The number of rows and columns in the terminal can stay the same, |
574 | and the font size can change. |
575 | |
576 | You can control which of these happens using the \q{Lock terminal |
577 | size against resizing} and \q{Lock font size against resizing} |
578 | options. If you lock both, the window will refuse to be resized at |
579 | all. If you lock just the terminal size, the font size will change |
580 | when you resize the window. If you lock just the font size, the |
581 | terminal size will change when you resize the window. |
1630bb61 |
582 | |
55ba634a |
583 | \S{config-scrollback} Controlling scrollback |
584 | |
fc5a8711 |
585 | These options let you configure the way PuTTY keeps text after it |
586 | scrolls off the top of the screen (see \k{using-scrollback}). |
1630bb61 |
587 | |
588 | The \q{Lines of scrollback} box lets you configure how many lines of |
589 | text PuTTY keeps. The \q{Display scrollbar} option allows you to |
590 | hide the scrollbar (although you can still view the scrollback using |
591 | Shift-PgUp and Shift-PgDn). |
592 | |
593 | If you are viewing part of the scrollback when the server sends more |
594 | text to PuTTY, the screen will revert to showing the current |
595 | terminal contents. You can disable this behaviour by turning off |
596 | \q{Reset scrollback on display activity}. You can also make the |
597 | screen revert when you press a key, by turning on \q{Reset |
598 | scrollback on keypress}. |
599 | |
55ba634a |
600 | \S{config-warnonclose} \q{Warn before closing window} |
601 | |
1630bb61 |
602 | If you press the Close button in a PuTTY window that contains a |
603 | running session, PuTTY will put up a warning window asking if you |
604 | really meant to close the window. A window whose session has already |
605 | terminated can always be closed without a warning. |
606 | |
607 | If you want to be able to close a window quickly, you can disable |
608 | the \q{Warn before closing window} option. |
609 | |
55ba634a |
610 | \S{config-altf4} \q{Window closes on ALT-F4} |
611 | |
1630bb61 |
612 | By default, pressing ALT-F4 causes the window to close (or a warning |
613 | box to appear; see \k{config-warnonclose}). If you disable the |
614 | \q{Window closes on ALT-F4} option, then pressing ALT-F4 will simply |
615 | send a key sequence to the server. |
616 | |
55ba634a |
617 | \S{config-altspace} \q{System menu appears on ALT-Space} |
618 | |
1630bb61 |
619 | If this option is enabled, then pressing ALT-Space will bring up the |
620 | PuTTY window's menu, like clicking on the top left corner. If it is |
621 | disabled, then pressing ALT-Space will just send \c{ESC SPACE} to |
622 | the server. |
623 | |
2470d64e |
624 | Some accessibility programs for Windows may need this option |
625 | enabling to be able to control PuTTY's window successfully. For |
626 | instance, Dragon NaturallySpeaking requires it both to open the |
627 | system menu via voice, and to close, minimise, maximise and restore |
628 | the window. |
629 | |
55ba634a |
630 | \S{config-altonly} \q{System menu appears on Alt alone} |
631 | |
1630bb61 |
632 | If this option is enabled, then pressing and releasing ALT will |
633 | bring up the PuTTY window's menu, like clicking on the top left |
634 | corner. If it is disabled, then pressing and releasing ALT will have |
635 | no effect. |
636 | |
55ba634a |
637 | \S{config-alwaysontop} \q{Ensure window is always on top} |
638 | |
1630bb61 |
639 | If this option is enabled, the PuTTY window will stay on top of all |
640 | other windows. |
641 | |
add788fc |
642 | \S{config-fullscreen} \q{Full screen on Alt-Enter} |
643 | |
644 | If this option is enabled, then pressing Alt-Enter will cause the |
645 | PuTTY window to become full-screen - that is, it will not only |
646 | maximise itself, it will expand so that the title bar goes off the |
647 | top of the screen, and place itself on top of the Windows taskbar, |
648 | so that \e{nothing} is visible on the screen except PuTTY. Pressing |
649 | Alt-Enter again will restore the previous window size. |
650 | |
55ba634a |
651 | \H{config-appearance} The Appearance panel |
652 | |
1630bb61 |
653 | The Appearance configuration panel allows you to control aspects of |
654 | PuTTY's appearance. |
655 | |
55ba634a |
656 | \S{config-cursor} Controlling the appearance of the cursor |
657 | |
26c8f51a |
658 | The \q{Cursor appearance} option lets you configure the cursor to be |
659 | a block, an underline, or a vertical line. A block cursor becomes an |
660 | empty box when the window loses focus; an underline or a vertical |
661 | line becomes dotted. |
662 | |
663 | The \q{Cursor blinks} option makes the cursor blink on and off. This |
664 | works in any of the cursor modes. |
55ba634a |
665 | |
666 | \S{config-font} Controlling the font used in the terminal window |
667 | |
add788fc |
668 | This option allows you to choose what font, in what size, the PuTTY |
669 | terminal window uses to display the text in the session. You will be |
670 | offered a choice from all the fixed-width fonts installed on the |
671 | system. (VT100-style terminal handling can only deal with fixed- |
672 | width fonts.) |
26c8f51a |
673 | |
55ba634a |
674 | \S{config-title} Controlling the window title |
675 | |
add788fc |
676 | The \q{Window title} edit box allows you to set the title of the |
677 | PuTTY window. By default the window title will contain the host name |
678 | followed by \q{PuTTY}, for example \c{server1.example.com - PuTTY}. |
679 | If you want a different window title, this is where to set it. |
680 | |
681 | PuTTY allows the server to send \c{xterm} control sequences which |
682 | modify the title of the window in mid-session. There is also an |
683 | \c{xterm} sequence to modify the title of the window's \e{icon}. |
684 | This makes sense in a windowing system where the window becomes an |
685 | icon when minimised, such as Windows 3.1 or most X Window System |
686 | setups; but in the Windows 95-like user interface it isn't as |
687 | applicable. By default PuTTY's window title and Taskbar caption will |
688 | change into the server-supplied icon title if you minimise the PuTTY |
689 | window, and change back to the server-supplied window title if you |
690 | restore it. (If the server has not bothered to supply a window or |
691 | icon title, none of this will happen.) By checking the box marked |
692 | \q{Avoid ever using icon title}, you can arrange that PuTTY will |
693 | always display the window title, and completely ignore any icon |
694 | titles the server sends it. |
695 | |
696 | \S{config-mouseptr} \q{Hide mouse pointer when typing in window} |
697 | |
698 | If you enable this option, the mouse pointer will disappear if the |
699 | PuTTY window is selected and you press a key. This way, it will not |
700 | obscure any of the text in the window while you work in your |
701 | session. As soon as you move the mouse, the pointer will reappear. |
702 | |
703 | This option is disabled by default, so the mouse pointer remains |
704 | visible at all times. |
705 | |
706 | \S{config-winborder} Controlling the window border |
707 | |
708 | PuTTY allows you to configure the appearance of the window border to |
709 | some extent. |
710 | |
711 | The checkbox marked \q{Sunken-edge border} changes the appearance of |
712 | the window border to something more like a DOS box: the inside edge |
713 | of the border is highlighted as if it sank down to meet the surface |
714 | inside the window. This makes the border a little bit thicker as |
715 | well. It's hard to describe well. Try it and see if you like it. |
716 | |
717 | You can also configure a completely blank gap between the text in |
718 | the window and the border, using the \q{Gap between text and window |
719 | edge} control. By default this is set at one pixel. You can reduce |
720 | it to zero, or increase it further. |
721 | |
55ba634a |
722 | \H{config-translation} The Translation panel |
723 | |
1630bb61 |
724 | The Translation configuration panel allows you to control the |
725 | translation between the character set understood by the server and |
726 | the character set understood by PuTTY. |
727 | |
add788fc |
728 | \S{config-charset} Controlling character set translation |
729 | |
730 | During an interactive session, PuTTY receives a stream of 8-bit |
731 | bytes from the server, and in order to display them on the screen it |
732 | needs to know what character set to interpret them in. |
733 | |
734 | There are a lot of character sets to choose from. The \q{Received |
735 | data assumed to be in which character set} option lets you select |
736 | one. By default PuTTY will attempt to choose a character set that is |
737 | right for your locale as reported by Windows; if it gets it wrong, |
738 | you can select a different one using this control. |
739 | |
740 | A few notable character sets are: |
741 | |
742 | \b The ISO-8859 series are all standard character sets that include |
743 | various accented characters appropriate for different sets of |
744 | languages. |
55ba634a |
745 | |
add788fc |
746 | \b The Win125x series are defined by Microsoft, for similar |
747 | purposes. In particular Win1252 is almost equivalent to ISO-8859-1, |
748 | but contains a few extra characters such as matched quotes and the |
749 | Euro symbol. |
55ba634a |
750 | |
add788fc |
751 | \b If you want the old IBM PC character set with block graphics and |
752 | line-drawing characters, you can select \q{CP437}. |
753 | |
754 | \b PuTTY also supports Unicode mode, in which the data coming from |
755 | the server is interpreted as being in the UTF-8 encoding of Unicode. |
756 | If you select \q{UTF-8} as a character set you can use this mode. |
757 | Not all server-side applications will support it. |
758 | |
759 | \S{config-cyr} \q{Caps Lock acts as Cyrillic switch} |
760 | |
761 | This feature allows you to switch between a US/UK keyboard layout |
762 | and a Cyrillic keyboard layout by using the Caps Lock key, if you |
763 | need to type (for example) Russian and English side by side in the |
764 | same document. |
765 | |
766 | Currently this feature is not expected to work properly if your |
767 | native keyboard layout is not US or UK. |
768 | |
769 | \S{config-linedraw} Controlling display of line drawing characters |
770 | |
771 | VT100-series terminals allow the server to send control sequences |
772 | that shift temporarily into a separate character set for drawing |
773 | lines and boxes. PuTTY has a variety of ways to support this |
774 | capability. In general you should probably try lots of options until |
775 | you find one that your particular font supports. |
776 | |
777 | \b \q{Font has XWindows encoding} is for use with fonts that have a |
778 | special encoding, where the lowest 32 character positions (below the |
779 | ASCII printable range) contain the line-drawing characters. This is |
780 | unlikely to be the case with any standard Windows font; it will |
781 | probably only apply to custom-built fonts or fonts that have been |
782 | automatically converted from the X Window System. |
783 | |
784 | \b \q{Use font in both ANSI and OEM modes} tries to use the same |
785 | font in two different character sets, to obtain a wider range of |
786 | characters. This doesn't always work; some fonts claim to be a |
787 | different size depending on which character set you try to use. |
788 | |
789 | \b \q{Use font in OEM mode only} is more reliable than that, but can |
790 | miss out other characters from the main character set. |
791 | |
792 | \b \q{Poor man's line drawing} assumes that the font \e{cannot} |
793 | generate the line and box characters at all, so it will use the |
794 | \c{+}, \c{-} and \c{|} characters to draw approximations to boxes. |
795 | You should use this option if none of the other options works. |
796 | |
797 | \b \q{Unicode mode} tries to use the box characters that are present |
798 | in Unicode. For good Unicode-supporting fonts this is probably the |
799 | most reliable and functional option. |
55ba634a |
800 | |
801 | \H{config-selection} The Selection panel |
802 | |
1630bb61 |
803 | The Selection panel allows you to control the way copy and paste |
804 | work in the PuTTY window. |
805 | |
add788fc |
806 | \S{config-linedrawpaste} Controlling the pasting of line drawing |
807 | characters |
808 | |
809 | By default, when you copy and paste a piece of the PuTTY screen that |
810 | contains VT100 line and box drawing characters, PuTTY will translate |
811 | them into the \q{poor man's} line-drawing characters \c{+}, \c{-} |
812 | and \c{|}. The checkbox \q{Don't translate line drawing chars} |
813 | disables this feature, so line-drawing characters will be pasted as |
814 | if they were in the normal character set. This will typically mean |
815 | they come out mostly as \c{q} and \c{x}, with a scattering of |
816 | \c{jklmntuvw} at the corners. This might be useful if you were |
817 | trying to recreate the same box layout in another program, for |
818 | example. |
819 | |
55ba634a |
820 | \S{config-mouse} Changing the actions of the mouse buttons |
821 | |
add788fc |
822 | PuTTY's copy and paste mechanism is modelled on the Unix \c{xterm} |
823 | application. The X Window System uses a three-button mouse, and the |
824 | convention is that the left button selects, the right button extends |
825 | an existing selection, and the middle button pastes. |
826 | |
827 | Windows typically only has two mouse buttons, so in PuTTY's default |
828 | configuration, the \e{right} button pastes, and the \e{middle} |
829 | button (if you have one) extends a selection. |
830 | |
831 | If you have a three-button mouse and you are already used to the |
832 | \c{xterm} arrangement, you can select it using the \q{Action of |
833 | mouse buttons} control. |
834 | |
835 | \S{config-mouseshift} \q{Shift overrides application's use of mouse} |
836 | |
837 | PuTTY allows the server to send control codes that let it take over |
838 | the mouse and use it for purposes other than copy and paste. |
839 | Applications which use this feature include the text-mode web |
840 | browser \c{links}, the Usenet newsreader \c{trn} version 4, and the |
841 | file manager \c{mc} (Midnight Commander). |
842 | |
843 | When running one of these applications, pressing the mouse buttons |
844 | no longer performs copy and paste. If you do need to copy and paste, |
845 | you can still do so if you hold down Shift while you do your mouse |
846 | clicks. |
847 | |
848 | However, it is possible in theory for applications to even detect |
849 | and make use of Shift + mouse clicks. We don't know of any |
850 | applications that do this, but in case someone ever writes one, |
851 | unchecking the \q{Shift overrides application's use of mouse} |
852 | checkbox will cause Shift + mouse clicks to go to the server as well |
853 | (so that mouse-driven copy and paste will be completely disabled). |
854 | |
55ba634a |
855 | \S{config-charclasses} Configuring word-by-word selection |
856 | |
add788fc |
857 | PuTTY will select a word at a time in the terminal window if you |
858 | double-click to begin the drag. This panel allows you to control |
859 | precisely what is considered to be a word. |
860 | |
861 | Each character is given a \e{class}, which is a small number |
862 | (typically 0, 1 or 2). PuTTY considers a single word to be any |
863 | number of adjacent characters in the same class. So by modifying the |
864 | assignment of characters to classes, you can modify the word-by-word |
865 | selection behaviour. |
866 | |
867 | In the default configuration, the character classes are: |
868 | |
869 | \b Class 0 contains white space and control characters. |
870 | |
871 | \b Class 1 contains most punctuation. |
872 | |
873 | \b Class 2 contains letters, numbers and a few pieces of punctuation |
874 | (the double quote, minus sign, period, forward slash and |
875 | underscore). |
876 | |
877 | So, for example, if you assign the \c{@} symbol into character class |
878 | 2, you will be able to select an e-mail address with just a double |
879 | click. |
880 | |
881 | In order to adjust these assignments, you start by selecting a group |
882 | of characters in the list box. Then enter a class number in the edit |
883 | box below, and press the \q{Set} button. |
884 | |
885 | This mechanism currently only covers ASCII characters, because it |
886 | isn't feasible to expand the list to cover the whole of Unicode. |
887 | |
55ba634a |
888 | \H{config-colours} The Colours panel |
889 | |
1630bb61 |
890 | The Colours panel allows you to control PuTTY's use of colour. |
891 | |
55ba634a |
892 | \S{config-boldcolour} \q{Bolded text is a different colour} |
893 | |
add788fc |
894 | When the server sends a control sequence indicating that some text |
895 | should be displayed in bold, PuTTY can handle this two ways. It can |
896 | either change the font for a bold version, or use the same font in a |
897 | brighter colour. This control lets you choose which. |
898 | |
899 | By default the box is checked, so non-bold text is displayed in |
900 | light grey and bold text is displayed in bright white (and similarly |
901 | in other colours). If you uncheck the box, bold and non-bold text |
902 | will be displayed in the same colour, and instead the font will |
903 | change to indicate the difference. |
904 | |
55ba634a |
905 | \S{config-logpalette} \q{Attempt to use logical palettes} |
906 | |
add788fc |
907 | Logical palettes are a mechanism by which a Windows application |
908 | running on an 8-bit colour display can select precisely the colours |
909 | it wants instead of going with the Windows standard defaults. |
910 | |
911 | If you are not getting the colours you ask for on an 8-bit display, |
912 | you can try enabling this option. However, be warned that it's never |
913 | worked very well. |
914 | |
55ba634a |
915 | \S{config-colourcfg} Adjusting the colours in the terminal window |
916 | |
add788fc |
917 | The main colour control allows you to specify exactly what colours |
918 | things should be displayed in. To modify one of the PuTTY colours, |
919 | use the list box to select which colour you want to modify. The RGB |
920 | values for that colour will appear on the right-hand side of the |
921 | list box. Now, if you press the \q{Modify} button, you will be |
922 | presented with a colour selector, in which you can choose a new |
923 | colour to go in place of the old one. |
924 | |
925 | PuTTY allows you to set the cursor colour, the default foreground |
926 | and background, and the precise shades of all the ANSI configurable |
927 | colours (black, red, green, yellow, blue, magenta, cyan, and white). |
928 | In addition, if you have selected \q{Bolded text is a different |
929 | colour}, you can also modify the precise shades used for the bold |
930 | versions of these colours. |
931 | |
55ba634a |
932 | \H{config-connection} The Connection panel |
933 | |
1630bb61 |
934 | The Connection panel allows you to configure options that apply to |
935 | more than one type of connection. |
936 | |
55ba634a |
937 | \S{config-termtype} \q{Terminal-type string} |
938 | |
add788fc |
939 | Most servers you might connect to with PuTTY are designed to be |
940 | connected to from lots of different types of terminal. In order to |
941 | send the right control sequences to each one, the server will need |
942 | to know what type of terminal it is dealing with. Therefore, each of |
943 | the SSH, Telnet and Rlogin protocols allow a text string to be sent |
944 | down the connection describing the terminal. |
945 | |
946 | PuTTY attempts to emulate the Unix \c{xterm} program, and by default |
947 | it reflects this by sending \c{xterm} as a terminal-type string. If |
948 | you find this is not doing what you want - perhaps the remote |
949 | terminal reports \q{Unknown terminal type} - you could try setting |
950 | this to something different, such as \c{vt220}. |
951 | |
952 | If you're not sure whether a problem is due to the terminal type |
953 | setting or not, you probably need to consult the manual for your |
954 | application or your server. |
955 | |
55ba634a |
956 | \S{config-username} \q{Auto-login username} |
957 | |
add788fc |
958 | All three of the SSH, Telnet and Rlogin protocols allow you to |
959 | specify what user name you want to log in as, without having to type |
960 | it explicitly every time. (Some Telnet servers don't support this.) |
961 | |
962 | In this box you can type that user name. |
963 | |
55ba634a |
964 | \S{config-keepalive} Using keepalives to prevent disconnection |
965 | |
c33f3243 |
966 | If you find your sessions are closing unexpectedly (\q{Connection |
967 | reset by peer}) after they have been idle for a while, you might |
968 | want to try using this option. |
969 | |
add788fc |
970 | Some network routers and firewalls need to keep track of all |
c33f3243 |
971 | connections through them. Usually, these firewalls will assume a |
972 | connection is dead if no data is transferred in either direction |
973 | after a certain time interval. This can cause PuTTY sessions to be |
974 | unexpectedly closed by the firewall if no traffic is seen in the |
975 | session for some time. |
976 | |
977 | The keepalive option (\q{Seconds between keepalives}) allows you to |
978 | configure PuTTY to send data through the session at regular |
979 | intervals, in a way that does not disrupt the actual terminal |
980 | session. If you find your firewall is cutting idle connections off, |
981 | you can try entering a non-zero value in this field. The value is |
982 | measured in seconds; so, for example, if your firewall cuts |
983 | connections off after ten minutes then you might want to enter 300 |
984 | seconds (5 minutes) in the box. |
985 | |
986 | Note that keepalives are not always helpful. They help if you have a |
987 | firewall which drops your connection after an idle period; but if |
988 | the network between you and the server suffers from breaks in |
989 | connectivity then keepalives can actually make things worse. If a |
990 | session is idle, and connectivity is temporarily lost between the |
991 | endpoints, but the connectivity is restored before either side tries |
992 | to send anything, then there will be no problem - neither endpoint |
993 | will notice that anything was wrong. However, if one side does send |
994 | something during the break, it will repeatedly try to re-send, and |
995 | eventually give up and abandon the connection. Then when |
996 | connectivity is restored, the other side will find that the first |
997 | side doesn't believe there is an open connection any more. |
998 | Keepalives can make this sort of problem worse, because they |
999 | increase the probability that PuTTY will attempt to send data during |
1000 | a break in connectivity. Therefore, you might find they help |
1001 | connection loss, or you might find they make it worse, depending on |
1002 | what \e{kind} of network problems you have between you and the |
1003 | server. |
1004 | |
1005 | Keepalives are only supported in Telnet and SSH; the Rlogin and Raw |
1006 | protocols offer no way of implementing them. |
1007 | |
55ba634a |
1008 | \H{config-telnet} The Telnet panel |
1009 | |
1630bb61 |
1010 | The Telnet panel allows you to configure options that only apply to |
1011 | Telnet sessions. |
1012 | |
55ba634a |
1013 | \S{config-termspeed} \q{Terminal-speed string} |
1014 | |
add788fc |
1015 | Telnet allows the client to send a text string that describes the |
1016 | terminal speed. PuTTY lets you configure this, in case you find the |
1017 | server is reacting badly to the default value. (I'm not aware of any |
1018 | servers that do have a problem with it.) |
1019 | |
55ba634a |
1020 | \S{config-environ} Setting environment variables on the server |
1021 | |
add788fc |
1022 | The Telnet protocol also provides a means for the client to pass |
1023 | environment variables to the server. Many Telnet servers have |
1024 | stopped supporting this feature due to security flaws, but PuTTY |
1025 | still supports it for the benefit of any servers which have found |
1026 | other ways around the security problems than just disabling the |
1027 | whole mechanism. |
1028 | |
1029 | To add an environment variable to the list transmitted down the |
1030 | connection, you enter the variable name in the \q{Variable} box, |
1031 | enter its value in the \q{Value} box, and press the \q{Add} button. |
1032 | To remove one from the list, select it in the list box and press |
1033 | \q{Remove}. |
1034 | |
55ba634a |
1035 | \S{config-oldenviron} \q{Handling of OLD_ENVIRON ambiguity} |
1036 | |
add788fc |
1037 | The original Telnet mechanism for passing environment variables was |
1038 | badly specified. At the time the standard (RFC 1408) was written, |
1039 | BSD telnet implementations were already supporting the feature, and |
1040 | the intention of the standard was to describe the behaviour the BSD |
1041 | implementations were already using. |
1042 | |
1043 | Sadly there was a typing error in the standard when it was issued, |
1044 | and two vital function codes were specified the wrong way round. BSD |
1045 | implementations did not change, and the standard was not corrected. |
1046 | Therefore, it's possible you might find either BSD or RFC-compliant |
1047 | implementations out there. This switch allows you to choose which |
1048 | one PuTTY claims to be. |
1049 | |
1050 | The problem was solved by issuing a second standard, defining a new |
1051 | Telnet mechanism called \cw{NEW_ENVIRON}, which behaved exactly like |
1052 | the original \cw{OLD_ENVIRON} but was not encumbered by existing |
1053 | implementations. Most Telnet servers now support this, and it's |
1054 | unambiguous. This feature should only be needed if you have trouble |
1055 | passing environment variables to quite an old server. |
1056 | |
1057 | \S{config-ptelnet} Passive and active Telnet negotiation modes |
1058 | |
1059 | In a Telnet connection, there are two types of data passed between |
1060 | the client and the server: actual text, and \e{negotiations} about |
1061 | which Telnet extra features to use. |
1062 | |
1063 | PuTTY can use two different strategies for negotiation: |
1064 | |
1065 | \b In \e{active} mode, PuTTY starts to send negotiations as soon as |
1066 | the connection is opened. |
1067 | |
1068 | \b In \e{passive} mode, PuTTY will wait to negotiate until it sees a |
1069 | negotiation from the server. |
1070 | |
1071 | The obvious disadvantage of passive mode is that if the server is |
1072 | also operating in a passive mode, then negotiation will never begin |
1073 | at all. For this reason PuTTY defaults to active mode. |
1074 | |
1075 | However, sometimes passive mode is required in order to successfully |
1076 | get through certain types of firewall and Telnet proxy server. If |
1077 | you have confusing trouble with a firewall, you could try enabling |
1078 | passive mode to see if it helps. |
1079 | |
1080 | \S{config-telnetkey} \q{Keyboard sends telnet Backspace and Interrupt} |
1081 | |
1082 | If this box is checked, the Backspace key on the keyboard will send |
1083 | the Telnet special backspace code, and Control-C will send the |
1084 | Telnet special interrupt code. You probably shouldn't enable this |
1085 | unless you know what you're doing. |
1086 | |
1087 | \H{config-rlogin} The Rlogin panel |
1088 | |
1089 | The Rlogin panel allows you to configure options that only apply to |
1090 | Rlogin sessions. |
1091 | |
1092 | \S{config-rlogin-termspeed} \q{Terminal-speed string} |
1093 | |
1094 | Like Telnet, Rlogin allows the client to send a text string that |
1095 | describes the terminal speed. PuTTY lets you configure this, in case |
1096 | you find the server is reacting badly to the default value. (I'm not |
1097 | aware of any servers that do have a problem with it.) |
1098 | |
1099 | \S{config-rlogin-localuser} \q{Local username} |
1100 | |
1101 | Rlogin allows an automated (password-free) form of login by means of |
1102 | a file called \c{.rhosts} on the server. You put a line in your |
1103 | \c{.rhosts} file saying something like \c{jbloggs@pc1.example.com}, |
1104 | and then when you make an Rlogin connection the client transmits the |
1105 | username of the user running the Rlogin client. The server checks |
1106 | the username and hostname against \c{.rhosts}, and if they match it |
1107 | does not ask for a password. |
1108 | |
1109 | This only works because Unix systems contain a safeguard to stop a |
1110 | user from pretending to be another user in an Rlogin connection. |
1111 | Rlogin connections have to come from port numbers below 1024, and |
1112 | Unix systems prohibit this to unprivileged processes; so when the |
1113 | server sees a connection from a low-numbered port, it assumes the |
1114 | client end of the connection is held by a privileged (and therefore |
1115 | trusted) process, so it believes the claim of who the user is. |
1116 | |
1117 | Windows does not have this restriction: \e{any} user can initiate an |
1118 | outgoing connection from a low-numbered port. Hence, the Rlogin |
1119 | \c{.rhosts} mechanism is completely useless for securely |
1120 | distinguishing several different users on a Windows machine. If you |
1121 | have a \c{.rhosts} entry pointing at a Windows PC, you should assume |
1122 | that \e{anyone} using that PC can spoof your username in an Rlogin |
1123 | connection and access your account on the server. |
1124 | |
1125 | The \q{Local username} control allows you to specify what user name |
1126 | PuTTY should claim you have, in case it doesn't match your Windows |
1127 | user name (or in case you didn't bother to set up a Windows user |
1128 | name). |
1129 | |
55ba634a |
1130 | \H{config-ssh} The SSH panel |
1131 | |
1630bb61 |
1132 | The SSH panel allows you to configure options that only apply to |
1133 | SSH sessions. |
1134 | |
55ba634a |
1135 | \S{config-command} Executing a specific command on the server |
1136 | |
add788fc |
1137 | In SSH, you don't have to run a general shell session on the server. |
1138 | Instead, you can choose to run a single specific command (such as a |
1139 | mail user agent, for example). If you want to do this, enter the |
1140 | command in the \q{Remote command} box. |
1141 | |
1142 | \S{config-ssh-pty} \q{Don't allocate a pseudo-terminal} |
1143 | |
1144 | When connecting to a Unix system, most interactive shell sessions |
1145 | are run in a \e{pseudo-terminal}, which allows the Unix system to |
1146 | pretend it's talking to a real physical terminal device but allows |
1147 | the SSH server to catch all the data coming from that fake device |
1148 | and send it back to the client. |
1149 | |
1150 | Occasionally you might find you have a need to run a session \e{not} |
1151 | in a pseudo-terminal. In PuTTY, this is generally only useful for |
1152 | very specialist purposes; although in Plink (see \k{plink}) it is |
1153 | the usual way of working. |
1154 | |
1155 | \S{config-ssh-comp} \q{Enable compression} |
1156 | |
1157 | This enables data compression in the SSH connection: data sent by |
1158 | the server is compressed before sending, and decompressed at the |
1159 | client end. Likewise, data sent by PuTTY to the server is compressed |
1160 | first and the server decompresses it at the other end. This can help |
1161 | make the most of a low-bandwidth connection. |
1162 | |
1163 | \S{config-ssh-prot} \q{Preferred SSH protocol version} |
1164 | |
1165 | This allows you to select whether you would like to use SSH protocol |
1166 | version 1 or version 2. \#{FIXME: say something about this elsewhere?} |
1167 | |
1168 | PuTTY will attempt to use protocol 1 if the server you connect to |
1169 | does not offer protocol 2, and vice versa. |
1170 | |
1171 | \S{config-ssh-macbug} \q{Imitate SSH 2 MAC bug} |
1172 | |
1173 | This option \e{should} now be unnecessary. It existed in order to |
1174 | work around a bug in early versions (2.3.0 and below) of the SSH |
1175 | server software from \cw{ssh.com}. The symptom of this problem would |
1176 | be that PuTTY would die unexpectedly at the beginning of the |
1177 | session, saying \q{Incorrect MAC received on packet}. |
1178 | |
1179 | Current versions of PuTTY attempt to detect these faulty servers and |
1180 | enable the bug compatibility automatically, so you should never need |
1181 | to use this option any more. |
1182 | |
1183 | \S{config-ssh-encryption} Encryption algorithm selection |
1184 | |
1185 | PuTTY supports a variety of different encryption algorithms, and |
1186 | allows you to choose which one you prefer to use. You can do this by |
1187 | dragging the algorithms up and down in the list box to specify a |
1188 | preference order. When you make an SSH connection, PuTTY will search |
1189 | down the list from the top until it finds an algorithm supported by |
1190 | the server, and then use that. |
1191 | |
1192 | If the algorithm PuTTY finds is below the \q{warn below here} line, |
1193 | you will see a warning box when you make the connection: |
1194 | |
1195 | \c The first cipher supported by the server |
1196 | \c is single-DES, which is below the configured |
1197 | \c warning threshold. |
1198 | \c Do you want to continue with this connection? |
1199 | |
1200 | This warns you that the first available encryption is not a very |
1201 | secure one. Typically you would put the \q{warn below here} line |
1202 | between the encryptions you consider secure and the ones you |
1203 | consider substandard. |
1204 | |
1205 | By default, PuTTY supplies a preference order intended to reflect a |
1206 | reasonable preference in terms of security and speed. |
1207 | |
1208 | \H{config-ssh-auth} The Auth panel |
1209 | |
1210 | The Auth panel allows you to configure authentication options for |
1211 | SSH sessions. |
1212 | |
1213 | \S{config-ssh-tis} \q{Attempt TIS or CryptoCard authentication} |
1214 | |
1215 | TIS and CryptoCard authentication are simple challenge/response |
1216 | forms of authentication available in SSH protocol version 1 only. |
1217 | You might use them if you were using S/Key one-time passwords, for |
1218 | example, or if you had a physical security token that generated |
1219 | responses to authentication challenges. |
1220 | |
1221 | With this switch enabled, PuTTY will attempt these forms of |
1222 | authentication if the server is willing to try them. You will be |
1223 | presented with a challenge string (which will be different every |
1224 | time) and must supply the correct response in order to log in. If |
1225 | your server supports this, you should talk to your system |
1226 | administrator about precisely what form these challenges and |
1227 | responses take. |
1228 | |
1229 | \S{config-ssh-agentfwd} \q{Allow agent forwarding} |
1230 | |
1231 | This option allows the SSH server to open forwarded connections back |
1232 | to your local copy of Pageant. If you are not running Pageant, this |
1233 | option will do nothing. |
1234 | |
1235 | See \k{pageant} for general information on Pageant, and |
1236 | \k{pageant-forward} for information on agent forwarding. Note that |
1237 | there is a security risk involved with enabling this option; see |
1238 | \k{pageant-security} for details. |
1239 | |
1240 | \S{config-ssh-privkey} \q{Private key file for authentication} |
1241 | |
1242 | This box is where you enter the name of your private key file if you |
1243 | are using public key authentication. See \k{pubkey} for information |
1244 | about public key authentication in SSH. |
1245 | |
1246 | \H{config-ssh-tunnels} The Tunnels panel |
1247 | |
1248 | The Tunnels panel allows you to configure tunnelling of other |
1249 | connection types through an SSH connection. |
1250 | |
1251 | \S{config-ssh-x11} X11 forwarding |
1252 | |
1253 | If your server lets you run X Window System applications, X11 |
1254 | forwarding allows you to securely give those applications access to |
1255 | a local X display on your PC. |
1256 | |
1257 | This feature will only be useful if you have an X server on your PC, |
1258 | such as Exceed or XWin32. |
1259 | |
1260 | To enable X11 forwarding, check the \q{Enable X11 forwarding} box. |
1261 | If your X display is not the primary display on your local machine |
1262 | (which it almost certainly will be unless you have deliberately |
1263 | arranged otherwise), you need to enter its location in the \q{X |
1264 | display location} box. |
1265 | |
1266 | \# FIXME: perhaps link to some more general X forwarding info? |
1267 | |
1268 | \S{config-ssh-portfwd} Port forwarding |
1269 | |
1270 | Port forwarding allows you to tunnel other types of network |
1271 | connection down an SSH connection. |
1272 | |
1273 | To set up a local port forwarding, make sure the \q{Local} radio |
1274 | button is set. Then enter a local port number (on your PC) in the |
1275 | \q{Source port} box, and a hostname and port number (separated by a |
1276 | colon) in the \q{Destination} box, and finally press the \q{Add} |
1277 | button. For example, you might select a source port of 10079, and a |
1278 | destination of \c{server2.example.com:79}. |
1279 | |
1280 | If you do this, and then start the session, you should find that |
1281 | connecting to your local PC on port 10079 gives you a connection to |
1282 | port 79 (the finger server) on \c{server2.example.com}. The |
1283 | connection is actually going to PuTTY itself, which encrypts the |
1284 | connection data and sends it down the secure channel to the SSH |
1285 | server. The connection then proceeds in clear from there to the |
1286 | eventual destination. So you might use this (for example) to forward |
1287 | a connection between two non-hostile network zones that are only |
1288 | connected by a hostile zone such as the open Internet. |
1289 | |
1290 | You can forward ports on the SSH server machine in the other |
1291 | direction, too (so the connection will start at the server end and |
1292 | be sent down the secure connection to PuTTY, which will make the |
1293 | real connection to the destination). To work this way round, just |
1294 | click the \q{Remote} radio button instead of \q{Local}. |
55ba634a |
1295 | |
add788fc |
1296 | \# FIXME: perhaps move this to a general port-forwarding section and |
1297 | \# just link to it here? |
37c6fce1 |
1298 | |
1299 | \H{config-file} Storing configuration in a file |
1300 | |
1301 | PuTTY does not currently support storing its configuration in a file |
1302 | instead of the Registry. However, you can work around this with a |
1303 | couple of batch files. |
1304 | |
1305 | You will need a file called (say) \c{PUTTY.BAT} which imports the |
1306 | contents of a file into the Registry, then runs PuTTY, exports the |
1307 | contents of the Registry back into the file, and deletes the |
1308 | Registry entries. This can all be done using the Regedit command |
1309 | line options, so it's all automatic. Here is what you need in |
1310 | \c{PUTTY.BAT}: |
1311 | |
1312 | \c @ECHO OFF |
1313 | \c regedit /s putty.reg |
1314 | \c regedit /s puttyrnd.reg |
1315 | \c start /w putty.exe |
1316 | \c regedit /e puttynew.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY |
1317 | \c copy puttynew.reg putty.reg |
1318 | \c del puttynew.reg |
1319 | \c regedit /s puttydel.reg |
1320 | |
1321 | This batch file needs two auxiliary files: \c{PUTTYRND.REG} which |
1322 | sets up an initial safe location for the \c{PUTTY.RND} random seed |
1323 | file, and \c{PUTTYDEL.REG} which destroys everything in the Registry |
1324 | once it's been successfully saved back to the file. |
1325 | |
1326 | Here is \c{PUTTYDEL.REG}: |
1327 | |
1328 | \c REGEDIT4 |
1329 | \c |
1330 | \c [-HKEY_CURRENT_USER\Software\SimonTatham\PuTTY] |
1331 | |
1332 | Here is an example \c{PUTTYRND.REG} file: |
1333 | |
1334 | \c REGEDIT4 |
1335 | \c |
1336 | \c [HKEY_CURRENT_USER\Software\SimonTatham\PuTTY] |
1337 | \c "RandSeedFile"="a:\putty.rnd" |
1338 | |
1339 | You should replace \c{a:\\putty.rnd} with the location where you |
1340 | want to store your random number data. If the aim is to carry around |
1341 | PuTTY and its settings on one floppy, you probably want to store it |
1342 | on the floppy. |