2b5567cf |
1 | \versionid $Id: using.but,v 1.16 2004/01/19 00:19:32 jacob Exp $ |
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 | |
18 | Often in a PuTTY session you will find text on your terminal screen |
19 | which you want to type in again. Like most other terminal emulators, |
20 | PuTTY allows you to copy and paste the text rather than having to |
21 | type it again. Also, copy and paste uses the Windows clipboard, so |
22 | that you can paste (for example) URLs into a web browser, or paste |
23 | from a word processor or spreadsheet into your terminal session. |
24 | |
25 | PuTTY's copy and paste works entirely with the mouse. In order to |
26 | copy text to the clipboard, you just click the left mouse button in |
27 | the terminal window, and drag to select text. When you let go of the |
28 | button, the text is \e{automatically} copied to the clipboard. You |
29 | do not need to press Ctrl-C or Ctrl-Ins; in fact, if you do press |
30 | Ctrl-C, PuTTY will send a Ctrl-C character down your session to the |
31 | server where it will probably cause a process to be interrupted. |
32 | |
33 | Pasting is done using the right button (or the middle mouse button, |
34 | if you have a three-button mouse and have set it up; see |
aa431b46 |
35 | \k{config-mouse}). Pressing Shift-Ins has the same effect. |
36 | When you click the right mouse button, PuTTY will |
fc5a8711 |
37 | read whatever is in the Windows Clipboard and paste it into your |
38 | session, \e{exactly} as if it had been typed at the keyboard. |
39 | (Therefore, be careful of pasting formatted text into an editor that |
40 | does automatic indenting; you may find that the spaces pasted from |
41 | the clipboard plus the spaces added by the editor add up to too many |
42 | spaces and ruin the formatting. There is nothing PuTTY can do about |
43 | this.) |
44 | |
45 | If you double-click the left mouse button, PuTTY will select a whole |
46 | word. If you double-click, hold down the second click, and drag the |
a5a6cb30 |
47 | mouse, PuTTY will select a sequence of whole words. (You can adjust |
48 | precisely what PuTTY considers to be part of a word; see |
49 | \k{config-charclasses}.) If you \e{triple}-click, or triple-click |
50 | and drag, then PuTTY will select a whole line or sequence of lines. |
fc5a8711 |
51 | |
52 | If you want to select a rectangular region instead of selecting to |
53 | the end of each line, you can do this by holding down Alt when you |
54 | make your selection. (You can also configure rectangular selection |
55 | to be the default, and then holding down Alt gives the normal |
a5a6cb30 |
56 | behaviour instead. See \k{config-rectselect} for details.) |
fc5a8711 |
57 | |
58 | If you have a middle mouse button, then you can use it to adjust an |
59 | existing selection if you selected something slightly wrong. (If you |
60 | have configured the middle mouse button to paste, then the right |
61 | mouse button does this instead.) Click the button on the screen, and |
62 | you can pick up the nearest end of the selection and drag it to |
63 | somewhere else. |
64 | |
6cee219d |
65 | It's possible for the server to ask to handle mouse clicks in the |
66 | PuTTY window itself. If this happens, the mouse cursor will turn |
67 | into an arrow, and copy and paste will only work if you hold down |
68 | Shift. See \k{config-features-mouse} and \k{config-mouseshift} for |
69 | details of this feature and how to configure it. |
70 | |
fc5a8711 |
71 | \S{using-scrollback} Scrolling the screen back |
72 | |
73 | PuTTY keeps track of text that has scrolled up off the top of the |
74 | terminal. So if something appears on the screen that you want to |
75 | read, but it scrolls too fast and it's gone by the time you try to |
76 | look for it, you can use the scrollbar on the right side of the |
77 | window to look back up the session history and find it again. |
78 | |
79 | As well as using the scrollbar, you can also page the scrollback up |
6327f1c1 |
80 | and down by pressing Shift-PgUp and Shift-PgDn. You can scroll a |
81 | line at a time using Ctrl-PgUp and Ctrl-PgDn. These are still |
fc5a8711 |
82 | available if you configure the scrollbar to be invisible. |
83 | |
84 | By default the last 200 lines scrolled off the top are |
85 | preserved for you to look at. You can increase (or decrease) this |
86 | value using the configuration box; see \k{config-scrollback}. |
87 | |
88 | \S{using-sysmenu} The System menu |
89 | |
90 | If you click the left mouse button on the icon in the top left |
91 | corner of PuTTY's window, or click the right mouse button on the |
92 | title bar, you will see the standard Windows system menu containing |
93 | items like Minimise, Move, Size and Close. |
94 | |
95 | PuTTY's system menu contains extra program features in addition to |
96 | the Windows standard options. These extra menu commands are |
97 | described below. |
98 | |
99 | \S2{using-eventlog} The PuTTY Event Log |
100 | |
101 | If you choose \q{Event Log} from the system menu, a small window |
102 | will pop up in which PuTTY logs significant events during the |
103 | connection. Most of the events in the log will probably take place |
104 | during session startup, but a few can occur at any point in the |
105 | session, and one or two occur right at the end. |
106 | |
107 | You can use the mouse to select one or more lines of the Event Log, |
108 | and hit the Copy button to copy them to the clipboard. If you are |
109 | reporting a bug, it's often useful to paste the contents of the |
110 | Event Log into your bug report. |
111 | |
112 | \S2{using-newsession} Starting new sessions |
113 | |
114 | PuTTY's system menu provides some shortcut ways to start new |
115 | sessions: |
116 | |
117 | \b Selecting \q{New Session} will start a completely new instance of |
118 | PuTTY, and bring up the configuration box as normal. |
119 | |
120 | \b Selecting \q{Duplicate Session} will start a session with |
121 | precisely the same options as your current one - connecting to the |
122 | same host using the same protocol, with all the same terminal |
123 | settings and everything. |
124 | |
125 | \b The \q{Saved Sessions} submenu gives you quick access to any |
126 | sets of stored session details you have previously saved. See |
127 | \k{config-saving} for details of how to create saved sessions. |
128 | |
129 | \S2{using-changesettings} Changing your session settings |
130 | |
131 | If you select \q{Change Settings} from the system menu, PuTTY will |
132 | display a cut-down version of its initial configuration box. This |
133 | allows you to adjust most properties of your current session. You |
134 | can change the terminal size, the font, the actions of various |
135 | keypresses, the colours, and so on. |
136 | |
137 | Some of the options that are available in the main configuration box |
138 | are not shown in the cut-down Change Settings box. These are usually |
139 | options which don't make sense to change in the middle of a session |
140 | (for example, you can't switch from SSH to Telnet in mid-session). |
141 | |
142 | \S2{using-copyall} Copy All to Clipboard |
143 | |
144 | This system menu option provides a convenient way to copy the whole |
145 | contents of the terminal screen and scrollback to the clipboard in |
146 | one go. |
147 | |
148 | \S2{reset-terminal} Clearing and resetting the terminal |
149 | |
150 | The \q{Clear Scrollback} option on the system menu tells PuTTY to |
151 | discard all the lines of text that have been kept after they |
152 | scrolled off the top of the screen. This might be useful, for |
153 | example, if you displayed sensitive information and wanted to make |
154 | sure nobody could look over your shoulder and see it. (Note that |
155 | this only prevents a casual user from using the scrollbar to view |
156 | the information; the text is not guaranteed not to still be in |
157 | PuTTY's memory.) |
158 | |
159 | The \q{Reset Terminal} option causes a full reset of the terminal |
160 | emulation. A VT-series terminal is a complex piece of software and |
161 | can easily get into a state where all the text printed becomes |
162 | unreadable. (This can happen, for example, if you accidentally |
163 | output a binary file to your terminal.) If this happens, selecting |
164 | Reset Terminal should sort it out. |
165 | |
166 | \S2{using-fullscreen} Full screen mode |
167 | |
168 | If you find the title bar on a maximised window to be ugly or |
169 | distracting, you can select Full Screen mode to maximise PuTTY |
170 | \q{even more}. When you select this, PuTTY will expand to fill the |
171 | whole screen and its borders, title bar and scrollbar will |
172 | disappear. (You can configure the scrollbar not to disappear in |
a5a6cb30 |
173 | full-screen mode if you want to keep it; see \k{config-scrollback}.) |
fc5a8711 |
174 | |
175 | When you are in full-screen mode, you can still access the system |
176 | menu if you click the left mouse button in the \e{extreme} top left |
177 | corner of the screen. |
178 | |
179 | \H{using-logging} Creating a log file of your session |
180 | |
181 | For some purposes you may find you want to log everything that |
182 | appears on your screen. You can do this using the \q{Logging} panel |
183 | in the configuration box. |
184 | |
185 | To begin a session log, select \q{Change Settings} from the system |
186 | menu and go to the Logging panel. Enter a log file name, and select |
187 | a logging mode. (You can log all session output including the |
188 | terminal control sequences, or you can just log the printable text. |
189 | It depends what you want the log for.) Click \q{Apply} and your log |
190 | will be started. Later on, you can go back to the Logging panel and |
191 | select \q{Logging turned off completely} to stop logging; then PuTTY |
192 | will close the log file and you can safely read it. |
193 | |
194 | See \k{config-logging} for more details and options. |
195 | |
196 | \H{using-translation} Altering your character set configuration |
197 | |
198 | If you find that special characters (accented characters, for |
199 | example) are not being displayed correctly in your PuTTY session, it |
200 | may be that PuTTY is interpreting the characters sent by the server |
201 | according to the wrong \e{character set}. There are a lot of |
202 | different character sets available, so it's entirely possible for |
203 | this to happen. |
204 | |
205 | If you click \q{Change Settings} and look at the \q{Translation} |
206 | panel, you should see a large number of character sets which you can |
207 | select. Now all you need is to find out which of them you want! |
208 | |
2f8d6d43 |
209 | \H{using-x-forwarding} Using X11 forwarding in SSH |
210 | |
211 | The SSH protocol has the ability to securely forward X Window System |
212 | applications over your encrypted SSH connection, so that you can run |
213 | an application on the SSH server machine and have it put its windows |
214 | up on your local machine without sending any X network traffic in |
215 | the clear. |
216 | |
217 | In order to use this feature, you will need an X display server for |
218 | your Windows machine, such as X-Win32 or Exceed. This will probably |
219 | install itself as display number 0 on your local machine; if it |
220 | doesn't, the manual for the X server should tell you what it does |
221 | do. |
222 | |
223 | You should then tick the \q{Enable X11 forwarding} box in the |
224 | Tunnels panel (see \k{config-ssh-x11}) before starting your SSH |
225 | session. The \q{X display location} box reads \c{localhost:0} by |
226 | default, which is the usual display location where your X server |
227 | will be installed. If that needs changing, then change it. |
228 | |
229 | Now you should be able to log in to the SSH server as normal. To |
230 | check that X forwarding has been successfully negotiated during |
231 | connection startup, you can check the PuTTY Event Log (see |
232 | \k{using-eventlog}). It should say something like this: |
233 | |
234 | \c 2001-12-05 17:22:01 Requesting X11 forwarding |
235 | \c 2001-12-05 17:22:02 X11 forwarding enabled |
236 | |
237 | If the remote system is Unix or Unix-like, you should also be able |
238 | to see that the \c{DISPLAY} environment variable has been set to |
239 | point at display 10 or above on the SSH server machine itself: |
240 | |
241 | \c fred@unixbox:~$ echo $DISPLAY |
242 | \c unixbox:10.0 |
243 | |
244 | If this works, you should then be able to run X applications in the |
245 | remote session and have them display their windows on your PC. |
246 | |
247 | Note that if your PC X server requires authentication to connect, |
248 | then PuTTY cannot currently support it. If this is a problem for |
2b5567cf |
249 | you, you should mail the PuTTY authors \#{FIXME} and give details |
250 | (see \k{feedback}). |
2f8d6d43 |
251 | |
252 | \H{using-port-forwarding} Using port forwarding in SSH |
253 | |
254 | The SSH protocol has the ability to forward arbitrary network |
255 | connections over your encrypted SSH connection, to avoid the network |
256 | traffic being sent in clear. For example, you could use this to |
257 | connect from your home computer to a POP-3 server on a remote |
258 | machine without your POP-3 password being visible to network |
259 | sniffers. |
260 | |
261 | In order to use port forwarding to connect from your local machine |
262 | to a port on a remote server, you need to: |
263 | |
264 | \b Choose a port number on your local machine where PuTTY should |
265 | listen for incoming connections. There are likely to be plenty of |
6ee9b735 |
266 | unused port numbers above 3000. (You can also use a local loopback |
267 | address here; see \k{config-ssh-portfwd} for more details.) |
2f8d6d43 |
268 | |
269 | \b Now, before you start your SSH connection, go to the Tunnels |
270 | panel (see \k{config-ssh-portfwd}). Make sure the \q{Local} radio |
271 | button is set. Enter the local port number into the \q{Source port} |
272 | box. Enter the destination host name and port number into the |
273 | \q{Destination} box, separated by a colon (for example, |
274 | \c{popserver.example.com:110} to connect to a POP-3 server). |
275 | |
276 | \b Now click the \q{Add} button. The details of your port forwarding |
277 | should appear in the list box. |
278 | |
c80f77d8 |
279 | Now start your session and log in. (Port forwarding will not be |
280 | enabled until after you have logged in; otherwise it would be easy |
281 | to perform completely anonymous network attacks, and gain access to |
282 | anyone's virtual private network). To check that PuTTY has set up |
283 | the port forwarding correctly, you can look at the PuTTY Event Log |
284 | (see \k{using-eventlog}). It should say something like this: |
2f8d6d43 |
285 | |
286 | \c 2001-12-05 17:22:10 Local port 3110 forwarding to |
287 | \c popserver.example.com:110 |
288 | |
289 | Now if you connect to the source port number on your local PC, you |
290 | should find that it answers you exactly as if it were the service |
291 | running on the destination machine. So in this example, you could |
292 | then configure an e-mail client to use \c{localhost:3110} as a POP-3 |
293 | server instead of \c{popserver.example.com:110}. (Of course, the |
294 | forwarding will stop happening when your PuTTY session closes down.) |
295 | |
296 | You can also forward ports in the other direction: arrange for a |
297 | particular port number on the \e{server} machine to be forwarded |
298 | back to your PC as a connection to a service on your PC or near it. |
299 | To do this, just select the \q{Remote} radio button instead of the |
300 | \q{Local} one. The \q{Source port} box will now specify a port |
301 | number on the \e{server} (note that most servers will not allow you |
302 | to use port numbers under 1024 for this purpose). |
fc5a8711 |
303 | |
48b7c4b2 |
304 | An alternative way to forward local connections to remote hosts is |
305 | to use dynamic SOCKS proxying. For this, you will need to select the |
306 | \q{Dynamic} radio button instead of \q{Local}, and then you should |
307 | not enter anything into the \q{Destination} box (it will be |
308 | ignored). This will cause PuTTY to listen on the port you have |
309 | specified, and provide a SOCKS proxy service to any programs which |
310 | connect to that port. So, in particular, you can forward other PuTTY |
311 | connections through it by setting up the Proxy control panel (see |
312 | \k{config-proxy} for details). |
313 | |
beefa433 |
314 | The source port for a forwarded connection usually does not accept |
315 | connections from any machine except the SSH client or server machine |
316 | itself (for local and remote forwardings respectively). There are |
317 | controls in the Tunnels panel to change this: |
318 | |
319 | \b The \q{Local ports accept connections from other hosts} option |
48b7c4b2 |
320 | allows you to set up local-to-remote port forwardings (including |
321 | dynamic port forwardings) in such a way that machines other than |
322 | your client PC can connect to the forwarded port. |
beefa433 |
323 | |
324 | \b The \q{Remote ports do the same} option does the same thing for |
325 | remote-to-local port forwardings (so that machines other than the |
326 | SSH server machine can connect to the forwarded port.) Note that |
327 | this feature is only available in the SSH 2 protocol, and not all |
328 | SSH 2 servers support it (OpenSSH 3.0 does not, for example). |
329 | |
fc5a8711 |
330 | \H{using-rawprot} Making raw TCP connections |
331 | |
2f8d6d43 |
332 | A lot of Internet protocols are composed of commands and responses |
333 | in plain text. For example, SMTP (the protocol used to transfer |
334 | e-mail), NNTP (the protocol used to transfer Usenet news), and HTTP |
335 | (the protocol used to serve Web pages) all consist of commands in |
336 | readable plain text. |
337 | |
338 | Sometimes it can be useful to connect directly to one of these |
339 | services and speak the protocol \q{by hand}, by typing protocol |
340 | commands and watching the responses. On Unix machines, you can do |
341 | this using the system's \c{telnet} command to connect to the right |
342 | port number. For example, \c{telnet mailserver.example.com 25} might |
343 | enable you to talk directly to the SMTP service running on a mail |
344 | server. |
345 | |
346 | Although the Unix \c{telnet} program provides this functionality, |
347 | the protocol being used is not really Telnet. Really there is no |
348 | actual protocol at all; the bytes sent down the connection are |
349 | exactly the ones you type, and the bytes shown on the screen are |
350 | exactly the ones sent by the server. Unix \c{telnet} will attempt to |
351 | detect or guess whether the service it is talking to is a real |
352 | Telnet service or not; PuTTY prefers to be told for certain. |
353 | |
354 | In order to make a debugging connection to a service of this type, |
355 | you simply select the fourth protocol name, \q{Raw}, from the |
356 | \q{Protocol} buttons in the \q{Session} configuration panel. (See |
357 | \k{config-hostname}.) You can then enter a host name and a port |
358 | number, and make the connection. |
a10c20dd |
359 | |
e117a742 |
360 | \H{using-cmdline} The PuTTY command line |
a10c20dd |
361 | |
362 | PuTTY can be made to do various things without user intervention by |
363 | supplying command-line arguments (e.g., from a command prompt window, |
364 | or a Windows shortcut). |
365 | |
e117a742 |
366 | \S{using-cmdline-session} Starting a session from the command line |
a10c20dd |
367 | |
368 | These options allow you to bypass the configuration window and launch |
369 | straight into a session. |
370 | |
e117a742 |
371 | To start a connection to a server called \c{host}: |
a10c20dd |
372 | |
e2a197cf |
373 | \c putty.exe [-ssh | -telnet | -rlogin | -raw] [user@]host |
a10c20dd |
374 | |
375 | If this syntax is used, settings are taken from the Default Settings |
e2a197cf |
376 | (see \k{config-saving}); \c{user} overrides these settings if |
377 | supplied. Also, you can specify a protocol, which will override the |
378 | default protocol (see \k{using-cmdline-protocol}). |
a10c20dd |
379 | |
380 | For telnet sessions, the following alternative syntax is supported |
381 | (this makes PuTTY suitable for use as a URL handler for telnet URLs in |
382 | web browsers): |
383 | |
384 | \c putty.exe telnet://host[:port]/ |
385 | |
386 | In order to start an existing saved session called \c{sessionname}, |
e117a742 |
387 | use the \c{-load} option (described in \k{using-cmdline-load}). |
a10c20dd |
388 | |
e117a742 |
389 | \c putty.exe -load "session name" |
a10c20dd |
390 | |
e117a742 |
391 | \S{using-cleanup} \c{-cleanup} |
a10c20dd |
392 | |
393 | If invoked with the \c{-cleanup} option, rather than running as |
394 | normal, PuTTY will remove its registry entries and random seed file |
395 | from the local machine (after confirming with the user). |
e117a742 |
396 | |
397 | \S{using-general-opts} Standard command-line options |
398 | |
399 | PuTTY and its associated tools support a range of command-line |
400 | options, most of which are consistent across all the tools. This |
401 | section lists the available options in all tools. Options which are |
402 | specific to a particular tool are covered in the chapter about that |
403 | tool. |
404 | |
405 | \S2{using-cmdline-load} \c{-load}: load a saved session |
406 | |
407 | The \c{-load} option causes PuTTY to load configuration details out |
408 | of a saved session. If these details include a host name, then this |
409 | option is all you need to make PuTTY start a session (although Plink |
410 | still requires an explicitly specified host name). |
411 | |
412 | You need double quotes around the session name if it contains spaces. |
413 | |
414 | If you want to create a Windows shortcut to start a PuTTY saved |
415 | session, this is the option you should use: your shortcut should |
416 | call something like |
417 | |
418 | \c d:\path\to\putty.exe -load "my session" |
419 | |
420 | (Note that PuTTY itself supports an alternative form of this option, |
421 | for backwards compatibility. If you execute \c{putty @sessionname} |
422 | it will have the same effect as \c{putty -load "sessionname"}. With |
423 | the \c{@} form, no double quotes are required, and the \c{@} sign |
424 | must be the very first thing on the command line. This form of the |
425 | option is deprecated.) |
426 | |
427 | \S2{using-cmdline-protocol} Selecting a protocol: \c{-ssh}, |
428 | \c{-telnet}, \c{-rlogin}, \c{-raw} |
429 | |
430 | To choose which protocol you want to connect with, you can use one |
431 | of these options: |
432 | |
433 | \b \c{-ssh} selects the SSH protocol. |
434 | |
435 | \b \c{-telnet} selects the Telnet protocol. |
436 | |
437 | \b \c{-rlogin} selects the Rlogin protocol. |
438 | |
439 | \b \c{-raw} selects the raw protocol. |
440 | |
441 | These options are not available in the file transfer tools PSCP and |
442 | PSFTP (which only work with the SSH protocol). |
443 | |
444 | These options are equivalent to the protocol selection buttons in |
445 | the Session panel of the PuTTY configuration box (see |
446 | \k{config-hostname}). |
447 | |
448 | \S2{using-cmdline-v} \c{-v}: increase verbosity |
449 | |
450 | Most of the PuTTY tools can be made to tell you more about what they |
451 | are doing by supplying the \c{-v} option. If you are having trouble |
452 | when making a connection, or you're simply curious, you can turn |
453 | this switch on and hope to find out more about what is happening. |
454 | |
455 | \S2{using-cmdline-l} \c{-l}: specify a login name |
456 | |
457 | You can specify the user name to log in as on the remote server |
458 | using the \c{-l} option. For example, \c{plink login.example.com -l |
459 | fred}. |
460 | |
461 | These options are equivalent to the username selection box in the |
462 | Connection panel of the PuTTY configuration box (see |
463 | \k{config-username}). |
464 | |
48b7c4b2 |
465 | \S2{using-cmdline-portfwd} \c{-L}, \c{-R} and \c{-D}: set up port forwardings |
e117a742 |
466 | |
467 | As well as setting up port forwardings in the PuTTY configuration |
468 | (see \k{config-ssh-portfwd}), you can also set up forwardings on the |
469 | command line. The command-line options work just like the ones in |
470 | Unix \c{ssh} programs. |
471 | |
472 | To forward a local port (say 5110) to a remote destination (say |
473 | \cw{popserver.example.com} port 110), you can write something like |
474 | one of these: |
475 | |
476 | \c putty -L 5110:popserver.example.com:110 -load mysession |
477 | \c plink mysession -L 5110:popserver.example.com:110 |
478 | |
48b7c4b2 |
479 | To forward a remote port to a local destination, just use the \c{-R} |
480 | option instead of \c{-L}: |
e117a742 |
481 | |
482 | \c putty -R 5023:mytelnetserver.myhouse.org:23 -load mysession |
483 | \c plink mysession -R 5023:mytelnetserver.myhouse.org:23 |
484 | |
48b7c4b2 |
485 | To set up SOCKS-based dynamic port forwarding on a local port, use |
486 | the \c{-D} option. For this one you only have to pass the port |
487 | number: |
488 | |
489 | \c putty -D 4096 -load mysession |
490 | |
e117a742 |
491 | For general information on port forwarding, see |
492 | \k{using-port-forwarding}. |
493 | |
494 | These options are not available in the file transfer tools PSCP and |
495 | PSFTP. |
496 | |
497 | \S2{using-cmdline-m} \c{-m}: read a remote command or script from a |
498 | file |
499 | |
500 | The \c{-m} option performs a similar function to the \q{Remote |
501 | command} box in the SSH panel of the PuTTY configuration box (see |
502 | \k{config-command}). However, the \c{-m} option expects to be given |
fd66175e |
503 | a local file name, and it will read a command from that file. On most Unix |
e117a742 |
504 | systems, you can even put multiple lines in this file and execute |
505 | more than one command in sequence, or a whole shell script. |
506 | |
507 | This option is not available in the file transfer tools PSCP and |
508 | PSFTP. |
509 | |
e2a197cf |
510 | \S2{using-cmdline-p} \c{-P}: specify a port number |
e117a742 |
511 | |
e2a197cf |
512 | The \c{-P} option is used to specify the port number to connect to. If |
513 | you have a Telnet server running on port 9696 of a machine instead of |
514 | port 23, for example: |
e117a742 |
515 | |
e2a197cf |
516 | \c putty -telnet -P 9696 host.name |
517 | \c plink -telnet -P 9696 host.name |
e117a742 |
518 | |
519 | (Note that this option is more useful in Plink than in PuTTY, |
520 | because in PuTTY you can write \c{putty -telnet host.name 9696} in |
521 | any case.) |
522 | |
523 | These options are equivalent to the protocol selection buttons in |
524 | the Session panel of the PuTTY configuration box (see |
525 | \k{config-hostname}). |
526 | |
527 | \S2{using-cmdline-pw} \c{-pw}: specify a password |
528 | |
529 | A simple way to automate a remote login is to supply your password |
530 | on the command line. This is \e{not recommended} for reasons of |
531 | security. If you possibly can, we recommend you set up public-key |
532 | authentication instead. See \k{pubkey} for details. |
533 | |
534 | Note that the \c{-pw} option only works when you are using the SSH |
535 | protocol. Due to fundamental limitations of Telnet and Rlogin, these |
536 | protocols do not support automated password authentication. |
537 | |
538 | \S2{using-cmdline-agent} \c{-A} and \c{-a}: control agent forwarding |
539 | |
540 | The \c{-A} option turns on SSH agent forwarding, and \c{-a} turns it |
541 | off. These options are only meaningful if you are using SSH. |
542 | |
543 | See \k{pageant} for general information on Pageant, and |
544 | \k{pageant-forward} for information on agent forwarding. Note that |
545 | there is a security risk involved with enabling this option; see |
546 | \k{pageant-security} for details. |
547 | |
548 | These options are equivalent to the agent forwarding checkbox in the |
549 | Auth panel of the PuTTY configuration box (see \k{config-ssh-agentfwd}). |
550 | |
551 | These options are not available in the file transfer tools PSCP and |
552 | PSFTP. |
553 | |
554 | \S2{using-cmdline-x11} \c{-X} and \c{-x}: control X11 forwarding |
555 | |
556 | The \c{-X} option turns on X11 forwarding in SSH, and \c{-x} turns |
557 | it off. These options are only meaningful if you are using SSH. |
558 | |
559 | For information on X11 forwarding, see \k{using-x-forwarding}. |
560 | |
561 | These options are equivalent to the X11 forwarding checkbox in the |
562 | Tunnels panel of the PuTTY configuration box (see |
563 | \k{config-ssh-x11}). |
564 | |
565 | These options are not available in the file transfer tools PSCP and |
566 | PSFTP. |
567 | |
568 | \S2{using-cmdline-pty} \c{-t} and \c{-T}: control pseudo-terminal |
569 | allocation |
570 | |
571 | The \c{-t} option ensures PuTTY attempts to allocate a |
572 | pseudo-terminal at the server, and \c{-T} stops it from allocating |
573 | one. These options are only meaningful if you are using SSH. |
574 | |
575 | These options are equivalent to the \q{Don't allocate a |
576 | pseudo-terminal} checkbox in the SSH panel of the PuTTY |
577 | configuration box (see \k{config-ssh-pty}). |
578 | |
579 | These options are not available in the file transfer tools PSCP and |
580 | PSFTP. |
581 | |
582 | \S2{using-cmdline-compress} \c{-C}: enable compression |
583 | |
584 | The \c{-C} option enables compression of the data sent across the |
585 | network. This option is only meaningful if you are using SSH. |
586 | |
587 | This option is equivalent to the \q{Enable compression} checkbox in |
588 | the SSH panel of the PuTTY configuration box (see |
589 | \k{config-ssh-comp}). |
590 | |
591 | \S2{using-cmdline-sshprot} \c{-1} and \c{-2}: specify an SSH protocol |
592 | version |
593 | |
594 | The \c{-1} and \c{-2} options force PuTTY to use version 1 or |
595 | version 2 of the SSH protocol. These options are only meaningful if |
596 | you are using SSH. |
597 | |
598 | These options are equivalent to selecting your preferred SSH |
599 | protocol version as \q{1 only} or \q{2 only} in the SSH panel of the |
600 | PuTTY configuration box (see \k{config-ssh-prot}). |
601 | |
602 | \S2{using-cmdline-identity} \c{-i}: specify an SSH private key |
603 | |
604 | The \c{-i} option allows you to specify the name of a private key |
8cee3b72 |
605 | file in \c{*.PPK} format which PuTTY will use to authenticate with the |
606 | server. This option is only meaningful if you are using SSH. |
e117a742 |
607 | |
608 | For general information on public-key authentication, see \k{pubkey}. |
609 | |
610 | This option is equivalent to the \q{Private key file for |
611 | authentication} box in the Auth panel of the PuTTY configuration box |
612 | (see \k{config-ssh-privkey}). |