Bleh, grammar.

[PuTTY.git] / doc / config.but

diff --git a/doc/config.but b/doc/config.but
index 503f966353691d1dbb84e832442615cb745f7672..063d2a13412b887177ac4d8b82be3a42c20ee20d 100644 (file)
--- a/doc/config.but
+++ b/doc/config.but
@@ -1,4 +1,4 @@
-\versionid $Id: config.but,v 1.78 2004/05/22 10:36:50 simon Exp $
+\versionid $Id: config.but,v 1.88 2004/09/01 10:19:22 jacob Exp $

 
 \C{config} Configuring PuTTY
 
 
 \C{config} Configuring PuTTY
 


@@ -638,6 +638,8 @@ use the Sound configurer in the Windows Control Panel.
 this mode, when the server sends a Control-G, the whole PuTTY window
 will flash white for a fraction of a second.
 
 this mode, when the server sends a Control-G, the whole PuTTY window
 will flash white for a fraction of a second.
 

+\b \q{Beep using the PC speaker} is self-explanatory.
+

 \b \q{Play a custom sound file} allows you to specify a particular
 sound file to be used by PuTTY alone, or even by a particular
 individual PuTTY session. This allows you to distinguish your PuTTY
 \b \q{Play a custom sound file} allows you to specify a particular
 sound file to be used by PuTTY alone, or even by a particular
 individual PuTTY session. This allows you to distinguish your PuTTY


@@ -840,7 +842,7 @@ Arabic text shaping so that PuTTY displays precisely the characters
 it is told to display.
 
 You may also find you need to disable bidirectional text display;
 it is told to display.
 
 You may also find you need to disable bidirectional text display;

-see \S{config-features-bidi}.
+see \k{config-features-bidi}.

 
 \S{config-features-bidi} Disabling bidirectional text display
 
 
 \S{config-features-bidi} Disabling bidirectional text display
 


@@ -861,7 +863,7 @@ bidirectional text display, so that PuTTY displays text from left to
 right in all situations.
 
 You may also find you need to disable Arabic text shaping;
 right in all situations.
 
 You may also find you need to disable Arabic text shaping;

-see \S{config-features-arabicshaping}.
+see \k{config-features-shaping}.

 
 \H{config-window} The Window panel
 
 
 \H{config-window} The Window panel
 


@@ -914,8 +916,9 @@ scrolls off the top of the screen (see \k{using-scrollback}).
 The \q{Lines of scrollback} box lets you configure how many lines of
 text PuTTY keeps. The \q{Display scrollbar} options allow you to
 hide the scrollbar (although you can still view the scrollback using
 The \q{Lines of scrollback} box lets you configure how many lines of
 text PuTTY keeps. The \q{Display scrollbar} options allow you to
 hide the scrollbar (although you can still view the scrollback using

-Shift-PgUp and Shift-PgDn). You can separately configure whether the
-scrollbar is shown in full-screen mode and in normal modes.
+the keyboard as described in \k{using-scrollback}). You can separately
+configure whether the scrollbar is shown in full-screen mode and in
+normal modes.

 
 If you are viewing part of the scrollback when the server sends more
 text to PuTTY, the screen will revert to showing the current
 
 If you are viewing part of the scrollback when the server sends more
 text to PuTTY, the screen will revert to showing the current


@@ -1012,7 +1015,11 @@ followed by \q{PuTTY}, for example \c{server1.example.com - PuTTY}.
 If you want a different window title, this is where to set it.
 
 PuTTY allows the server to send \c{xterm} control sequences which
 If you want a different window title, this is where to set it.
 
 PuTTY allows the server to send \c{xterm} control sequences which

-modify the title of the window in mid-session. There is also an
+modify the title of the window in mid-session (unless this is disabled -
+see \k{config-features-retitle}); the title string set here
+is therefore only the \e{initial} window title.
+
+As well as the \e{window} title, there is also an

 \c{xterm} sequence to modify the title of the window's \e{icon}.
 This makes sense in a windowing system where the window becomes an
 icon when minimised, such as Windows 3.1 or most X Window System
 \c{xterm} sequence to modify the title of the window's \e{icon}.
 This makes sense in a windowing system where the window becomes an
 icon when minimised, such as Windows 3.1 or most X Window System


