« back to all changes in this revision
Viewing changes to doc/config.but
- browse files at revision 5
- compare with another revision
- download diff
- download tarball
- view history from revision 5
- Committer: Bazaar Package Importer
- Author(s): Colin Watson
- Date: 2008-05-28 09:28:32 UTC
- mfrom: (4.1.4 hardy)
- Revision ID: james.westby@ubuntu.com-20080528092832-88epkb3d4s1zsw61
Tags: 0.60-3
* Move putty to Applications/Network/Communication menu sub-section.
* Use dh_desktop.
* Use dh_desktop.
- files added:
- Buildscr
- icons
- windows/DEVCPP
- windows/DEVCPP/pageant
- windows/DEVCPP/plink
- windows/DEVCPP/pscp
- windows/DEVCPP/psftp
- windows/DEVCPP/putty
- windows/DEVCPP/puttygen
- windows/DEVCPP/puttytel
- files removed:
- README.txt
- files modified:
- CHECKLST.txt
added
removed
doc/config.but
1
\define{versionidconfig} \versionid $Id: config.but 5593 2005-04-05 18:01:32Z jacob $
1
\define{versionidconfig} \versionid $Id: config.but 7345 2007-02-28 21:30:06Z jacob $
2
2
3
3
\C{config} Configuring PuTTY
4
4
25
25
\b The \q{Host Name} box is where you type the name, or the \i{IP
26
26
address}, of the server you want to connect to.
27
27
28
\b The \q{Protocol} radio buttons let you choose what type of
28
\b The \q{Connection type} radio buttons let you choose what type of
29
29
connection you want to make: a \I{raw TCP connections}raw
30
connection, a \i{Telnet} connection, an \i{Rlogin} connection
31
or an \i{SSH} connection. (See \k{which-one} for a
32
summary of the differences between SSH, Telnet and rlogin, and
33
\k{using-rawprot} for an explanation of \q{raw} connections.)
34
35
\b The \q{Port} box lets you specify which \i{port number} on the server
36
to connect to. If you select Telnet, Rlogin, or SSH, this box will
37
be filled in automatically to the usual value, and you will only
38
need to change it if you have an unusual server. If you select Raw
39
mode, you will almost certainly need to fill in the \q{Port} box.
30
connection, a \i{Telnet} connection, an \i{Rlogin} connection, an
31
\i{SSH} connection, or a connection to a local \i{serial line}. (See
32
\k{which-one} for a summary of the differences between SSH, Telnet
33
and rlogin; see \k{using-rawprot} for an explanation of \q{raw}
34
connections; see \k{using-serial} for information about using a
35
serial line.)
36
37
\b The \q{Port} box lets you specify which \i{port number} on the
38
server to connect to. If you select Telnet, Rlogin, or SSH, this box
39
will be filled in automatically to the usual value, and you will
40
only need to change it if you have an unusual server. If you select
41
Raw mode, you will almost certainly need to fill in the \q{Port} box
42
yourself.
43
44
If you select \q{Serial} from the \q{Connection type} radio buttons,
45
the \q{Host Name} and \q{Port} boxes are replaced by \q{Serial line}
46
and \q{Speed}; see \k{config-serial} for more details of these.
40
47
41
48
\S{config-saving} \ii{Loading and storing saved sessions}
42
49
140
147
PuTTY sessions, for debugging, analysis or future reference.
141
148
142
149
The main option is a radio-button set that specifies whether PuTTY
143
will log anything at all. The options are
144
145
\b \q{Logging turned off completely}. This is the default option; in
146
this mode PuTTY will not create a log file at all.
147
148
\b \q{Log printable output only}. In this mode, a log file will be
150
will log anything at all. The options are:
151
152
\b \q{None}. This is the default option; in this mode PuTTY will not
153
create a log file at all.
154
155
\b \q{Printable output}. In this mode, a log file will be
149
156
created and written to, but only printable text will be saved into
150
157
it. The various terminal control codes that are typically sent down
151
158
an interactive session alongside the printable text will be omitted.
152
159
This might be a useful mode if you want to read a log file in a text
153
160
editor and hope to be able to make sense of it.
154
161
155
\b \q{Log all session output}. In this mode, \e{everything} sent by
162
\b \q{All session output}. In this mode, \e{everything} sent by
156
163
the server into your terminal session is logged. If you view the log
157
164
file in a text editor, therefore, you may well find it full of
158
165
strange control characters. This is a particularly useful mode if
161
168
else can replay the session later in slow motion and watch to see
162
169
what went wrong.
163
170
164
\b \q{\i{Log SSH packet data}}. In this mode (which is only used by SSH
165
connections), the SSH message packets sent over the encrypted
166
connection are written to the log file. You might need this to debug
167
a network-level problem, or more likely to send to the PuTTY authors
168
as part of a bug report. \e{BE WARNED} that if you log in using a
169
password, the password can appear in the log file; see
170
\k{config-logssh} for options that may help to remove sensitive
171
material from the log file before you send it to anyone else.
171
\b \I{SSH packet log}\q{SSH packets}. In this mode (which is only used
172
by SSH connections), the SSH message packets sent over the encrypted
173
connection are written to the log file (as well as \i{Event Log}
174
entries). You might need this to debug a network-level problem, or
175
more likely to send to the PuTTY authors as part of a bug report.
176
\e{BE WARNED} that if you log in using a password, the password can
177
appear in the log file; see \k{config-logssh} for options that may
178
help to remove sensitive material from the log file before you send it
179
to anyone else.
180
181
\b \q{SSH packets and raw data}. In this mode, as well as the
182
decrypted packets (as in the previous mode), the \e{raw} (encrypted,
183
compressed, etc) packets are \e{also} logged. This could be useful to
184
diagnose corruption in transit. (The same caveats as the previous mode
185
apply, of course.)
186
187
Note that the non-SSH logging options (\q{Printable output} and
188
\q{All session output}) only work with PuTTY proper; in programs
189
without terminal emulation (such as Plink), they will have no effect,
190
even if enabled via saved settings.
172
191
173
192
\S{config-logfilename} \q{Log file name}
174
193
247
266
248
267
\cfg{winhelp-topic}{logging.ssh.omitpassword}
249
268
250
When checked, password fields are removed from the log of transmitted
251
packets. (This includes any user responses to challenge-response
252
authentication methods such as \q{keyboard-interactive}.) This does
253
not include X11 authentication data if using X11 forwarding.
269
When checked, decrypted password fields are removed from the log of
270
transmitted packets. (This includes any user responses to
271
challenge-response authentication methods such as
272
\q{keyboard-interactive}.) This does not include X11 authentication
273
data if using X11 forwarding.
254
274
255
275
Note that this will only omit data that PuTTY \e{knows} to be a
256
276
password. However, if you start another login session within your
264
284
265
285
\cfg{winhelp-topic}{logging.ssh.omitdata}
266
286
267
When checked, all \q{session data} is omitted; this is defined as data
268
in terminal sessions and in forwarded channels (TCP, X11, and
269
authentication agent). This will usually substantially reduce the size
270
of the resulting log file.
287
When checked, all decrypted \q{session data} is omitted; this is
288
defined as data in terminal sessions and in forwarded channels (TCP,
289
X11, and authentication agent). This will usually substantially reduce
290
the size of the resulting log file.
271
291
272
292
This option is disabled by default.
273
293
416
436
417
437
Note that this is \e{not} the feature of PuTTY which the server will
418
438
typically use to determine your terminal type. That feature is the
419
\q{Terminal-type string} in the Connection panel; see
439
\q{\ii{Terminal-type} string} in the Connection panel; see
420
440
\k{config-termtype} for details.
421
441
422
442
You can include control characters in the answerback string using
502
522
\H{config-keyboard} The Keyboard panel
503
523
504
524
The Keyboard configuration panel allows you to control the behaviour
505
of the \i{keyboard} in PuTTY.
525
of the \i{keyboard} in PuTTY. The correct state for many of these
526
settings depends on what the server to which PuTTY is connecting
527
expects. With a \i{Unix} server, this is likely to depend on the
528
\i\c{termcap} or \i\c{terminfo} entry it uses, which in turn is likely to
529
be controlled by the \q{\ii{Terminal-type} string} setting in the Connection
530
panel; see \k{config-termtype} for details. If none of the settings here
531
seems to help, you may find \k{faq-keyboard} to be useful.
506
532
507
533
\S{config-backspace} Changing the action of the \ii{Backspace key}
508
534
515
541
This option allows you to choose which code PuTTY generates when you
516
542
press Backspace.
517
543
518
If you are connecting to a Unix system, you will probably find that
544
If you are connecting over SSH, PuTTY by default tells the server
545
the value of this option (see \k{config-ttymodes}), so you may find
546
that the Backspace key does the right thing either way. Similarly,
547
if you are connecting to a \i{Unix} system, you will probably find that
519
548
the Unix \i\c{stty} command lets you configure which the server
520
expects to see, so you might not need to change which one PuTTY
549
expects to see, so again you might not need to change which one PuTTY
521
550
generates. On other systems, the server's expectation might be fixed
522
551
and you might have no choice but to configure PuTTY.
523
552
529
558
(Typing \i{Shift-Backspace} will cause PuTTY to send whichever code
530
559
isn't configured here as the default.)
531
560
532
\S{config-homeend} Changing the action of the \I{Home and End keys}
561
\S{config-homeend} Changing the action of the \i{Home and End keys}
533
562
534
563
\cfg{winhelp-topic}{keyboard.homeend}
535
564
638
667
movement commands (\cw{hjklyubn}). The 5 key generates the \c{.}
639
668
command (do nothing).
640
669
641
Better still, pressing Shift with the keypad keys generates the
642
capital forms of the commands (\cw{HJKLYUBN}), which tells NetHack
643
to keep moving you in the same direction until you encounter
644
something interesting.
670
In addition, pressing Shift or Ctrl with the keypad keys generate
671
the Shift- or Ctrl-keys you would expect (e.g. keypad-7 generates
672
\cq{y}, so Shift-keypad-7 generates \cq{Y} and Ctrl-keypad-7
673
generates Ctrl-Y); these commands tell NetHack to keep moving you in
674
the same direction until you encounter something interesting.
645
675
646
676
For some reason, this feature only works properly when \i{Num Lock} is
647
677
on. We don't know why.
857
887
unexpectedly or inconveniently, you can tell PuTTY not to respond to
858
888
those server commands.
859
889
860
\S{config-features-qtitle} Disabling remote \i{window title} querying
890
\S{config-features-qtitle} Response to remote \i{window title} querying
861
891
862
892
\cfg{winhelp-topic}{features.qtitle}
863
893
874
904
typed at the keyboard. This allows an attacker to fake keypresses
875
905
and potentially cause your server-side applications to do things you
876
906
didn't want. Therefore this feature is disabled by default, and we
877
recommend you do not turn it on unless you \e{really} know what you
878
are doing.
907
recommend you do not set it to \q{Window title} unless you \e{really}
908
know what you are doing.
909
910
There are three settings for this option:
911
912
\dt \q{None}
913
914
\dd PuTTY makes no response whatsoever to the relevant escape
915
sequence. This may upset server-side software that is expecting some
916
sort of response.
917
918
\dt \q{Empty string}
919
920
\dd PuTTY makes a well-formed response, but leaves it blank. Thus,
921
server-side software that expects a response is kept happy, but an
922
attacker cannot influence the response string. This is probably the
923
setting you want if you have no better ideas.
924
925
\dt \q{Window title}
926
927
\dd PuTTY responds with the actual window title. This is dangerous for
928
the reasons described above.
879
929
880
930
\S{config-features-dbackspace} Disabling \i{destructive backspace}
881
931
953
1003
954
1004
\cfg{winhelp-topic}{window.size}
955
1005
956
The \q{\ii{Rows}} and \q{\ii{Columns}} boxes let you set the PuTTY
1006
The \q{\ii{Columns}} and \q{\ii{Rows}} boxes let you set the PuTTY
957
1007
window to a precise size. Of course you can also \I{window resizing}drag
958
1008
the window to a new size while a session is running.
959
1009
1316
1366
1317
1367
If you enable \q{Paste to clipboard in RTF as well as plain text},
1318
1368
PuTTY will write formatting information to the clipboard as well as
1319
the actual text you copy. Currently the only effect of this will be
1369
the actual text you copy. The effect of this is
1320
1370
that if you paste into (say) a word processor, the text will appear
1321
in the word processor in the same \i{font} PuTTY was using to display
1322
it. In future it is likely that other formatting information (bold,
1323
underline, colours) will be copied as well.
1371
in the word processor in the same \i{font}, \i{colour}, and style
1372
(e.g. bold, underline) PuTTY was using to display it.
1324
1373
1325
1374
This option can easily be inconvenient, so by default it is
1326
1375
disabled.
1524
1573
values} for that colour will appear on the right-hand side of the
1525
1574
list box. Now, if you press the \q{Modify} button, you will be
1526
1575
presented with a colour selector, in which you can choose a new
1527
colour to go in place of the old one.
1576
colour to go in place of the old one. (You may also edit the RGB
1577
values directly in the edit boxes, if you wish; each value is an
1578
integer from 0 to 255.)
1528
1579
1529
1580
PuTTY allows you to set the \i{cursor colour}, the \i{default foreground}
1530
1581
and \I{default background}background, and the precise shades of all the
1580
1631
side doesn't believe there is an open connection any more.
1581
1632
Keepalives can make this sort of problem worse, because they
1582
1633
increase the probability that PuTTY will attempt to send data during
1583
a break in connectivity. Therefore, you might find they help
1634
a break in connectivity. (Other types of periodic network activity
1635
can cause this behaviour; in particular, SSH-2 re-keys can have
1636
this effect. See \k{config-ssh-kex-rekey}.)
1637
1638
Therefore, you might find that keepalives help
1584
1639
connection loss, or you might find they make it worse, depending on
1585
1640
what \e{kind} of network problems you have between you and the
1586
1641
server.
1678
1733
send the right \i{control sequence}s to each one, the server will need
1679
1734
to know what type of terminal it is dealing with. Therefore, each of
1680
1735
the SSH, Telnet and Rlogin protocols allow a text string to be sent
1681
down the connection describing the terminal.
1736
down the connection describing the terminal. On a \i{Unix} server,
1737
this selects an entry from the \i\c{termcap} or \i\c{terminfo} database
1738
that tells applications what \i{control sequences} to send to the
1739
terminal, and what character sequences to expect the \i{keyboard}
1740
to generate.
1682
1741
1683
1742
PuTTY attempts to emulate the Unix \i\c{xterm} program, and by default
1684
1743
it reflects this by sending \c{xterm} as a terminal-type string. If
1746
1805
The \ii{Proxy} panel allows you to configure PuTTY to use various types
1747
1806
of proxy in order to make its network connections. The settings in
1748
1807
this panel affect the primary network connection forming your PuTTY
1749
session, but also any extra connections made as a result of SSH \i{port
1808
session, and also any extra connections made as a result of SSH \i{port
1750
1809
forwarding} (see \k{using-port-forwarding}).
1751
1810
1752
1811
\S{config-proxy-type} Setting the proxy type
1771
1830
through to an external host. Selecting \I{Telnet proxy}\q{Telnet}
1772
1831
allows you to tell PuTTY to use this type of proxy.
1773
1832
1833
\b Selecting \I{Local proxy}\q{Local} allows you to specify an arbitrary
1834
command on the local machine to act as a proxy. When the session is
1835
started, instead of creating a TCP connection, PuTTY runs the command
1836
(specified in \k{config-proxy-command}), and uses its standard input and
1837
output streams.
1838
1839
\lcont{
1840
This could be used, for instance, to talk to some kind of network proxy
1841
that PuTTY does not natively support; or you could tunnel a connection
1842
over something other than TCP/IP entirely.
1843
1844
If you want your local proxy command to make a secondary SSH
1845
connection to a proxy host and then tunnel the primary connection
1846
over that, you might well want the \c{-nc} command-line option in
1847
Plink. See \k{using-cmdline-ncmode} for more information.
1848
}
1849
1774
1850
\S{config-proxy-exclude} Excluding parts of the network from proxying
1775
1851
1776
1852
\cfg{winhelp-topic}{proxy.exclude}
1828
1904
proxy without trying to look them up first.
1829
1905
1830
1906
If you set this option to \q{Auto} (the default), PuTTY will do
1831
something it considers appropriate for each type of proxy. Telnet
1832
and HTTP proxies will have host names passed straight to them; SOCKS
1833
proxies will not.
1907
something it considers appropriate for each type of proxy. Telnet,
1908
HTTP, and SOCKS5 proxies will have host names passed straight to
1909
them; SOCKS4 proxies will not.
1834
1910
1835
1911
Note that if you are doing DNS at the proxy, you should make sure
1836
1912
that your proxy exclusion settings (see \k{config-proxy-exclude}) do
1875
1951
passwords.
1876
1952
1877
1953
\b You can specify a way to include a username and password in the
1878
Telnet proxy command (see \k{config-proxy-command}).
1954
Telnet/Local proxy command (see \k{config-proxy-command}).
1879
1955
1880
\S{config-proxy-command} Specifying the Telnet proxy command
1956
\S{config-proxy-command} Specifying the Telnet or Local proxy command
1881
1957
1882
1958
\cfg{winhelp-topic}{proxy.command}
1883
1959
1886
1962
name and a port number. If your proxy needs a different command,
1887
1963
you can enter an alternative here.
1888
1964
1965
If you are using the \i{Local proxy} type, the local command to run
1966
is specified here.
1967
1889
1968
In this string, you can use \c{\\n} to represent a new-line, \c{\\r}
1890
1969
to represent a carriage return, \c{\\t} to represent a tab
1891
1970
character, and \c{\\x} followed by two hex digits to represent any
1895
1974
Also, the special strings \c{%host} and \c{%port} will be replaced
1896
1975
by the host name and port number you want to connect to. The strings
1897
1976
\c{%user} and \c{%pass} will be replaced by the proxy username and
1898
password you specify. To get a literal \c{%} sign, enter \c{%%}.
1977
password you specify. The strings \c{%proxyhost} and \c{%proxyport}
1978
will be replaced by the host details specified on the \e{Proxy} panel,
1979
if any (this is most likely to be useful for the Local proxy type).
1980
To get a literal \c{%} sign, enter \c{%%}.
1899
1981
1900
If the Telnet proxy server prompts for a username and password
1982
If a Telnet proxy server prompts for a username and password
1901
1983
before commands can be sent, you can use a command such as:
1902
1984
1903
1985
\c %user\n%pass\nconnect %host %port\n
2049
2131
mail user agent, for example). If you want to do this, enter the
2050
2132
command in the \q{\ii{Remote command}} box.
2051
2133
2052
\S{config-ssh-pty} \I{pseudo-terminal allocation}\q{Don't allocate
2053
a pseudo-terminal}
2054
2055
\cfg{winhelp-topic}{ssh.nopty}
2056
2057
When connecting to a \i{Unix} system, most \I{interactive
2058
connections}interactive shell sessions are run in a \e{pseudo-terminal},
2059
which allows the Unix system to pretend it's talking to a real physical
2060
terminal device but allows the SSH server to catch all the data coming
2061
from that fake device and send it back to the client.
2062
2063
Occasionally you might find you have a need to run a session \e{not}
2064
in a pseudo-terminal. In PuTTY, this is generally only useful for
2065
very specialist purposes; although in Plink (see \k{plink}) it is
2066
the usual way of working.
2134
Note that most servers will close the session after executing the
2135
command.
2067
2136
2068
2137
\S{config-ssh-noshell} \q{Don't start a \I{remote shell}shell or
2069
2138
\I{remote command}command at all}
2125
2194
2126
2195
PuTTY currently supports the following algorithms:
2127
2196
2128
\b \i{AES} (Rijndael) - 256, 192, or 128-bit CBC (SSH-2 only)
2129
2130
\b \i{Blowfish} - 128-bit CBC
2131
2132
\b \ii{Triple-DES} - 168-bit CBC
2197
\b \i{AES} (Rijndael) - 256, 192, or 128-bit SDCTR or CBC (SSH-2 only)
2198
2199
\b \i{Arcfour} (RC4) - 256 or 128-bit stream cipher (SSH-2 only)
2200
2201
\b \i{Blowfish} - 256-bit SDCTR (SSH-2 only) or 128-bit CBC
2202
2203
\b \ii{Triple-DES} - 168-bit SDCTR (SSH-2 only) or CBC
2133
2204
2134
2205
\b \ii{Single-DES} - 56-bit CBC (see below for SSH-2)
2135
2206
2154
2225
get two warnings similar to the one above, possibly with different
2155
2226
encryptions.
2156
2227
2157
Single-DES is not recommended in the SSH-2 draft protocol
2228
Single-DES is not recommended in the SSH-2 protocol
2158
2229
standards, but one or two server implementations do support it.
2159
2230
PuTTY can use single-DES to interoperate with
2160
2231
these servers if you enable the \q{Enable legacy use of single-DES in
2235
2306
exchange (\q{rekey}). You can also force a key exchange at any time
2236
2307
from the Special Commands menu (see \k{using-specials}).
2237
2308
2238
\# FIXME: do we have any additions to the SSH-2 drafts' advice on
2309
\# FIXME: do we have any additions to the SSH-2 specs' advice on
2239
2310
these values? Do we want to enforce any limits?
2240
2311
2241
2312
\b \q{Max minutes before rekey} specifies the amount of time that is
2289
2360
The Auth panel allows you to configure \i{authentication} options for
2290
2361
SSH sessions.
2291
2362
2363
\S{config-ssh-noauth} \q{Bypass authentication entirely}
2364
2365
\cfg{winhelp-topic}{ssh.auth.bypass}
2366
2367
In SSH-2, it is possible to establish a connection without using SSH's
2368
mechanisms to identify or authenticate oneself to the server. Some
2369
servers may prefer to handle authentication in the data channel, for
2370
instance, or may simply require no authentication whatsoever.
2371
2372
By default, PuTTY assumes the server requires authentication (most
2373
do), and thus must provide a username. If you find you are getting
2374
unwanted username prompts, you could try checking this option.
2375
2376
This option only affects SSH-2 connections. SSH-1 connections always
2377
require an authentication step.
2378
2379
\S{config-ssh-tryagent} \q{Attempt authentication using Pageant}
2380
2381
\cfg{winhelp-topic}{ssh.auth.pageant}
2382
2383
If this option is enabled, then PuTTY will look for Pageant (the SSH
2384
private-key storage agent) and attempt to authenticate with any
2385
suitable public keys Pageant currently holds.
2386
2387
This behaviour is almost always desirable, and is therefore enabled
2388
by default. In rare cases you might need to turn it off in order to
2389
force authentication by some non-public-key method such as
2390
passwords.
2391
2392
This option can also be controlled using the \c{-noagent}
2393
command-line option. See \k{using-cmdline-agentauth}.
2394
2395
See \k{pageant} for more information about Pageant in general.
2396
2292
2397
\S{config-ssh-tis} \q{Attempt \I{TIS authentication}TIS or
2293
2398
\i{CryptoCard authentication}}
2294
2399
2295
2400
\cfg{winhelp-topic}{ssh.auth.tis}
2296
2401
2297
TIS and CryptoCard authentication are simple \I{challenge/response
2298
authentication}challenge/response forms of authentication available in
2299
SSH protocol version 1 only. You might use them if you were using \i{S/Key}
2300
\i{one-time passwords}, for example, or if you had a physical \i{security
2301
token} that generated responses to authentication challenges.
2402
TIS and CryptoCard authentication are (despite their names) generic
2403
forms of simple \I{challenge/response authentication}challenge/response
2404
authentication available in SSH protocol version 1 only. You might use
2405
them if you were using \i{S/Key} \i{one-time passwords}, for example,
2406
or if you had a physical \i{security token} that generated responses
2407
to authentication challenges.
2302
2408
2303
2409
With this switch enabled, PuTTY will attempt these forms of
2304
2410
authentication if the server is willing to try them. You will be
2370
2476
private key in another format that you want to use with PuTTY, see
2371
2477
\k{puttygen-conversions}.
2372
2478
2479
If a key file is specified here, and \i{Pageant} is running (see
2480
\k{pageant}), PuTTY will first try asking Pageant to authenticate with
2481
that key, and ignore any other keys Pageant may have. If that fails,
2482
PuTTY will ask for a passphrase as normal.
2483
2484
\H{config-ssh-tty} The TTY panel
2485
2486
The TTY panel lets you configure the remote pseudo-terminal.
2487
2488
\S{config-ssh-pty} \I{pseudo-terminal allocation}\q{Don't allocate
2489
a pseudo-terminal}
2490
2491
\cfg{winhelp-topic}{ssh.nopty}
2492
2493
When connecting to a \i{Unix} system, most \I{interactive
2494
connections}interactive shell sessions are run in a \e{pseudo-terminal},
2495
which allows the Unix system to pretend it's talking to a real physical
2496
terminal device but allows the SSH server to catch all the data coming
2497
from that fake device and send it back to the client.
2498
2499
Occasionally you might find you have a need to run a session \e{not}
2500
in a pseudo-terminal. In PuTTY, this is generally only useful for
2501
very specialist purposes; although in Plink (see \k{plink}) it is
2502
the usual way of working.
2503
2504
\S{config-ttymodes} Sending \i{terminal modes}
2505
2506
\cfg{winhelp-topic}{ssh.ttymodes}
2507
2508
The SSH protocol allows the client to send \q{terminal modes} for
2509
the remote pseudo-terminal. These usually control the server's
2510
expectation of the local terminal's behaviour.
2511
2512
If your server does not have sensible defaults for these modes, you
2513
may find that changing them here helps. If you don't understand any of
2514
this, it's safe to leave these settings alone.
2515
2516
(None of these settings will have any effect if no pseudo-terminal
2517
is requested or allocated.)
2518
2519
You can add or modify a mode by selecting it from the drop-down list,
2520
choosing whether it's set automatically or to a specific value with
2521
the radio buttons and edit box, and hitting \q{Add}. A mode (or
2522
several) can be removed from the list by selecting them and hitting
2523
\q{Remove}. The effect of the mode list is as follows:
2524
2525
\b If a mode is not on the list, it will not be specified to the
2526
server under any circumstances.
2527
2528
\b If a mode is on the list:
2529
2530
\lcont{
2531
2532
\b If the \q{Auto} option is selected, the PuTTY tools will decide
2533
whether to specify that mode to the server, and if so, will send
2534
a sensible value.
2535
2536
\lcont{
2537
2538
PuTTY proper will send modes that it has an opinion on (currently only
2539
the code for the Backspace key, \cw{ERASE}). Plink on Unix
2540
will propagate appropriate modes from the local terminal, if any.
2541
2542
}
2543
2544
\b If a value is specified, it will be sent to the server under all
2545
circumstances. The precise syntax of the value box depends on the
2546
mode.
2547
2548
}
2549
2550
By default, all of the available modes are listed as \q{Auto},
2551
which should do the right thing in most circumstances.
2552
2553
The precise effect of each setting, if any, is up to the server. Their
2554
names come from \i{POSIX} and other Unix systems, and they are most
2555
likely to have a useful effect on such systems. (These are the same
2556
settings that can usually be changed using the \i\c{stty} command once
2557
logged in to such servers.)
2558
2559
Some notable modes are described below; for fuller explanations, see
2560
your server documentation.
2561
2562
\b \I{ERASE special character}\cw{ERASE} is the character that when typed
2563
by the user will delete one space to the left. When set to \q{Auto}
2564
(the default setting), this follows the setting of the local Backspace
2565
key in PuTTY (see \k{config-backspace}).
2566
2567
\lcont{
2568
This and other \i{special character}s are specified using \c{^C} notation
2569
for Ctrl-C, and so on. Use \c{^<27>} or \c{^<0x1B>} to specify a
2570
character numerically, and \c{^~} to get a literal \c{^}. Other
2571
non-control characters are denoted by themselves. Leaving the box
2572
entirely blank indicates that \e{no} character should be assigned to
2573
the specified function, although this may not be supported by all
2574
servers.
2575
}
2576
2577
\b \I{QUIT special character}\cw{QUIT} is a special character that
2578
usually forcefully ends the current process on the server
2579
(\cw{SIGQUIT}). On many servers its default setting is Ctrl-backslash
2580
(\c{^\\}), which is easy to accidentally invoke on many keyboards. If
2581
this is getting in your way, you may want to change it to another
2582
character or turn it off entirely.
2583
2584
\b Boolean modes such as \cw{ECHO} and \cw{ICANON} can be specified in
2585
PuTTY in a variety of ways, such as \cw{true}/\cw{false},
2586
\cw{yes}/\cw{no}, and \cw{0}/\cw{1}.
2587
2588
\b Terminal speeds are configured elsewhere; see \k{config-termspeed}.
2589
2373
2590
\H{config-ssh-x11} The X11 panel
2374
2591
2375
2592
\cfg{winhelp-topic}{ssh.tunnels.x11}
2460
2677
to a remote destination (\q{Local}) or \I{remote port forwarding}forward
2461
2678
a remote port to a local destination (\q{Remote}). Alternatively,
2462
2679
select \q{Dynamic} if you want PuTTY to \I{dynamic port forwarding}provide
2463
a local SOCKS 4/4A/5 proxy on a local port.
2680
a local SOCKS 4/4A/5 proxy on a local port (note that this proxy only
2681
supports TCP connections; the SSH protocol does not support forwarding
2682
\i{UDP}).
2464
2683
2465
2684
\b Enter a source \i{port number} into the \q{Source port} box. For
2466
2685
local forwardings, PuTTY will listen on this port of your PC. For
2491
2710
known to the local system. For instance, in the \q{Destination} box,
2492
2711
you could enter \c{popserver.example.com:pop3}.
2493
2712
2494
You can modify the currently active set of port forwardings in
2495
mid-session using \q{Change Settings} (see \k{using-changesettings}).
2496
If you delete a local or dynamic port forwarding in mid-session, PuTTY
2497
will stop listening for connections on that port, so it can be re-used
2498
by another program. If you delete a remote port forwarding, note that:
2713
You can \I{port forwarding, changing mid-session}modify the currently
2714
active set of port forwardings in mid-session using \q{Change
2715
Settings} (see \k{using-changesettings}). If you delete a local or
2716
dynamic port forwarding in mid-session, PuTTY will stop listening for
2717
connections on that port, so it can be re-used by another program. If
2718
you delete a remote port forwarding, note that:
2499
2719
2500
2720
\b The SSH-1 protocol contains no mechanism for asking the server to
2501
2721
stop listening on a remote port.
2594
2814
An ignore message (SSH_MSG_IGNORE) is a message in the SSH protocol
2595
2815
which can be sent from the client to the server, or from the server
2596
2816
to the client, at any time. Either side is required to ignore the
2597
message whenever it receives it. PuTTY uses ignore messages to hide
2598
the password packet in SSH-1, so that a listener cannot tell the
2599
length of the user's password; it also uses ignore messages for
2600
connection keepalives (see \k{config-keepalive}).
2817
message whenever it receives it. PuTTY uses ignore messages to
2818
\I{password camouflage}hide the password packet in SSH-1, so that
2819
a listener cannot tell the length of the user's password; it also
2820
uses ignore messages for connection \i{keepalives} (see
2821
\k{config-keepalive}).
2601
2822
2602
2823
If this bug is detected, PuTTY will stop using ignore messages. This
2603
2824
means that keepalives will stop working, and PuTTY will have to fall
2624
2845
password packet is not really a bug, but it does make life
2625
2846
inconvenient if the server can also not handle ignore messages.
2626
2847
2627
If this \q{bug} is detected, PuTTY will have no choice but to send
2628
the user's password with no form of camouflage, so that an
2629
eavesdropping user will be easily able to find out the exact length
2848
If this \q{bug} is detected, PuTTY will assume that neither ignore
2849
messages nor padding are acceptable, and that it thus has no choice
2850
but to send the user's password with no form of camouflage, so that
2851
an eavesdropping user will be easily able to find out the exact length
2630
2852
of the password. If this bug is enabled when talking to a correct
2631
2853
server, the session will succeed, but will be more vulnerable to
2632
2854
eavesdroppers than it could be.
2689
2911
2690
2912
Versions below 3.3 of \i{OpenSSH} require SSH-2 RSA signatures to be
2691
2913
padded with zero bytes to the same length as the RSA key modulus.
2692
The SSH-2 draft specification says that an unpadded signature MUST be
2914
The SSH-2 specification says that an unpadded signature MUST be
2693
2915
accepted, so this is a bug. A typical symptom of this problem is
2694
2916
that PuTTY mysteriously fails RSA authentication once in every few
2695
2917
hundred attempts, and falls back to passwords.
2740
2962
2741
2963
This is an SSH-2-specific bug.
2742
2964
2965
\H{config-serial} The Serial panel
2966
2967
The \i{Serial} panel allows you to configure options that only apply
2968
when PuTTY is connecting to a local \I{serial port}\i{serial line}.
2969
2970
\S{config-serial-line} Selecting a serial line to connect to
2971
2972
\cfg{winhelp-topic}{serial.line}
2973
2974
The \q{Serial line to connect to} box allows you to choose which
2975
serial line you want PuTTY to talk to, if your computer has more
2976
than one serial port.
2977
2978
On Windows, the first serial line is called \i\cw{COM1}, and if there
2979
is a second it is called \cw{COM2}, and so on.
2980
2981
This configuration setting is also visible on the Session panel,
2982
where it replaces the \q{Host Name} box (see \k{config-hostname}) if
2983
the connection type is set to \q{Serial}.
2984
2985
\S{config-serial-speed} Selecting the speed of your serial line
2986
2987
\cfg{winhelp-topic}{serial.speed}
2988
2989
The \q{Speed} box allows you to choose the speed (or \q{baud rate})
2990
at which to talk to the serial line. Typical values might be 9600,
2991
19200, 38400 or 57600. Which one you need will depend on the device
2992
at the other end of the serial cable; consult the manual for that
2993
device if you are in doubt.
2994
2995
This configuration setting is also visible on the Session panel,
2996
where it replaces the \q{Port} box (see \k{config-hostname}) if the
2997
connection type is set to \q{Serial}.
2998
2999
\S{config-serial-databits} Selecting the number of data bits
3000
3001
\cfg{winhelp-topic}{serial.databits}
3002
3003
The \q{Data bits} box allows you to choose how many data bits are
3004
transmitted in each byte sent or received through the serial line.
3005
Typical values are 7 or 8.
3006
3007
\S{config-serial-stopbits} Selecting the number of stop bits
3008
3009
\cfg{winhelp-topic}{serial.stopbits}
3010
3011
The \q{Stop bits} box allows you to choose how many stop bits are
3012
used in the serial line protocol. Typical values are 1, 1.5 or 2.
3013
3014
\S{config-serial-parity} Selecting the serial parity checking scheme
3015
3016
\cfg{winhelp-topic}{serial.parity}
3017
3018
The \q{Parity} box allows you to choose what type of parity checking
3019
is used on the serial line. The settings are:
3020
3021
\b \q{None}: no parity bit is sent at all.
3022
3023
\b \q{Odd}: an extra parity bit is sent alongside each byte, and
3024
arranged so that the total number of 1 bits is odd.
3025
3026
\b \q{Even}: an extra parity bit is sent alongside each byte, and
3027
arranged so that the total number of 1 bits is even.
3028
3029
\b \q{Mark}: an extra parity bit is sent alongside each byte, and
3030
always set to 1.
3031
3032
\b \q{Space}: an extra parity bit is sent alongside each byte, and
3033
always set to 0.
3034
3035
\S{config-serial-flow} Selecting the serial flow control scheme
3036
3037
\cfg{winhelp-topic}{serial.flow}
3038
3039
The \q{Flow control} box allows you to choose what type of flow
3040
control checking is used on the serial line. The settings are:
3041
3042
\b \q{None}: no flow control is done. Data may be lost if either
3043
side attempts to send faster than the serial line permits.
3044
3045
\b \q{XON/XOFF}: flow control is done by sending XON and XOFF
3046
characters within the data stream.
3047
3048
\b \q{RTS/CTS}: flow control is done using the RTS and CTS wires on
3049
the serial line.
3050
3051
\b \q{DSR/DTR}: flow control is done using the DSR and DTR wires on
3052
the serial line.
3053
2743
3054
\H{config-file} \ii{Storing configuration in a file}
2744
3055
2745
3056
PuTTY does not currently support storing its configuration in a file
Loggerhead is a web-based interface for Breezy
Version: 2.0.1