Remove a return path from sshcom_write() which was both unreachable

[u/mdw/putty] / doc / man-pg.but

diff --git a/doc/man-pg.but b/doc/man-pg.but
index 4dbc022..86136de 100644 (file)
--- a/doc/man-pg.but
+++ b/doc/man-pg.but
@@ -10,8 +10,8 @@
 
 \c puttygen ( keyfile | -t keytype [ -b bits ] )
 \e bbbbbbbb   iiiiiii   bb iiiiiii   bb iiii
-\c          [ -C new-comment ] [ -P ]
-\e            bb iiiiiiiiiii     bb
+\c          [ -C new-comment ] [ -P ] [ -q ]
+\e            bb iiiiiiiiiii     bb     bb
 \c          [ -O output-type | -l | -L | -p ]
 \e            bb iiiiiiiiiii   bb   bb   bb
 \c          [ -o output-file ]
@@ -37,25 +37,33 @@ the following section.
 \S{puttygen-manpage-options} OPTIONS
 
 In the first phase, \c{puttygen} either loads or generates a key.
-The options to control this are:
+Note that generating a key requires random data (from
+\c{/dev/random}), which can cause \c{puttygen} to pause, possibly for
+some time if your system does not have much randomness available.
+
+The options to control this phase are:
 
 \dt \e{keyfile}
 
 \dd Specify a private key file to be loaded. This private key file can
-be in the (de facto standard) SSH1 key format, or in PuTTY's SSH2
-key format, or in either of the SSH2 private key formats used by
+be in the (de facto standard) SSH-1 key format, or in PuTTY's SSH-2
+key format, or in either of the SSH-2 private key formats used by
 OpenSSH and ssh.com's implementation.
 
 \dt \cw{\-t} \e{keytype}
 
 \dd Specify a type of key to generate. The acceptable values here are
-\c{rsa} and \c{dsa} (to generate SSH2 keys), and \c{rsa1} (to
-generate SSH1 keys).
+\c{rsa} and \c{dsa} (to generate SSH-2 keys), and \c{rsa1} (to
+generate SSH-1 keys).
 
 \dt \cw{\-b} \e{bits}
 
 \dd Specify the size of the key to generate, in bits. Default is 1024.
 
+\dt \cw{\-q}
+
+\dd Suppress the progress display when generating a new key.
+
 In the second phase, \c{puttygen} optionally alters properties of
 the key it has loaded or generated. The options to control this are:
 
@@ -85,21 +93,21 @@ Acceptable options are:
 \dt \cw{private}
 
 \dd Save the private key in a format usable by PuTTY. This will either
-be the standard SSH1 key format, or PuTTY's own SSH2 key format.
+be the standard SSH-1 key format, or PuTTY's own SSH-2 key format.
 
 \dt \cw{public}
 
-\dd Save the public key only. For SSH1 keys, the standard public key
-format will be used (\q{\cw{1024 37 5698745}...}). For SSH2 keys, the
-public key will be output in the format specified in the IETF
-drafts, which is a multi-line text file beginning with the line
+\dd Save the public key only. For SSH-1 keys, the standard public key
+format will be used (\q{\cw{1024 37 5698745}...}). For SSH-2 keys, the
+public key will be output in the format specified by RFC 4716,
+which is a multi-line text file beginning with the line
 \q{\cw{---- BEGIN SSH2 PUBLIC KEY ----}}.
 
 \dt \cw{public-openssh}
 
-\dd Save the public key only, in a format usable by OpenSSH. For SSH1
+\dd Save the public key only, in a format usable by OpenSSH. For SSH-1
 keys, this output format behaves identically to \c{public}. For
-SSH2 keys, the public key will be output in the OpenSSH format,
+SSH-2 keys, the public key will be output in the OpenSSH format,
 which is a single line (\q{\cw{ssh-rsa AAAAB3NzaC1yc2}...}).
 
 \dt \cw{fingerprint}
@@ -109,13 +117,13 @@ algorithms are believed compatible with OpenSSH.
 
 \dt \cw{private-openssh}
 
-\dd Save an SSH2 private key in OpenSSH's format. This option is not
-permitted for SSH1 keys.
+\dd Save an SSH-2 private key in OpenSSH's format. This option is not
+permitted for SSH-1 keys.
 
 \dt \cw{private-sshcom}
 
-\dd Save an SSH2 private key in ssh.com's format. This option is not
-permitted for SSH1 keys.
+\dd Save an SSH-2 private key in ssh.com's format. This option is not
+permitted for SSH-1 keys.
 
 If no output type is specified, the default is \c{private}.
 
@@ -142,9 +150,25 @@ fingerprint. Otherwise, the \c{\-o} option is required.
 
 \dd Synonym for \q{\cw{-O public}}.
 
+The following options do not run PuTTYgen as normal, but print
+informational messages and then quit:
+
+\dt \cw{\-h}, \cw{\-\-help}
+
+\dd Display a message summarizing the available options.
+
+\dt \cw{\-V}, \cw{\-\-version}
+
+\dd Display the version of PuTTYgen.
+
+\dt \cw{\-\-pgpfp}
+
+\dd Display the fingerprints of the PuTTY PGP Master Keys, to aid
+in verifying new files released by the PuTTY team.
+
 \S{puttygen-manpage-examples} EXAMPLES
 
-To generate an SSH2 RSA key pair and save it in PuTTY's own format
+To generate an SSH-2 RSA key pair and save it in PuTTY's own format
 (you will be prompted for the passphrase):
 
 \c puttygen -t rsa -C "my home key" -o mykey.ppk