39a938f7 |
1 | \define{versionidusing} \versionid $Id$ |
fc5a8711 |
2 | |
3 | \C{using} Using PuTTY |
4 | |
5 | This chapter provides a general introduction to some more advanced |
6 | features of PuTTY. For extreme detail and reference purposes, |
7 | \k{config} is likely to contain more information. |
8 | |
9 | \H{using-session} During your session |
10 | |
11 | A lot of PuTTY's complexity and features are in the configuration |
12 | panel. Once you have worked your way through that and started |
13 | a session, things should be reasonably simple after that. |
14 | Nevertheless, there are a few more useful features available. |
15 | |
16 | \S{using-selection} Copying and pasting text |
17 | |
6cc170f0 |
18 | \I{copy and paste}Often in a PuTTY session you will find text on |
19 | your terminal screen which you want to type in again. Like most |
20 | other terminal emulators, PuTTY allows you to copy and paste the |
21 | text rather than having to type it again. Also, copy and paste uses |
22 | the \I{Windows clipboard}Windows \i{clipboard}, so that you can |
23 | paste (for example) URLs into a web browser, or paste from a word |
24 | processor or spreadsheet into your terminal session. |
25 | |
26 | PuTTY's copy and paste works entirely with the \i{mouse}. In order |
27 | to copy text to the clipboard, you just click the \i{left mouse |
421406a4 |
28 | button} in the \i{terminal window}, and drag to \I{selecting text}select |
6cc170f0 |
29 | text. When you let go of the button, the text is \e{automatically} |
30 | copied to the clipboard. You do not need to press Ctrl-C or |
31 | Ctrl-Ins; in fact, if you do press Ctrl-C, PuTTY will send a Ctrl-C |
32 | character down your session to the server where it will probably |
33 | cause a process to be interrupted. |
fc5a8711 |
34 | |
35 | Pasting is done using the right button (or the middle mouse button, |
421406a4 |
36 | if you have a \i{three-button mouse} and have set it up; see |
6cc170f0 |
37 | \k{config-mouse}). (Pressing \i{Shift-Ins}, or selecting \q{Paste} |
421406a4 |
38 | from the \I{right mouse button, with Ctrl}Ctrl+right-click |
39 | \i{context menu}, have the same effect.) When |
6cc170f0 |
40 | you click the \i{right mouse button}, PuTTY will read whatever is in |
41 | the Windows clipboard and paste it into your session, \e{exactly} as |
42 | if it had been typed at the keyboard. (Therefore, be careful of |
43 | pasting formatted text into an editor that does automatic indenting; |
44 | you may find that the spaces pasted from the clipboard plus the |
45 | spaces added by the editor add up to too many spaces and ruin the |
46 | formatting. There is nothing PuTTY can do about this.) |
47 | |
421406a4 |
48 | If you \i{double-click} the left mouse button, PuTTY will |
49 | \I{selecting words}select a whole word. If you double-click, hold |
50 | down the second click, and drag the mouse, PuTTY will select a |
51 | sequence of whole words. (You can adjust precisely what PuTTY |
52 | considers to be part of a word; see \k{config-charclasses}.) |
53 | If you \e{triple}-click, or \i{triple-click} and drag, then |
54 | PuTTY will \I{selecting lines}select a whole line or sequence of lines. |
6cc170f0 |
55 | |
56 | If you want to select a \I{rectangular selection}rectangular region |
57 | instead of selecting to the end of each line, you can do this by |
58 | holding down Alt when you make your selection. (You can also |
59 | configure rectangular selection to be the default, and then holding |
60 | down Alt gives the normal behaviour instead. See |
61 | \k{config-rectselect} for details.) |
62 | |
63 | If you have a \i{middle mouse button}, then you can use it to |
64 | \I{adjusting a selection}adjust an existing selection if you |
65 | selected something slightly wrong. (If you have configured the |
66 | middle mouse button to paste, then the right mouse button does this |
67 | instead.) Click the button on the screen, and you can pick up the |
68 | nearest end of the selection and drag it to somewhere else. |
fc5a8711 |
69 | |
421406a4 |
70 | It's possible for the server to ask to \I{mouse reporting}handle mouse |
71 | clicks in the PuTTY window itself. If this happens, the \i{mouse pointer} |
72 | will turn into an arrow, and using the mouse to copy and paste will only |
73 | work if you hold down Shift. See \k{config-features-mouse} and |
25c22a0c |
74 | \k{config-mouseshift} for details of this feature and how to configure |
75 | it. |
6cee219d |
76 | |
6cc170f0 |
77 | \S{using-scrollback} \I{scrollback}Scrolling the screen back |
fc5a8711 |
78 | |
79 | PuTTY keeps track of text that has scrolled up off the top of the |
80 | terminal. So if something appears on the screen that you want to |
81 | read, but it scrolls too fast and it's gone by the time you try to |
421406a4 |
82 | look for it, you can use the \i{scrollbar} on the right side of the |
6cc170f0 |
83 | window to look back up the session \i{history} and find it again. |
fc5a8711 |
84 | |
85 | As well as using the scrollbar, you can also page the scrollback up |
6cc170f0 |
86 | and down by pressing \i{Shift-PgUp} and \i{Shift-PgDn}. You can |
87 | scroll a line at a time using \i{Ctrl-PgUp} and \i{Ctrl-PgDn}. These |
88 | are still available if you configure the scrollbar to be invisible. |
fc5a8711 |
89 | |
90 | By default the last 200 lines scrolled off the top are |
91 | preserved for you to look at. You can increase (or decrease) this |
92 | value using the configuration box; see \k{config-scrollback}. |
93 | |
421406a4 |
94 | \S{using-sysmenu} The \ii{System menu} |
fc5a8711 |
95 | |
96 | If you click the left mouse button on the icon in the top left |
1388ecb1 |
97 | corner of PuTTY's terminal window, or click the right mouse button |
98 | on the title bar, you will see the standard Windows system menu |
99 | containing items like Minimise, Move, Size and Close. |
fc5a8711 |
100 | |
101 | PuTTY's system menu contains extra program features in addition to |
102 | the Windows standard options. These extra menu commands are |
103 | described below. |
104 | |
421406a4 |
105 | (These options are also available in a \i{context menu} brought up |
533d533c |
106 | by holding Ctrl and clicking with the right mouse button anywhere |
421406a4 |
107 | in the \i{PuTTY window}.) |
533d533c |
108 | |
6cc170f0 |
109 | \S2{using-eventlog} The PuTTY \i{Event Log} |
fc5a8711 |
110 | |
111 | If you choose \q{Event Log} from the system menu, a small window |
112 | will pop up in which PuTTY logs significant events during the |
113 | connection. Most of the events in the log will probably take place |
114 | during session startup, but a few can occur at any point in the |
115 | session, and one or two occur right at the end. |
116 | |
117 | You can use the mouse to select one or more lines of the Event Log, |
6cc170f0 |
118 | and hit the Copy button to copy them to the \i{clipboard}. If you |
119 | are reporting a bug, it's often useful to paste the contents of the |
fc5a8711 |
120 | Event Log into your bug report. |
121 | |
6cc170f0 |
122 | \S2{using-specials} \ii{Special commands} |
6b590f79 |
123 | |
6cc170f0 |
124 | Depending on the protocol used for the current session, there may be |
125 | a submenu of \q{special commands}. These are protocol-specific |
9711106b |
126 | tokens, such as a \q{break} signal, that can be sent down a |
2c51c674 |
127 | connection in addition to normal data. Their precise effect is usually |
9711106b |
128 | up to the server. Currently only Telnet, SSH, and serial connections |
129 | have special commands. |
6cc170f0 |
130 | |
421406a4 |
131 | The following \I{Telnet special commands}special commands are |
132 | available in Telnet: |
2c51c674 |
133 | |
3f2ce694 |
134 | \b \I{Are You There, Telnet special command}Are You There |
2c51c674 |
135 | |
3f2ce694 |
136 | \b \I{Break, Telnet special command}Break |
2c51c674 |
137 | |
3f2ce694 |
138 | \b \I{Synch, Telnet special command}Synch |
2c51c674 |
139 | |
3f2ce694 |
140 | \b \I{Erase Character, Telnet special command}Erase Character |
2c51c674 |
141 | |
76d3d354 |
142 | \lcont{ |
143 | PuTTY can also be configured to send this when the Backspace key is |
144 | pressed; see \k{config-telnetkey}. |
145 | } |
146 | |
3f2ce694 |
147 | \b \I{Erase Line, Telnet special command}Erase Line |
2c51c674 |
148 | |
3f2ce694 |
149 | \b \I{Go Ahead, Telnet special command}Go Ahead |
2c51c674 |
150 | |
3f2ce694 |
151 | \b \I{No Operation, Telnet special command}No Operation |
2c51c674 |
152 | |
3f2ce694 |
153 | \lcont{ |
154 | Should have no effect. |
155 | } |
2c51c674 |
156 | |
3f2ce694 |
157 | \b \I{Abort Process, Telnet special command}Abort Process |
2c51c674 |
158 | |
3f2ce694 |
159 | \b \I{Abort Output, Telnet special command}Abort Output |
2c51c674 |
160 | |
3f2ce694 |
161 | \b \I{Interrupt Process, Telnet special command}Interrupt Process |
2c51c674 |
162 | |
76d3d354 |
163 | \lcont{ |
164 | PuTTY can also be configured to send this when Ctrl-C is typed; see |
165 | \k{config-telnetkey}. |
166 | } |
167 | |
3f2ce694 |
168 | \b \I{Suspend Process, Telnet special command}Suspend Process |
2c51c674 |
169 | |
76d3d354 |
170 | \lcont{ |
171 | PuTTY can also be configured to send this when Ctrl-Z is typed; see |
172 | \k{config-telnetkey}. |
173 | } |
174 | |
3f2ce694 |
175 | \b \I{End Of Record, Telnet special command}End Of Record |
2c51c674 |
176 | |
3f2ce694 |
177 | \b \I{End Of File, Telnet special command}End Of File |
2c51c674 |
178 | |
421406a4 |
179 | In an SSH connection, the following \I{SSH special commands}special |
180 | commands are available: |
2c51c674 |
181 | |
421406a4 |
182 | \b \I{IGNORE message, SSH special command}\I{No-op, in SSH}\ii{IGNORE message} |
6f2d0cde |
183 | |
184 | \lcont{ |
185 | Should have no effect. |
186 | } |
187 | |
155f8b88 |
188 | \b \I{Repeat key exchange, SSH special command}Repeat key exchange |
189 | |
190 | \lcont{ |
421406a4 |
191 | Only available in SSH-2. Forces a \i{repeat key exchange} immediately (and |
d57f70af |
192 | resets associated timers and counters). For more information about |
193 | repeat key exchanges, see \k{config-ssh-kex-rekey}. |
155f8b88 |
194 | } |
195 | |
3f2ce694 |
196 | \b \I{Break, SSH special command}Break |
2c51c674 |
197 | |
3f2ce694 |
198 | \lcont{ |
6f2d0cde |
199 | Only available in SSH-2, and only during a session. Optional |
200 | extension; may not be supported by server. PuTTY requests the server's |
201 | default break length. |
3f2ce694 |
202 | } |
2c51c674 |
203 | |
6f2d0cde |
204 | \b \I{Signal, SSH special command}Signals (SIGINT, SIGTERM etc) |
2c51c674 |
205 | |
3f2ce694 |
206 | \lcont{ |
6f2d0cde |
207 | Only available in SSH-2, and only during a session. Sends various |
208 | POSIX signals. Not honoured by all servers. |
3f2ce694 |
209 | } |
6b590f79 |
210 | |
9711106b |
211 | With a serial connection, the only available special command is |
212 | \I{Break, serial special command}\q{Break}. |
213 | |
fc5a8711 |
214 | \S2{using-newsession} Starting new sessions |
215 | |
216 | PuTTY's system menu provides some shortcut ways to start new |
217 | sessions: |
218 | |
6cc170f0 |
219 | \b Selecting \i{\q{New Session}} will start a completely new |
220 | instance of PuTTY, and bring up the configuration box as normal. |
fc5a8711 |
221 | |
8a213300 |
222 | \b Selecting \i{\q{Duplicate Session}} will start a session in a |
223 | new window with precisely the same options as your current one - |
224 | connecting to the same host using the same protocol, with all the |
225 | same terminal settings and everything. |
226 | |
227 | \b In an inactive window, selecting \i{\q{Restart Session}} will |
228 | do the same as \q{Duplicate Session}, but in the current window. |
fc5a8711 |
229 | |
6cc170f0 |
230 | \b The \i{\q{Saved Sessions} submenu} gives you quick access to any |
fc5a8711 |
231 | sets of stored session details you have previously saved. See |
232 | \k{config-saving} for details of how to create saved sessions. |
233 | |
6cc170f0 |
234 | \S2{using-changesettings} \I{settings, changing}Changing your |
235 | session settings |
fc5a8711 |
236 | |
6cc170f0 |
237 | If you select \i{\q{Change Settings}} from the system menu, PuTTY will |
fc5a8711 |
238 | display a cut-down version of its initial configuration box. This |
239 | allows you to adjust most properties of your current session. You |
240 | can change the terminal size, the font, the actions of various |
241 | keypresses, the colours, and so on. |
242 | |
243 | Some of the options that are available in the main configuration box |
244 | are not shown in the cut-down Change Settings box. These are usually |
245 | options which don't make sense to change in the middle of a session |
246 | (for example, you can't switch from SSH to Telnet in mid-session). |
247 | |
9e201f72 |
248 | You can save the current settings to a saved session for future use |
249 | from this dialog box. See \k{config-saving} for more on saved |
250 | sessions. |
251 | |
6cc170f0 |
252 | \S2{using-copyall} \i{Copy All to Clipboard} |
fc5a8711 |
253 | |
254 | This system menu option provides a convenient way to copy the whole |
f20523db |
255 | contents of the terminal screen (up to the last nonempty line) and |
6cc170f0 |
256 | scrollback to the \i{clipboard} in one go. |
fc5a8711 |
257 | |
6cc170f0 |
258 | \S2{reset-terminal} \I{scrollback, clearing}Clearing and |
259 | \I{terminal, resetting}resetting the terminal |
fc5a8711 |
260 | |
6cc170f0 |
261 | The \i{\q{Clear Scrollback}} option on the system menu tells PuTTY |
262 | to discard all the lines of text that have been kept after they |
fc5a8711 |
263 | scrolled off the top of the screen. This might be useful, for |
264 | example, if you displayed sensitive information and wanted to make |
265 | sure nobody could look over your shoulder and see it. (Note that |
266 | this only prevents a casual user from using the scrollbar to view |
267 | the information; the text is not guaranteed not to still be in |
268 | PuTTY's memory.) |
269 | |
6cc170f0 |
270 | The \i{\q{Reset Terminal}} option causes a full reset of the |
421406a4 |
271 | \i{terminal emulation}. A VT-series terminal is a complex piece of |
6cc170f0 |
272 | software and can easily get into a state where all the text printed |
273 | becomes unreadable. (This can happen, for example, if you |
274 | accidentally output a binary file to your terminal.) If this |
275 | happens, selecting Reset Terminal should sort it out. |
fc5a8711 |
276 | |
6cc170f0 |
277 | \S2{using-fullscreen} \ii{Full screen} mode |
fc5a8711 |
278 | |
279 | If you find the title bar on a maximised window to be ugly or |
280 | distracting, you can select Full Screen mode to maximise PuTTY |
281 | \q{even more}. When you select this, PuTTY will expand to fill the |
282 | whole screen and its borders, title bar and scrollbar will |
283 | disappear. (You can configure the scrollbar not to disappear in |
a5a6cb30 |
284 | full-screen mode if you want to keep it; see \k{config-scrollback}.) |
fc5a8711 |
285 | |
421406a4 |
286 | When you are in full-screen mode, you can still access the \i{system |
287 | menu} if you click the left mouse button in the \e{extreme} top left |
fc5a8711 |
288 | corner of the screen. |
289 | |
6cc170f0 |
290 | \H{using-logging} Creating a \i{log file} of your \I{session |
291 | log}session |
fc5a8711 |
292 | |
293 | For some purposes you may find you want to log everything that |
421406a4 |
294 | appears on your screen. You can do this using the \q{Logging} |
295 | panel in the configuration box. |
fc5a8711 |
296 | |
297 | To begin a session log, select \q{Change Settings} from the system |
298 | menu and go to the Logging panel. Enter a log file name, and select |
299 | a logging mode. (You can log all session output including the |
421406a4 |
300 | terminal \i{control sequence}s, or you can just log the printable text. |
fc5a8711 |
301 | It depends what you want the log for.) Click \q{Apply} and your log |
302 | will be started. Later on, you can go back to the Logging panel and |
303 | select \q{Logging turned off completely} to stop logging; then PuTTY |
304 | will close the log file and you can safely read it. |
305 | |
306 | See \k{config-logging} for more details and options. |
307 | |
6cc170f0 |
308 | \H{using-translation} Altering your \i{character set} configuration |
fc5a8711 |
309 | |
6cc170f0 |
310 | If you find that special characters (\i{accented characters}, for |
f80d4744 |
311 | example, or \i{line-drawing characters}) are not being displayed |
312 | correctly in your PuTTY session, it may be that PuTTY is interpreting |
313 | the characters sent by the server according to the wrong \e{character |
314 | set}. There are a lot of different character sets available, so it's |
315 | entirely possible for this to happen. |
fc5a8711 |
316 | |
421406a4 |
317 | If you click \q{Change Settings} and look at the \q{Translation} |
318 | panel, you should see a large number of character sets which you can |
f80d4744 |
319 | select, and other related options. Now all you need is to find out |
320 | which of them you want! (See \k{config-translation} for more |
321 | information.) |
fc5a8711 |
322 | |
6cc170f0 |
323 | \H{using-x-forwarding} Using \i{X11 forwarding} in SSH |
2f8d6d43 |
324 | |
325 | The SSH protocol has the ability to securely forward X Window System |
326 | applications over your encrypted SSH connection, so that you can run |
327 | an application on the SSH server machine and have it put its windows |
328 | up on your local machine without sending any X network traffic in |
329 | the clear. |
330 | |
331 | In order to use this feature, you will need an X display server for |
5bbb5c6c |
332 | your Windows machine, such as Cygwin/X, X-Win32, or Exceed. This will probably |
2f8d6d43 |
333 | install itself as display number 0 on your local machine; if it |
6cc170f0 |
334 | doesn't, the manual for the \i{X server} should tell you what it |
335 | does do. |
2f8d6d43 |
336 | |
337 | You should then tick the \q{Enable X11 forwarding} box in the |
338 | Tunnels panel (see \k{config-ssh-x11}) before starting your SSH |
421406a4 |
339 | session. The \i{\q{X display location}} box is blank by default, which |
46ed7b64 |
340 | means that PuTTY will try to use a sensible default such as \c{:0}, |
341 | which is the usual display location where your X server will be |
342 | installed. If that needs changing, then change it. |
2f8d6d43 |
343 | |
344 | Now you should be able to log in to the SSH server as normal. To |
345 | check that X forwarding has been successfully negotiated during |
346 | connection startup, you can check the PuTTY Event Log (see |
347 | \k{using-eventlog}). It should say something like this: |
348 | |
349 | \c 2001-12-05 17:22:01 Requesting X11 forwarding |
350 | \c 2001-12-05 17:22:02 X11 forwarding enabled |
351 | |
352 | If the remote system is Unix or Unix-like, you should also be able |
6cc170f0 |
353 | to see that the \i{\c{DISPLAY} environment variable} has been set to |
2f8d6d43 |
354 | point at display 10 or above on the SSH server machine itself: |
355 | |
356 | \c fred@unixbox:~$ echo $DISPLAY |
357 | \c unixbox:10.0 |
358 | |
359 | If this works, you should then be able to run X applications in the |
360 | remote session and have them display their windows on your PC. |
361 | |
421406a4 |
362 | Note that if your PC X server requires \I{X11 authentication}authentication |
363 | to connect, then PuTTY cannot currently support it. If this is a problem for |
2b5567cf |
364 | you, you should mail the PuTTY authors \#{FIXME} and give details |
365 | (see \k{feedback}). |
2f8d6d43 |
366 | |
ee155ed5 |
367 | For more options relating to X11 forwarding, see \k{config-ssh-x11}. |
368 | |
6cc170f0 |
369 | \H{using-port-forwarding} Using \i{port forwarding} in SSH |
2f8d6d43 |
370 | |
421406a4 |
371 | The SSH protocol has the ability to forward arbitrary \i{network |
372 | connection}s over your encrypted SSH connection, to avoid the network |
2f8d6d43 |
373 | traffic being sent in clear. For example, you could use this to |
421406a4 |
374 | connect from your home computer to a \i{POP-3} server on a remote |
2f8d6d43 |
375 | machine without your POP-3 password being visible to network |
376 | sniffers. |
377 | |
421406a4 |
378 | In order to use port forwarding to \I{local port forwarding}connect |
379 | from your local machine to a port on a remote server, you need to: |
2f8d6d43 |
380 | |
421406a4 |
381 | \b Choose a \i{port number} on your local machine where PuTTY should |
2f8d6d43 |
382 | listen for incoming connections. There are likely to be plenty of |
6ee9b735 |
383 | unused port numbers above 3000. (You can also use a local loopback |
dbe6c525 |
384 | address here; see below for more details.) |
2f8d6d43 |
385 | |
386 | \b Now, before you start your SSH connection, go to the Tunnels |
387 | panel (see \k{config-ssh-portfwd}). Make sure the \q{Local} radio |
388 | button is set. Enter the local port number into the \q{Source port} |
389 | box. Enter the destination host name and port number into the |
390 | \q{Destination} box, separated by a colon (for example, |
391 | \c{popserver.example.com:110} to connect to a POP-3 server). |
392 | |
393 | \b Now click the \q{Add} button. The details of your port forwarding |
394 | should appear in the list box. |
395 | |
c80f77d8 |
396 | Now start your session and log in. (Port forwarding will not be |
397 | enabled until after you have logged in; otherwise it would be easy |
398 | to perform completely anonymous network attacks, and gain access to |
414ffbaa |
399 | anyone's virtual private network.) To check that PuTTY has set up |
c80f77d8 |
400 | the port forwarding correctly, you can look at the PuTTY Event Log |
401 | (see \k{using-eventlog}). It should say something like this: |
2f8d6d43 |
402 | |
403 | \c 2001-12-05 17:22:10 Local port 3110 forwarding to |
404 | \c popserver.example.com:110 |
405 | |
406 | Now if you connect to the source port number on your local PC, you |
407 | should find that it answers you exactly as if it were the service |
408 | running on the destination machine. So in this example, you could |
409 | then configure an e-mail client to use \c{localhost:3110} as a POP-3 |
410 | server instead of \c{popserver.example.com:110}. (Of course, the |
411 | forwarding will stop happening when your PuTTY session closes down.) |
412 | |
413 | You can also forward ports in the other direction: arrange for a |
421406a4 |
414 | particular port number on the \e{server} machine to be \I{remote |
415 | port forwarding}forwarded back to your PC as a connection to a |
416 | service on your PC or near it. |
2f8d6d43 |
417 | To do this, just select the \q{Remote} radio button instead of the |
418 | \q{Local} one. The \q{Source port} box will now specify a port |
419 | number on the \e{server} (note that most servers will not allow you |
421406a4 |
420 | to use \I{privileged port}port numbers under 1024 for this purpose). |
fc5a8711 |
421 | |
48b7c4b2 |
422 | An alternative way to forward local connections to remote hosts is |
421406a4 |
423 | to use \I{dynamic port forwarding}dynamic SOCKS proxying. For |
6cc170f0 |
424 | this, you will need to select the \q{Dynamic} radio button instead |
425 | of \q{Local}, and then you should not enter anything into the |
426 | \q{Destination} box (it will be ignored). This will cause PuTTY to |
427 | listen on the port you have specified, and provide a SOCKS proxy |
428 | service to any programs which connect to that port. So, in |
429 | particular, you can forward other PuTTY connections through it by |
430 | setting up the Proxy control panel (see \k{config-proxy} for |
431 | details). |
48b7c4b2 |
432 | |
beefa433 |
433 | The source port for a forwarded connection usually does not accept |
421406a4 |
434 | connections from any machine except the \I{localhost}SSH client or |
435 | server machine itself (for local and remote forwardings respectively). |
436 | There are controls in the Tunnels panel to change this: |
beefa433 |
437 | |
438 | \b The \q{Local ports accept connections from other hosts} option |
48b7c4b2 |
439 | allows you to set up local-to-remote port forwardings (including |
440 | dynamic port forwardings) in such a way that machines other than |
441 | your client PC can connect to the forwarded port. |
beefa433 |
442 | |
443 | \b The \q{Remote ports do the same} option does the same thing for |
444 | remote-to-local port forwardings (so that machines other than the |
445 | SSH server machine can connect to the forwarded port.) Note that |
2e85c969 |
446 | this feature is only available in the SSH-2 protocol, and not all |
421406a4 |
447 | SSH-2 servers honour it (in \i{OpenSSH}, for example, it's usually |
97e12fcd |
448 | disabled by default). |
beefa433 |
449 | |
421406a4 |
450 | You can also specify an \i{IP address} to \I{listen address}listen |
451 | on. Typically a Windows machine can be asked to listen on any single |
452 | IP address in the \cw{127.*.*.*} range, and all of these are |
453 | \i{loopback address}es available only to the local machine. So if |
454 | you forward (for example) \c{127.0.0.5:79} to a remote machine's |
455 | \i\cw{finger} port, then you should be able to run commands such as |
456 | \c{finger fred@127.0.0.5}. |
6cc170f0 |
457 | This can be useful if the program connecting to the forwarded port |
458 | doesn't allow you to change the port number it uses. This feature is |
2e85c969 |
459 | available for local-to-remote forwarded ports; SSH-1 is unable to |
460 | support it for remote-to-local ports, while SSH-2 can support it in |
6cc170f0 |
461 | theory but servers will not necessarily cooperate. |
462 | |
85c598bf |
463 | (Note that if you're using Windows XP Service Pack 2, you may need |
464 | to obtain a fix from Microsoft in order to use addresses like |
465 | \cw{127.0.0.5} - see \k{faq-alternate-localhost}.) |
466 | |
6cc170f0 |
467 | \H{using-rawprot} Making \i{raw TCP connections} |
468 | |
469 | A lot of \I{debugging Internet protocols}Internet protocols are |
470 | composed of commands and responses in plain text. For example, |
471 | \i{SMTP} (the protocol used to transfer e-mail), \i{NNTP} (the |
472 | protocol used to transfer Usenet news), and \i{HTTP} (the protocol |
473 | used to serve Web pages) all consist of commands in readable plain |
474 | text. |
2f8d6d43 |
475 | |
476 | Sometimes it can be useful to connect directly to one of these |
477 | services and speak the protocol \q{by hand}, by typing protocol |
478 | commands and watching the responses. On Unix machines, you can do |
479 | this using the system's \c{telnet} command to connect to the right |
480 | port number. For example, \c{telnet mailserver.example.com 25} might |
481 | enable you to talk directly to the SMTP service running on a mail |
482 | server. |
483 | |
484 | Although the Unix \c{telnet} program provides this functionality, |
485 | the protocol being used is not really Telnet. Really there is no |
486 | actual protocol at all; the bytes sent down the connection are |
487 | exactly the ones you type, and the bytes shown on the screen are |
488 | exactly the ones sent by the server. Unix \c{telnet} will attempt to |
489 | detect or guess whether the service it is talking to is a real |
490 | Telnet service or not; PuTTY prefers to be told for certain. |
491 | |
492 | In order to make a debugging connection to a service of this type, |
6cc170f0 |
493 | you simply select the fourth protocol name, \I{\q{Raw} |
494 | protocol}\q{Raw}, from the \q{Protocol} buttons in the \q{Session} |
495 | configuration panel. (See \k{config-hostname}.) You can then enter a |
496 | host name and a port number, and make the connection. |
a10c20dd |
497 | |
7374c779 |
498 | \H{using-serial} Connecting to a local serial line |
499 | |
500 | PuTTY can connect directly to a local serial line as an alternative |
501 | to making a network connection. In this mode, text typed into the |
502 | PuTTY window will be sent straight out of your computer's serial |
503 | port, and data received through that port will be displayed in the |
504 | PuTTY window. You might use this mode, for example, if your serial |
505 | port is connected to another computer which has a serial connection. |
506 | |
507 | To make a connection of this type, simply select \q{Serial} from the |
508 | \q{Connection type} radio buttons on the \q{Session} configuration |
509 | panel (see \k{config-hostname}). The \q{Host Name} and \q{Port} |
510 | boxes will transform into \q{Serial line} and \q{Speed}, allowing |
511 | you to specify which serial line to use (if your computer has more |
512 | than one) and what speed (baud rate) to use when transferring data. |
513 | For further configuration options (data bits, stop bits, parity, |
514 | flow control), you can use the \q{Serial} configuration panel (see |
515 | \k{config-serial}). |
516 | |
517 | After you start up PuTTY in serial mode, you might find that you |
518 | have to make the first move, by sending some data out of the serial |
519 | line in order to notify the device at the other end that someone is |
520 | there for it to talk to. This probably depends on the device. If you |
521 | start up a PuTTY serial session and nothing appears in the window, |
522 | try pressing Return a few times and see if that helps. |
523 | |
524 | A serial line provides no well defined means for one end of the |
525 | connection to notify the other that the connection is finished. |
526 | Therefore, PuTTY in serial mode will remain connected until you |
527 | close the window using the close button. |
528 | |
e117a742 |
529 | \H{using-cmdline} The PuTTY command line |
a10c20dd |
530 | |
531 | PuTTY can be made to do various things without user intervention by |
6cc170f0 |
532 | supplying \i{command-line arguments} (e.g., from a \i{command prompt |
533 | window}, or a \i{Windows shortcut}). |
a10c20dd |
534 | |
e117a742 |
535 | \S{using-cmdline-session} Starting a session from the command line |
a10c20dd |
536 | |
6cc170f0 |
537 | \I\c{-ssh}\I\c{-telnet}\I\c{-rlogin}\I\c{-raw}These options allow |
538 | you to bypass the configuration window and launch straight into a |
539 | session. |
a10c20dd |
540 | |
e117a742 |
541 | To start a connection to a server called \c{host}: |
a10c20dd |
542 | |
e2a197cf |
543 | \c putty.exe [-ssh | -telnet | -rlogin | -raw] [user@]host |
a10c20dd |
544 | |
421406a4 |
545 | If this syntax is used, settings are taken from the \i{Default Settings} |
e2a197cf |
546 | (see \k{config-saving}); \c{user} overrides these settings if |
547 | supplied. Also, you can specify a protocol, which will override the |
548 | default protocol (see \k{using-cmdline-protocol}). |
a10c20dd |
549 | |
550 | For telnet sessions, the following alternative syntax is supported |
6cc170f0 |
551 | (this makes PuTTY suitable for use as a URL handler for \i{telnet |
552 | URLs} in web browsers): |
a10c20dd |
553 | |
554 | \c putty.exe telnet://host[:port]/ |
555 | |
556 | In order to start an existing saved session called \c{sessionname}, |
e117a742 |
557 | use the \c{-load} option (described in \k{using-cmdline-load}). |
a10c20dd |
558 | |
e117a742 |
559 | \c putty.exe -load "session name" |
a10c20dd |
560 | |
6cc170f0 |
561 | \S{using-cleanup} \i\c{-cleanup} |
a10c20dd |
562 | |
28339579 |
563 | \cfg{winhelp-topic}{options.cleanup} |
564 | |
a10c20dd |
565 | If invoked with the \c{-cleanup} option, rather than running as |
d8bd04b9 |
566 | normal, PuTTY will remove its \I{removing registry entries}registry |
9310cb7d |
567 | entries and \i{random seed file} from the local machine (after |
d8bd04b9 |
568 | confirming with the user). |
e117a742 |
569 | |
9310cb7d |
570 | Note that on \i{multi-user systems}, \c{-cleanup} only removes |
571 | registry entries and files associated with the currently logged-in |
572 | user. |
573 | |
e117a742 |
574 | \S{using-general-opts} Standard command-line options |
575 | |
576 | PuTTY and its associated tools support a range of command-line |
577 | options, most of which are consistent across all the tools. This |
578 | section lists the available options in all tools. Options which are |
579 | specific to a particular tool are covered in the chapter about that |
580 | tool. |
581 | |
6cc170f0 |
582 | \S2{using-cmdline-load} \i\c{-load}: load a saved session |
e117a742 |
583 | |
6cc170f0 |
584 | \I{saved sessions, loading from command line}The \c{-load} option |
585 | causes PuTTY to load configuration details out of a saved session. |
586 | If these details include a host name, then this option is all you |
33f07e96 |
587 | need to make PuTTY start a session. |
e117a742 |
588 | |
589 | You need double quotes around the session name if it contains spaces. |
590 | |
421406a4 |
591 | If you want to create a \i{Windows shortcut} to start a PuTTY saved |
e117a742 |
592 | session, this is the option you should use: your shortcut should |
593 | call something like |
594 | |
595 | \c d:\path\to\putty.exe -load "my session" |
596 | |
597 | (Note that PuTTY itself supports an alternative form of this option, |
d8bd04b9 |
598 | for backwards compatibility. If you execute \i\c{putty @sessionname} |
e117a742 |
599 | it will have the same effect as \c{putty -load "sessionname"}. With |
600 | the \c{@} form, no double quotes are required, and the \c{@} sign |
601 | must be the very first thing on the command line. This form of the |
602 | option is deprecated.) |
603 | |
604 | \S2{using-cmdline-protocol} Selecting a protocol: \c{-ssh}, |
605 | \c{-telnet}, \c{-rlogin}, \c{-raw} |
606 | |
607 | To choose which protocol you want to connect with, you can use one |
608 | of these options: |
609 | |
6cc170f0 |
610 | \b \i\c{-ssh} selects the SSH protocol. |
e117a742 |
611 | |
6cc170f0 |
612 | \b \i\c{-telnet} selects the Telnet protocol. |
e117a742 |
613 | |
6cc170f0 |
614 | \b \i\c{-rlogin} selects the Rlogin protocol. |
e117a742 |
615 | |
6cc170f0 |
616 | \b \i\c{-raw} selects the raw protocol. |
e117a742 |
617 | |
618 | These options are not available in the file transfer tools PSCP and |
619 | PSFTP (which only work with the SSH protocol). |
620 | |
6cc170f0 |
621 | These options are equivalent to the \i{protocol selection} buttons |
622 | in the Session panel of the PuTTY configuration box (see |
e117a742 |
623 | \k{config-hostname}). |
624 | |
6cc170f0 |
625 | \S2{using-cmdline-v} \i\c{-v}: increase verbosity |
e117a742 |
626 | |
6cc170f0 |
627 | \I{verbose mode}Most of the PuTTY tools can be made to tell you more |
628 | about what they are doing by supplying the \c{-v} option. If you are |
629 | having trouble when making a connection, or you're simply curious, |
630 | you can turn this switch on and hope to find out more about what is |
631 | happening. |
e117a742 |
632 | |
6cc170f0 |
633 | \S2{using-cmdline-l} \i\c{-l}: specify a \i{login name} |
e117a742 |
634 | |
635 | You can specify the user name to log in as on the remote server |
636 | using the \c{-l} option. For example, \c{plink login.example.com -l |
637 | fred}. |
638 | |
639 | These options are equivalent to the username selection box in the |
640 | Connection panel of the PuTTY configuration box (see |
641 | \k{config-username}). |
642 | |
b7a5df66 |
643 | \S2{using-cmdline-portfwd} \I{-L-upper}\c{-L}, \I{-R-upper}\c{-R} |
644 | and \I{-D-upper}\c{-D}: set up \i{port forwardings} |
e117a742 |
645 | |
646 | As well as setting up port forwardings in the PuTTY configuration |
647 | (see \k{config-ssh-portfwd}), you can also set up forwardings on the |
648 | command line. The command-line options work just like the ones in |
649 | Unix \c{ssh} programs. |
650 | |
421406a4 |
651 | To \I{local port forwarding}forward a local port (say 5110) to a |
652 | remote destination (say \cw{popserver.example.com} port 110), you |
653 | can write something like one of these: |
e117a742 |
654 | |
655 | \c putty -L 5110:popserver.example.com:110 -load mysession |
656 | \c plink mysession -L 5110:popserver.example.com:110 |
657 | |
421406a4 |
658 | To forward a \I{remote port forwarding}remote port to a local |
659 | destination, just use the \c{-R} option instead of \c{-L}: |
e117a742 |
660 | |
661 | \c putty -R 5023:mytelnetserver.myhouse.org:23 -load mysession |
662 | \c plink mysession -R 5023:mytelnetserver.myhouse.org:23 |
663 | |
421406a4 |
664 | To \I{listen address}specify an IP address for the listening end of the |
665 | tunnel, prepend it to the argument: |
dbe6c525 |
666 | |
667 | \c plink -L 127.0.0.5:23:localhost:23 myhost |
668 | |
421406a4 |
669 | To set up \I{dynamic port forwarding}SOCKS-based dynamic port |
670 | forwarding on a local port, use the \c{-D} option. For this one you |
671 | only have to pass the port number: |
48b7c4b2 |
672 | |
673 | \c putty -D 4096 -load mysession |
674 | |
e117a742 |
675 | For general information on port forwarding, see |
676 | \k{using-port-forwarding}. |
677 | |
678 | These options are not available in the file transfer tools PSCP and |
679 | PSFTP. |
680 | |
421406a4 |
681 | \S2{using-cmdline-m} \i\c{-m}: \I{reading commands from a file}read |
682 | a remote command or script from a file |
e117a742 |
683 | |
421406a4 |
684 | The \i\c{-m} option performs a similar function to the \q{\ii{Remote |
685 | command}} box in the SSH panel of the PuTTY configuration box (see |
e117a742 |
686 | \k{config-command}). However, the \c{-m} option expects to be given |
bcfb73ea |
687 | a local file name, and it will read a command from that file. |
688 | |
689 | With some servers (particularly Unix systems), you can even put |
690 | multiple lines in this file and execute more than one command in |
691 | sequence, or a whole shell script; but this is arguably an abuse, and |
692 | cannot be expected to work on all servers. In particular, it is known |
693 | \e{not} to work with certain \q{embedded} servers, such as \i{Cisco} |
694 | routers. |
e117a742 |
695 | |
696 | This option is not available in the file transfer tools PSCP and |
697 | PSFTP. |
698 | |
b7a5df66 |
699 | \S2{using-cmdline-p} \I{-P-upper}\c{-P}: specify a \i{port number} |
e117a742 |
700 | |
e2a197cf |
701 | The \c{-P} option is used to specify the port number to connect to. If |
702 | you have a Telnet server running on port 9696 of a machine instead of |
703 | port 23, for example: |
e117a742 |
704 | |
e2a197cf |
705 | \c putty -telnet -P 9696 host.name |
706 | \c plink -telnet -P 9696 host.name |
e117a742 |
707 | |
708 | (Note that this option is more useful in Plink than in PuTTY, |
709 | because in PuTTY you can write \c{putty -telnet host.name 9696} in |
710 | any case.) |
711 | |
6cc170f0 |
712 | This option is equivalent to the port number control in the Session |
713 | panel of the PuTTY configuration box (see \k{config-hostname}). |
e117a742 |
714 | |
6cc170f0 |
715 | \S2{using-cmdline-pw} \i\c{-pw}: specify a \i{password} |
e117a742 |
716 | |
717 | A simple way to automate a remote login is to supply your password |
718 | on the command line. This is \e{not recommended} for reasons of |
719 | security. If you possibly can, we recommend you set up public-key |
720 | authentication instead. See \k{pubkey} for details. |
721 | |
722 | Note that the \c{-pw} option only works when you are using the SSH |
723 | protocol. Due to fundamental limitations of Telnet and Rlogin, these |
724 | protocols do not support automated password authentication. |
725 | |
973612f5 |
726 | \S2{using-cmdline-agentauth} \i\c{-agent} and \i\c{-noagent}: |
727 | control use of Pageant for authentication |
728 | |
729 | The \c{-agent} option turns on SSH authentication using Pageant, and |
730 | \c{-noagent} turns it off. These options are only meaningful if you |
731 | are using SSH. |
732 | |
e5708bc7 |
733 | See \k{pageant} for general information on \i{Pageant}. |
973612f5 |
734 | |
735 | These options are equivalent to the agent authentication checkbox in |
736 | the Auth panel of the PuTTY configuration box (see |
737 | \k{config-ssh-tryagent}). |
738 | |
b7a5df66 |
739 | \S2{using-cmdline-agent} \I{-A-upper}\c{-A} and \i\c{-a}: control \i{agent |
6cc170f0 |
740 | forwarding} |
e117a742 |
741 | |
742 | The \c{-A} option turns on SSH agent forwarding, and \c{-a} turns it |
743 | off. These options are only meaningful if you are using SSH. |
744 | |
6cc170f0 |
745 | See \k{pageant} for general information on \i{Pageant}, and |
e117a742 |
746 | \k{pageant-forward} for information on agent forwarding. Note that |
747 | there is a security risk involved with enabling this option; see |
748 | \k{pageant-security} for details. |
749 | |
750 | These options are equivalent to the agent forwarding checkbox in the |
751 | Auth panel of the PuTTY configuration box (see \k{config-ssh-agentfwd}). |
752 | |
753 | These options are not available in the file transfer tools PSCP and |
754 | PSFTP. |
755 | |
b7a5df66 |
756 | \S2{using-cmdline-x11} \I{-X-upper}\c{-X} and \i\c{-x}: control \i{X11 |
6cc170f0 |
757 | forwarding} |
e117a742 |
758 | |
759 | The \c{-X} option turns on X11 forwarding in SSH, and \c{-x} turns |
760 | it off. These options are only meaningful if you are using SSH. |
761 | |
762 | For information on X11 forwarding, see \k{using-x-forwarding}. |
763 | |
764 | These options are equivalent to the X11 forwarding checkbox in the |
765 | Tunnels panel of the PuTTY configuration box (see |
766 | \k{config-ssh-x11}). |
767 | |
768 | These options are not available in the file transfer tools PSCP and |
769 | PSFTP. |
770 | |
b7a5df66 |
771 | \S2{using-cmdline-pty} \i\c{-t} and \I{-T-upper}\c{-T}: control |
6cc170f0 |
772 | \i{pseudo-terminal allocation} |
e117a742 |
773 | |
774 | The \c{-t} option ensures PuTTY attempts to allocate a |
775 | pseudo-terminal at the server, and \c{-T} stops it from allocating |
776 | one. These options are only meaningful if you are using SSH. |
777 | |
778 | These options are equivalent to the \q{Don't allocate a |
779 | pseudo-terminal} checkbox in the SSH panel of the PuTTY |
780 | configuration box (see \k{config-ssh-pty}). |
781 | |
782 | These options are not available in the file transfer tools PSCP and |
783 | PSFTP. |
784 | |
0ed48730 |
785 | \S2{using-cmdline-noshell} \I{-N-upper}\c{-N}: suppress starting a |
d8bd04b9 |
786 | \I{suppressing remote shell}shell or command |
0ed48730 |
787 | |
788 | The \c{-N} option prevents PuTTY from attempting to start a shell or |
789 | command on the remote server. You might want to use this option if |
790 | you are only using the SSH connection for port forwarding, and your |
791 | user account on the server does not have the ability to run a shell. |
792 | |
793 | This feature is only available in SSH protocol version 2 (since the |
794 | version 1 protocol assumes you will always want to run a shell). |
795 | |
796 | This option is equivalent to the \q{Don't start a shell or command |
797 | at all} checkbox in the SSH panel of the PuTTY configuration box |
798 | (see \k{config-ssh-noshell}). |
799 | |
8a213300 |
800 | This option is not available in the file transfer tools PSCP and |
0ed48730 |
801 | PSFTP. |
802 | |
feb02b4e |
803 | \S2{using-cmdline-ncmode} \I{-nc}\c{-nc}: make a \i{remote network |
804 | connection} in place of a remote shell or command |
805 | |
806 | The \c{-nc} option prevents Plink (or PuTTY) from attempting to |
807 | start a shell or command on the remote server. Instead, it will |
808 | instruct the remote server to open a network connection to a host |
809 | name and port number specified by you, and treat that network |
810 | connection as if it were the main session. |
811 | |
812 | You specify a host and port as an argument to the \c{-nc} option, |
813 | with a colon separating the host name from the port number, like |
814 | this: |
815 | |
816 | \c plink host1.example.com -nc host2.example.com:1234 |
817 | |
818 | You might want to use this feature if you needed to make an SSH |
819 | connection to a target host which you can only reach by going |
820 | through a proxy host, and rather than using port forwarding you |
821 | prefer to use the local proxy feature (see \k{config-proxy-type} for |
822 | more about local proxies). In this situation you might select |
823 | \q{Local} proxy type, set your local proxy command to be \cq{plink |
824 | %proxyhost -nc %host:%port}, enter the target host name on the |
825 | Session panel, and enter the directly reachable proxy host name on |
826 | the Proxy panel. |
827 | |
828 | This feature is only available in SSH protocol version 2 (since the |
829 | version 1 protocol assumes you will always want to run a shell). It |
830 | is not available in the file transfer tools PSCP and PSFTP. It is |
831 | available in PuTTY itself, although it is unlikely to be very useful |
832 | in any tool other than Plink. Also, \c{-nc} uses the same server |
833 | functionality as port forwarding, so it will not work if your server |
834 | administrator has disabled port forwarding. |
835 | |
836 | (The option is named \c{-nc} after the Unix program |
837 | \W{http://www.vulnwatch.org/netcat/}\c{nc}, short for \q{netcat}. |
838 | The command \cq{plink host1 -nc host2:port} is very similar in |
839 | functionality to \cq{plink host1 nc host2 port}, which invokes |
840 | \c{nc} on the server and tells it to connect to the specified |
841 | destination. However, Plink's built-in \c{-nc} option does not |
842 | depend on the \c{nc} program being installed on the server.) |
843 | |
b7a5df66 |
844 | \S2{using-cmdline-compress} \I{-C-upper}\c{-C}: enable \i{compression} |
e117a742 |
845 | |
846 | The \c{-C} option enables compression of the data sent across the |
847 | network. This option is only meaningful if you are using SSH. |
848 | |
849 | This option is equivalent to the \q{Enable compression} checkbox in |
850 | the SSH panel of the PuTTY configuration box (see |
851 | \k{config-ssh-comp}). |
852 | |
6cc170f0 |
853 | \S2{using-cmdline-sshprot} \i\c{-1} and \i\c{-2}: specify an \i{SSH |
854 | protocol version} |
e117a742 |
855 | |
2e85c969 |
856 | The \c{-1} and \c{-2} options force PuTTY to use version \I{SSH-1}1 |
857 | or version \I{SSH-2}2 of the SSH protocol. These options are only |
6cc170f0 |
858 | meaningful if you are using SSH. |
e117a742 |
859 | |
860 | These options are equivalent to selecting your preferred SSH |
861 | protocol version as \q{1 only} or \q{2 only} in the SSH panel of the |
862 | PuTTY configuration box (see \k{config-ssh-prot}). |
863 | |
05581745 |
864 | \S2{using-cmdline-ipversion} \i\c{-4} and \i\c{-6}: specify an |
865 | \i{Internet protocol version} |
866 | |
867 | The \c{-4} and \c{-6} options force PuTTY to use the older Internet |
868 | protocol \i{IPv4} or the newer \i{IPv6}. |
869 | |
870 | These options are equivalent to selecting your preferred Internet |
871 | protocol version as \q{IPv4} or \q{IPv6} in the Connection panel of |
872 | the PuTTY configuration box (see \k{config-address-family}). |
873 | |
6cc170f0 |
874 | \S2{using-cmdline-identity} \i\c{-i}: specify an SSH \i{private key} |
e117a742 |
875 | |
876 | The \c{-i} option allows you to specify the name of a private key |
421406a4 |
877 | file in \c{*.\i{PPK}} format which PuTTY will use to authenticate with the |
8cee3b72 |
878 | server. This option is only meaningful if you are using SSH. |
e117a742 |
879 | |
6cc170f0 |
880 | For general information on \i{public-key authentication}, see |
881 | \k{pubkey}. |
e117a742 |
882 | |
883 | This option is equivalent to the \q{Private key file for |
884 | authentication} box in the Auth panel of the PuTTY configuration box |
885 | (see \k{config-ssh-privkey}). |
2285d016 |
886 | |
421406a4 |
887 | \S2{using-cmdline-pgpfp} \i\c{-pgpfp}: display \i{PGP key fingerprint}s |
2285d016 |
888 | |
889 | This option causes the PuTTY tools not to run as normal, but instead |
890 | to display the fingerprints of the PuTTY PGP Master Keys, in order to |
421406a4 |
891 | aid with \i{verifying new versions}. See \k{pgpkeys} for more information. |