Steven Shockley points out that the .PPK extension is far from obvious to

users. Update the file selection dialogs to mention it per the usual Windows
convention, and also sprinkle references to it throughout the docs. I've
also scattered hints that most tools need PuTTY's native format; perhaps this
will reduce the frequency with which FAQ A.1.2 trips people up.

git-svn-id: svn://svn.tartarus.org/sgt/putty@2625 cda61777-01e9-0310-a592-d414129be87e

diff --git a/doc/config.but b/doc/config.but
index a5efcc3..b45399a 100644 (file)
--- a/doc/config.but
+++ b/doc/config.but
@@ -1,4 +1,4 @@
-\versionid $Id: config.but,v 1.49 2003/01/12 14:30:02 simon Exp $
+\versionid $Id: config.but,v 1.50 2003/01/16 15:43:18 jacob Exp $
 
 \C{config} Configuring PuTTY
 
@@ -1870,6 +1870,8 @@ This box is where you enter the name of your private key file if you
 are using public key authentication. See \k{pubkey} for information
 about public key authentication in SSH.
 
+This key must be in PuTTY's native format (\c{*.PPK}).
+
 \H{config-ssh-tunnels} The Tunnels panel
 
 The Tunnels panel allows you to configure tunnelling of other

diff --git a/doc/pageant.but b/doc/pageant.but
index c1f2a82..f2109ac 100644 (file)
--- a/doc/pageant.but
+++ b/doc/pageant.but
@@ -1,4 +1,4 @@
-\versionid $Id: pageant.but,v 1.8 2002/09/11 17:30:36 jacob Exp $
+\versionid $Id: pageant.but,v 1.9 2003/01/16 15:43:18 jacob Exp $
 
 \C{pageant} Using Pageant for authentication
 
@@ -10,8 +10,8 @@ needing to type a passphrase.
 
 \H{pageant-start} Getting started with Pageant
 
-Before you run Pageant, you need to have a private key. See
-\k{pubkey} to find out how to generate and use one.
+Before you run Pageant, you need to have a private key in \c{*.PPK}
+format. See \k{pubkey} to find out how to generate and use one.
 
 When you run Pageant, it will put an icon of a computer wearing a
 hat into the System tray. It will then sit and do nothing, until you
@@ -129,7 +129,7 @@ Pageant can automatically load one or more private keys when it
 starts up, if you provide them on the Pageant command line. Your
 command line might then look like:
 
-\c C:\PuTTY\pageant.exe d:\main.key d:\secondary.key
+\c C:\PuTTY\pageant.exe d:\main.ppk d:\secondary.ppk
 
 If the keys are stored encrypted, Pageant will request the
 passphrases on startup.
@@ -145,7 +145,7 @@ loaded.
 You do this by specifying the \c{-c} option followed by the command,
 like this:
 
-\c C:\PuTTY\pageant.exe d:\main.key -c C:\PuTTY\putty.exe
+\c C:\PuTTY\pageant.exe d:\main.ppk -c C:\PuTTY\putty.exe
 
 \H{pageant-forward} Using agent forwarding
 

diff --git a/doc/pubkey.but b/doc/pubkey.but
index 8a5ed1f..d7e3234 100644 (file)
--- a/doc/pubkey.but
+++ b/doc/pubkey.but
@@ -1,4 +1,4 @@
-\versionid $Id: pubkey.but,v 1.20 2002/12/27 16:54:14 simon Exp $
+\versionid $Id: pubkey.but,v 1.21 2003/01/16 15:43:18 jacob Exp $
 
 \C{pubkey} Using public keys for SSH authentication
 
@@ -280,9 +280,10 @@ Press the \q{Save private key} button. PuTTYgen will put up a dialog
 box asking you where to save the file. Select a directory, type in a
 file name, and press \q{Save}.
 
-This file is the one you will need to tell PuTTY to use for
-authentication (see \k{config-ssh-privkey}) or tell Pageant to load
-(see \k{pageant-mainwin-addkey}).
+This file is in PuTTY's native format (\c{*.PPK}); it is the one you
+will need to tell PuTTY to use for authentication (see
+\k{config-ssh-privkey}) or tell Pageant to load (see
+\k{pageant-mainwin-addkey}).
 
 \S{puttygen-savepub} Saving your public key to a disk file
 
