\n and \r need double backslashes in Halibut.

[u/mdw/putty] / doc / errors.but

diff --git a/doc/errors.but b/doc/errors.but
index 59338eb..c87c0f6 100644 (file)
--- a/doc/errors.but
+++ b/doc/errors.but
@@ -1,4 +1,4 @@
-\versionid $Id: errors.but,v 1.8 2004/05/20 12:48:19 simon Exp $
+\define{versioniderrors} \versionid $Id$
 
 \C{errors} Common error messages
 
@@ -125,6 +125,28 @@ 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},
+\q{Couldn't load private key}, \q{Key is of wrong type}
+
+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
+private key.
+
+If you see one of these messages, it often indicates that you've tried
+to load a key of an inappropriate type into PuTTY, Plink, PSCP, PSFTP,
+or Pageant.
+
+You may have specified a key that's inappropriate for the connection
+you're making. The SSH-1 and SSH-2 protocols require different private
+key formats, and a SSH-1 key can't be used for a SSH-2 connection (or
+vice versa).
+
+Alternatively, you may have tried to load an SSH-2 key in a \q{foreign}
+format (OpenSSH or \cw{ssh.com}) directly into one of the PuTTY tools,
+in which case you need to import it into PuTTY's native format
+(\c{*.PPK}) using PuTTYgen - see \k{puttygen-conversions}.
+
 \H{errors-refused} \q{Server refused our public key} or \q{Key
 refused}
 
@@ -178,8 +200,8 @@ A known server problem which can cause this error is described in
 This error occurs when PuTTY decrypts an SSH packet and the
 decrypted data makes no sense. This probably means something has
 gone wrong in the encryption or decryption process. It's difficult
-to tell from this error message whether the problem is in the client
-or in the server.
+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
@@ -222,16 +244,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
+decides that your network connection is dead. 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