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