@@ -364,12 +365,12 @@ another.
 Using the \q{Import} command from the \q{Conversions} menu, PuTTYgen
 can load SSH2 private keys in OpenSSH's format and \cw{ssh.com}'s
 format. Once you have loaded one of these key types, you can then
-save it back out as a PuTTY-format key so that you can use it with
-PuTTY. The passphrase will be unchanged by this process (unless you
-deliberately change it). You may want to change the key comment
-before you save the key, since OpenSSH's SSH2 key format contains no
-space for a comment and \cw{ssh.com}'s default comment format is
-long and verbose.
+save it back out as a PuTTY-format key (\c{*.PPK}) so that you can use
+it with the PuTTY suite. The passphrase will be unchanged by this
+process (unless you deliberately change it). You may want to change
+the key comment before you save the key, since OpenSSH's SSH2 key
+format contains no space for a comment and \cw{ssh.com}'s default
+comment format is long and verbose.
 
 PuTTYgen can also export private keys in OpenSSH format and in
 \cw{ssh.com} format. To do so, select one of the \q{Export} options

diff --git a/doc/using.but b/doc/using.but
index 40363d0..43fb344 100644 (file)
--- a/doc/using.but
+++ b/doc/using.but
@@ -1,4 +1,4 @@
-\versionid $Id: using.but,v 1.10 2003/01/02 14:23:36 ben Exp $
+\versionid $Id: using.but,v 1.11 2003/01/16 15:43:18 jacob Exp $
 
 \C{using} Using PuTTY
 
@@ -578,8 +578,8 @@ PuTTY configuration box (see \k{config-ssh-prot}).
 \S2{using-cmdline-identity} \c{-i}: specify an SSH private key
 
 The \c{-i} option allows you to specify the name of a private key
-file which PuTTY will use to authenticate with the server. This
-option is only meaningful if you are using SSH.
+file in \c{*.PPK} format which PuTTY will use to authenticate with the
+server. This option is only meaningful if you are using SSH.
 
 For general information on public-key authentication, see \k{pubkey}.
 

diff --git a/pageant.c b/pageant.c
index 0ffb24c..0826bf4 100644 (file)
--- a/pageant.c
+++ b/pageant.c
@@ -1250,7 +1250,8 @@ static void prompt_add_keyfile(void)
     of.lStructSize = sizeof(of);
 #endif
     of.hwndOwner = main_hwnd;
-    of.lpstrFilter = "PuTTY Private Key Files\0*.PPK\0AllFiles\0*\0\0\0";
+    of.lpstrFilter = "PuTTY Private Key Files (*.ppk)\0*.PPK\0"
+       "AllFiles\0*\0\0\0";
     of.lpstrCustomFilter = NULL;
     of.nFilterIndex = 1;
     of.lpstrFile = filelist;

diff --git a/puttygen.c b/puttygen.c
index add9431..7bfd1e6 100644 (file)
--- a/puttygen.c
+++ b/puttygen.c
@@ -202,7 +202,8 @@ static int prompt_keyfile(HWND hwnd, char *dlgtitle,
 #endif
     of.hwndOwner = hwnd;
     if (ppk) {
-       of.lpstrFilter = "PuTTY Private Key Files\0*.PPK\0All Files\0*\0\0\0";
+       of.lpstrFilter = "PuTTY Private Key Files (*.ppk)\0*.PPK\0"
+           "All Files\0*\0\0\0";
        of.lpstrDefExt = ".ppk";
     } else {
        of.lpstrFilter = "All Files\0*\0\0\0";

diff --git a/windlg.c b/windlg.c
index 4924a74..6d035ce 100644 (file)
--- a/windlg.c
+++ b/windlg.c
@@ -3333,7 +3333,7 @@ static int GenericMainDlgProc(HWND hwnd, UINT msg,
                of.lStructSize = sizeof(of);
 #endif
                of.hwndOwner = hwnd;
-               of.lpstrFilter = "PuTTY Private Key Files\0*.PPK\0"
+               of.lpstrFilter = "PuTTY Private Key Files (*.ppk)\0*.PPK\0"
                    "AllFiles\0*\0\0\0";
                of.lpstrCustomFilter = NULL;
                of.nFilterIndex = 1;