@@ -1440,8 +1447,9 @@ badly to the default value.
 
 The format is a pair of numbers separated by a comma, for instance,
 \c{38400,38400}. The first number represents the output speed
 
 The format is a pair of numbers separated by a comma, for instance,
 \c{38400,38400}. The first number represents the output speed

-(\e{from} the server), and the second is the input speed (\e{to} the
-server). (Only the first is used in the Rlogin protocol.)
+(\e{from} the server) in bits per second, and the second is the input
+speed (\e{to} the server). (Only the first is used in the Rlogin
+protocol.)

 
 This option has no effect on Raw connections.
 
 
 This option has no effect on Raw connections.
 


@@ -1499,7 +1507,8 @@ what \e{kind} of network problems you have between you and the
 server.
 
 Keepalives are only supported in Telnet and SSH; the Rlogin and Raw
 server.
 
 Keepalives are only supported in Telnet and SSH; the Rlogin and Raw

-protocols offer no way of implementing them.
+protocols offer no way of implementing them. (For an alternative, see
+\k{config-tcp-keepalives}.)

 
 Note that if you are using SSH1 and the server has a bug that makes
 it unable to deal with SSH1 ignore messages (see
 
 Note that if you are using SSH1 and the server has a bug that makes
 it unable to deal with SSH1 ignore messages (see


@@ -1518,6 +1527,34 @@ types of server.
 
 The Nagle algorithm is disabled by default.
 
 
 The Nagle algorithm is disabled by default.
 

+\S{config-tcp-keepalives} \q{Enable TCP keepalives}
+
+\cfg{winhelp-topic}{connection.tcpkeepalive}
+
+\e{NOTE:} TCP keepalives should not be confused with the
+application-level keepalives described in \k{config-keepalive}. If in
+doubt, you probably want application-level keepalives; TCP keepalives
+are provided for completeness.
+
+The idea of TCP keepalives is similar to application-level keepalives,
+and the same caveats apply. The main differences are:
+
+\b TCP keepalives are available on \e{all} connection types, including
+Raw and Rlogin.
+
+\b The interval between TCP keepalives is usually much longer,
+typically two hours; this is set by the operating system, and cannot
+be configured within PuTTY.
+
+\b If the operating system does not receive a response to a keepalive,
+it may send out more in quick succession and if terminate the connection
+if no response is received.
+
+TCP keepalives may be more useful for ensuring that half-open connections
+are terminated than for keeping a connection alive.
+
+TCP keepalives are disabled by default.
+

 \H{config-proxy} The Proxy panel
 
 \cfg{winhelp-topic}{proxy.main}
 \H{config-proxy} The Proxy panel
 
 \cfg{winhelp-topic}{proxy.main}


@@ -1638,6 +1675,18 @@ Authentication is not fully supported for all forms of proxy:
 \b Username and password authentication is supported for HTTP
 proxies and SOCKS 5 proxies.
 
 \b Username and password authentication is supported for HTTP
 proxies and SOCKS 5 proxies.
 

+\lcont{
+
+\b With SOCKS 5, authentication is via \i{CHAP} if the proxy
+supports it (this is not supported in \i{PuTTYtel}); otherwise the
+password is sent to the proxy in plain text.
+
+\b With HTTP proxying, the only currently supported authentication
+method is \q{basic}, where the password is sent to the proxy in plain
+text.
+
+}
+

 \b SOCKS 4 can use the \q{Username} field, but does not support
 passwords.
 
 \b SOCKS 4 can use the \q{Username} field, but does not support
 passwords.
 


@@ -2321,9 +2370,9 @@ line options, so it's all automatic. Here is what you need in
 \c regedit /s putty.reg
 \c regedit /s puttyrnd.reg
 \c start /w putty.exe
 \c regedit /s putty.reg
 \c regedit /s puttyrnd.reg
 \c start /w putty.exe

-\c regedit /ea puttynew.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
-\c copy puttynew.reg putty.reg
-\c del puttynew.reg
+\c regedit /ea new.reg HKEY_CURRENT_USER\Software\SimonTatham\PuTTY
+\c copy new.reg putty.reg
+\c del new.reg

 \c regedit /s puttydel.reg
 
 This batch file needs two auxiliary files: \c{PUTTYRND.REG} which
 \c regedit /s puttydel.reg
 
 This batch file needs two auxiliary files: \c{PUTTYRND.REG} which