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