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