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