Consistently use a single notation to refer to SSH protocol versions, as
[u/mdw/putty] / doc / errors.but
index 66579ef..c0a6d50 100644 (file)
@@ -1,4 +1,4 @@
-\versionid $Id: errors.but,v 1.10 2004/09/27 00:23:19 jacob Exp $
+\define{versioniderrors} \versionid $Id$
 
 \C{errors} Common error messages
 
@@ -15,6 +15,8 @@ bug (see \k{feedback}) and we will add documentation for it.
 \H{errors-hostkey-absent} \q{The server's host key is not cached in
 the registry}
 
+\cfg{winhelp-topic}{errors.hostkey.absent}
+
 This error message occurs when PuTTY connects to a new SSH server.
 Every server identifies itself by means of a host key; once PuTTY
 knows the host key for a server, it will be able to detect if a
@@ -28,14 +30,16 @@ asking the machine's administrator.
 If you see this message and you know that your installation of PuTTY
 \e{has} connected to the same server before, it may have been
 recently upgraded to SSH protocol version 2. SSH protocols 1 and 2
-use separate host keys, so when you first use SSH 2 with a server
-you have only used SSH 1 with before, you will see this message
+use separate host keys, so when you first use SSH-2 with a server
+you have only used SSH-1 with before, you will see this message
 again. You should verify the correctness of the key as before.
 
 See \k{gs-hostkey} for more information on host keys.
 
 \H{errors-hostkey-wrong} \q{WARNING - POTENTIAL SECURITY BREACH!}
 
+\cfg{winhelp-topic}{errors.hostkey.changed}
+
 This message, followed by \q{The server's host key does not match
 the one PuTTY has cached in the registry}, means that PuTTY has
 connected to the SSH server before, knows what its host key
@@ -69,7 +73,8 @@ this, let us know and we'll move it up our priority list.
 ... below the configured warning threshold}
 
 This occurs when the SSH server does not offer any ciphers which you
-have configured PuTTY to consider strong enough.
+have configured PuTTY to consider strong enough. By default, PuTTY
+puts up this warning only for single-DES encryption.
 
 See \k{config-ssh-encryption} for more information on this message.
 
@@ -95,7 +100,7 @@ PuTTY is not able to recover from running out of memory; it will
 terminate immediately after giving this error.
 
 However, this error can also occur when memory is not running out at
-all, because PuTTY receives data in the wrong format. In SSH 2 and
+all, because PuTTY receives data in the wrong format. In SSH-2 and
 also in SFTP, the server sends the length of each message before the
 message itself; so PuTTY will receive the length, try to allocate
 space for the message, and then receive the rest of the message. If
@@ -103,7 +108,7 @@ the length PuTTY receives is garbage, it will try to allocate a
 ridiculous amount of memory, and will terminate with an \q{Out of
 memory} error.
 
-This can happen in SSH 2, if PuTTY and the server have not enabled
+This can happen in SSH-2, if PuTTY and the server have not enabled
 encryption in the same way (see \k{faq-outofmem} in the FAQ). Some
 versions of OpenSSH have a known problem with this: see
 \k{faq-openssh-bad-openssl}.
@@ -125,9 +130,11 @@ Similarly, any error message starting with \q{Assertion failed} is a
 bug in PuTTY. Please report it to us, and include the exact text
 from the error message box.
 
-\H{errors-key-wrong-format} \q{Unable to use this private key file},
+\H{errors-cant-load-key} \q{Unable to use this private key file},
 \q{Couldn't load private key}, \q{Key is of wrong type}
 
+\cfg{winhelp-topic}{errors.cantloadkey}
+
 Various forms of this error are printed in the PuTTY window, or
 written to the PuTTY Event Log (see \k{using-eventlog}) when trying
 public-key authentication, or given by Pageant when trying to load a
@@ -162,7 +169,9 @@ this user.
 
 This is almost certainly not a problem with PuTTY. If you see this
 type of message, the first thing you should do is check your
-\e{server} configuration carefully. Also, read the PuTTY Event Log;
+\e{server} configuration carefully. Common errors include having
+the wrong permissions or ownership set on the public key or the
+user's home directory on the server. Also, read the PuTTY Event Log;
 the server may have sent diagnostic messages explaining exactly what
 problem it had with your setup.
 
@@ -204,7 +213,7 @@ to tell from this error message whether the problem is in the client,
 in the server, or in between.
 
 If you get this error, one thing you could try would be to fiddle
-with the setting of \q{Miscomputes SSH2 encryption keys} on the Bugs
+with the setting of \q{Miscomputes SSH-2 encryption keys} on the Bugs
 panel (see \k{config-ssh-bug-derivekey2}).
 
 Another known server problem which can cause this error is described
@@ -244,16 +253,19 @@ of \c{su} do it automatically.
 \H{errors-connaborted} \q{Network error: Software caused connection
 abort}
 
-This error occurs when the Windows network code decides that your
-network connection is dead. For example, it will happen if you pull
-the network cable out of the back of an Ethernet-connected computer,
-or if Windows has any other similar reason to believe the entire
-network has become unreachable.
+This is a generic error produced by the Windows network code when it
+kills an established connection for some reason. For example, it might
+happen if you pull the network cable out of the back of an
+Ethernet-connected computer, or if Windows has any other similar
+reason to believe the entire network has become unreachable.
 
 We are not aware of any reason why this error might occur that would
 represent a bug in PuTTY. The problem is between you, your Windows
 system, your network and the remote system.
 
+Some people have reported that enabling keepalives (see
+\k{config-keepalive}) fixes this error for them.
+
 \H{errors-connreset} \q{Network error: Connection reset by peer}
 
 This error occurs when the machines at each end of a network
@@ -267,6 +279,10 @@ connection out. See \k{faq-idleout} in the FAQ for more details. You
 may be able to improve the situation by using keepalives; see
 \k{config-keepalive} for details on this.
 
+Note that Windows can produce this error in some circumstances without
+seeing a connection reset from the server, for instance if the
+connection to the network is lost.
+
 \H{errors-connrefused} \q{Network error: Connection refused}
 
 This error means that the network connection PuTTY tried to make to