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