From 892c827e72b1396e3b58e2f8869cc48328a2b59c Mon Sep 17 00:00:00 2001
From: Justus Winter <justus@g10code.com>
Date: Mon, 14 Nov 2016 16:59:23 +0100
Subject: g10,sm: Spell out --gen-key.

* g10/gpg.c (opts): Spell out option.
* sm/gpgsm.c (opts): Likewise.
* doc/gpg.texi: Update accordingly.

GnuPG-bug-id: 2700
Signed-off-by: Justus Winter <justus@g10code.com>
---
 doc/debugging.texi                  |  3 ++-
 doc/faq.org                         |  2 +-
 doc/gpg.texi                        | 14 +++++++-------
 doc/gpgsm.texi                      |  6 +++---
 doc/howto-create-a-server-cert.texi |  2 +-
 5 files changed, 14 insertions(+), 13 deletions(-)

(limited to 'doc')

diff --git a/doc/debugging.texi b/doc/debugging.texi
index 7fde49a4c..42a1a159e 100644
--- a/doc/debugging.texi
+++ b/doc/debugging.texi
@@ -235,7 +235,8 @@ gpg: fatal: WriteConsole failed: Access denied
 @noindent
 The solution is to use the command @command{wineconsole}.
 
-Some operations like gen-key really want to talk to the console directly
+Some operations like @option{--generate-key} really want to talk to
+the console directly
 for increased security (for example to prevent the passphrase from
 appearing on the screen).  So, you should use @command{wineconsole}
 instead of @command{wine}, which will launch a windows console that
diff --git a/doc/faq.org b/doc/faq.org
index 22d07f073..8fc3775bb 100644
--- a/doc/faq.org
+++ b/doc/faq.org
@@ -1243,7 +1243,7 @@ update this FAQ in the next month.  See the section "Changes" for recent updates
 
     To generate a secret/public keypair, run:
 
-    : $ gpg --gen-key
+    : $ gpg --generate-key
 
     and choose the default values.
 
diff --git a/doc/gpg.texi b/doc/gpg.texi
index 015b93080..3f7375472 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -611,7 +611,7 @@ This section explains the main commands for key management.
 @item --quick-gen-key @code{user-id} [@code{algo} [@code{usage} [@code{expire}]]]
 @opindex quick-gen-key
 This is a simple command to generate a standard key with one user id.
-In contrast to @option{--gen-key} the key is generated directly
+In contrast to @option{--generate-key} the key is generated directly
 without the need to answer a bunch of prompts.  Unless the option
 @option{--yes} is given, the key creation will be canceled if the
 given user id already exists in the keyring.
@@ -681,8 +681,8 @@ for the subkey.  Several formats are supported; commonly the ISO
 YYYY-MM-DD format is used.  The values ``never'', ``none'', or ``-''
 can be used for no expiration date.
 
-@item --gen-key
-@opindex gen-key
+@item --generate-key
+@opindex generate-key
 Generate a new key pair using the current default parameters.  This is
 the standard command to create a new key.  In addition to the key a
 revocation certificate is created and stored in the
@@ -691,7 +691,7 @@ revocation certificate is created and stored in the
 @item --full-gen-key
 @opindex gen-key
 Generate a new key pair with dialogs for all options.  This is an
-extended version of @option{--gen-key}.
+extended version of @option{--generate-key}.
 
 There is also a feature which allows you to create keys in batch
 mode. See the manual section ``Unattended key generation'' on how
@@ -1342,7 +1342,7 @@ the opposite meaning. The options are:
 @itemx --disable-large-rsa
 @opindex enable-large-rsa
 @opindex disable-large-rsa
-With --gen-key and --batch, enable the creation of RSA secret keys as
+With --generate-key and --batch, enable the creation of RSA secret keys as
 large as 8192 bit.  Note: 8192 bit is more than is generally
 recommended.  These large keys don't significantly improve security,
 but they are more expensive to use, and their signatures and
@@ -3729,7 +3729,7 @@ are almost always required for this.
 @node Unattended GPG key generation
 @subsection Unattended key generation
 
-The command @option{--gen-key} may be used along with the option
+The command @option{--generate-key} may be used along with the option
 @option{--batch} for unattended key generation.  The parameters are
 either read from stdin or given as a file on the command line.
 The format of the parameter file is as follows:
@@ -3921,7 +3921,7 @@ $ cat >foo <<EOF
      %commit
      %echo done
 EOF
-$ @gpgname --batch --gen-key foo
+$ @gpgname --batch --generate-key foo
  [...]
 $ @gpgname --no-default-keyring --secret-keyring ./foo.sec \
        --keyring ./foo.pub --list-secret-keys
diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi
index e3e852c2a..2e53a5674 100644
--- a/doc/gpgsm.texi
+++ b/doc/gpgsm.texi
@@ -165,8 +165,8 @@ use @samp{--help} to get a list of supported operations.
 @subsection How to manage the certificates and keys
 
 @table @gnupgtabopt
-@item --gen-key
-@opindex gen-key
+@item --generate-key
+@opindex generate-key
 This command allows the creation of a certificate signing request or a
 self-signed certificate.  It is commonly used along with the
 @option{--output} option to save the created CSR or certificate into a
@@ -1005,7 +1005,7 @@ this is a missing certificate.
 @node CSR and certificate creation
 @subsection CSR and certificate creation
 
-The command @option{--gen-key} may be used along with the option
+The command @option{--generate-key} may be used along with the option
 @option{--batch} to either create a certificate signing request (CSR)
 or an X.509 certificate.  This is controlled by a parameter file; the
 format of this file is as follows:
diff --git a/doc/howto-create-a-server-cert.texi b/doc/howto-create-a-server-cert.texi
index ea0ce7196..55f1a91a4 100644
--- a/doc/howto-create-a-server-cert.texi
+++ b/doc/howto-create-a-server-cert.texi
@@ -12,7 +12,7 @@ is no need for a configuration file, you may simply enter:
 
 @cartouche
 @example
-  $ gpgsm --gen-key >example.com.cert-req.pem
+  $ gpgsm --generate-key >example.com.cert-req.pem
   Please select what kind of key you want:
      (1) RSA
      (2) Existing key
-- 
cgit v1.2.3