doc: Clarify constraints on who modifies files in ~/.gnupg
[gnupg.git] / doc / gpg.texi
index 8ec7556..c0632b3 100644 (file)
@@ -1,41 +1,16 @@
 @c Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
-@c               2008, 2009 Free Software Foundation, Inc.
+@c               2008, 2009, 2010 Free Software Foundation, Inc.
 @c This is part of the GnuPG manual.
 @c For copying conditions, see the file gnupg.texi.
 
+@include defs.inc
+
 @node Invoking GPG
 @chapter Invoking GPG
 @cindex GPG command options
 @cindex command options
 @cindex options, GPG command
 
-@c Begin GnuPG 1.x specific stuff
-@ifset gpgone
-@macro gpgname
-gpg
-@end macro
-@manpage gpg.1
-@ifset manverb
-.B gpg
-\- OpenPGP encryption and signing tool
-@end ifset
-
-@mansect synopsis
-@ifset manverb
-.B  gpg
-.RB [ \-\-homedir
-.IR dir ]
-.RB [ \-\-options
-.IR file ]
-.RI [ options ]  
-.I command
-.RI [ args ]
-@end ifset
-@end ifset
-@c End GnuPG 1.x specific stuff
-
-@c Begin GnuPG 2 specific stuff
-@ifclear gpgone
 @macro gpgname
 gpg2
 @end macro
@@ -52,12 +27,11 @@ gpg2
 .IR dir ]
 .RB [ \-\-options
 .IR file ]
-.RI [ options ]  
+.RI [ options ]
 .I command
 .RI [ args ]
 @end ifset
-@end ifclear
-@c Begin GnuPG 2 specific stuff
+
 
 @mansect description
 @command{@gpgname} is the OpenPGP part of the GNU Privacy Guard (GnuPG). It
@@ -66,42 +40,32 @@ OpenPGP standard. @command{@gpgname} features complete key management and
 all bells and whistles you can expect from a decent OpenPGP
 implementation.
 
-@ifset gpgone
-This is the standalone version of @command{gpg}.  For desktop use you
-should consider using @command{gpg2}.
-@end ifset
-
-@ifclear gpgone
-In contrast to the standalone version @command{gpg}, which is more
-suited for server and embedded platforms, this version is installed
-under the name @command{gpg2} and more targeted to the desktop as it
-requires several other modules to be installed.  The standalone version
-will be kept maintained and it is possible to install both versions on
-the same system.  If you need to use different configuration files, you
-should make use of something like @file{gpg.conf-2} instead of just
-@file{gpg.conf}.
-@end ifclear
+In contrast to the standalone command gpg from GnuPG 1.x, which is
+might be better suited for server and embedded platforms, the 2.x
+version is commonly installed under the name @command{gpg2} and
+targeted to the desktop as it requires several other modules to be
+installed.
 
 @manpause
-@ifclear gpgone
-Documentation for the old standard @command{gpg} is available as a man
-page and at @inforef{Top,GnuPG 1,gpg}.
-@end ifclear
+The old 1.x version will be kept maintained and it is possible to
+install both versions on the same system.  Documentation for the old
+GnuPG 1.x command is available as a man page and at
+@inforef{Top,GnuPG 1,gpg}.
 
 @xref{Option Index}, for an index to @command{@gpgname}'s commands and options.
 @mancont
 
 @menu
-* GPG Commands::        List of all commands.
-* GPG Options::         List of all options.
-* GPG Configuration::   Configuration files.
-* GPG Examples::        Some usage examples.
+* GPG Commands::            List of all commands.
+* GPG Options::             List of all options.
+* GPG Configuration::       Configuration files.
+* GPG Examples::            Some usage examples.
 
 Developer information:
-@c * Unattended Usage::      Using @command{gpg} from other programs.
-@c * GPG Protocol::        The protocol the server mode uses.
+* Unattended Usage of GPG:: Using @command{gpg} from other programs.
 @end menu
 
+@c * GPG Protocol::        The protocol the server mode uses.
 
 
 @c *******************************************
@@ -211,7 +175,7 @@ decrypted via a secret key or a passphrase).
 @itemx -c
 @opindex symmetric
 Encrypt with a symmetric cipher using a passphrase. The default
-symmetric cipher used is CAST5, but may be chosen with the
+symmetric cipher used is @value{GPGSYMENCALGO}, but may be chosen with the
 @option{--cipher-algo} option. This option may be combined with
 @option{--sign} (for a signed and symmetrically encrypted message),
 @option{--encrypt} (for a message that may be decrypted via a secret key
@@ -235,16 +199,30 @@ files which don't begin with an encrypted message.
 
 @item --verify
 @opindex verify
-Assume that the first argument is a signed file or a detached signature
-and verify it without generating any output. With no arguments, the
-signature packet is read from STDIN. If only a sigfile is given, it may
-be a complete signature or a detached signature, in which case the
-signed stuff is expected in a file without the ".sig" or ".asc"
-extension.  With more than 1 argument, the first should be a detached
-signature and the remaining files are the signed stuff. To read the
-signed stuff from STDIN, use @samp{-} as the second filename.  For
-security reasons a detached signature cannot read the signed material
-from STDIN without denoting it in the above way.
+Assume that the first argument is a signed file and verify it without
+generating any output.  With no arguments, the signature packet is
+read from STDIN.  If only a one argument is given, it is expected to
+be a complete signature.
+
+With more than 1 argument, the first should be a detached signature
+and the remaining files ake up the the signed data. To read the signed
+data from STDIN, use @samp{-} as the second filename.  For security
+reasons a detached signature cannot read the signed material from
+STDIN without denoting it in the above way.
+
+Note: If the option @option{--batch} is not used, @command{@gpgname}
+may assume that a single argument is a file with a detached signature
+and it will try to find a matching data file by stripping certain
+suffixes.  Using this historical feature to verify a detached
+signature is strongly discouraged; always specify the data file too.
+
+Note: When verifying a cleartext signature, @command{gpg} verifies
+only what makes up the cleartext signed data and not any extra data
+outside of the cleartext signature or header lines following directly
+the dash marker line.  The option @code{--output} may be used to write
+out the actual signed data; but there are other pitfalls with this
+format as well.  It is suggested to avoid cleartext signatures in
+favor of detached signatures.
 
 @item --multifile
 @opindex multifile
@@ -273,12 +251,6 @@ Identical to @option{--multifile --decrypt}.
 @opindex list-keys
 List all keys from the public keyrings, or just the keys given on the
 command line.
-@ifset gpgone
-@option{-k} is slightly different from @option{--list-keys} in that it
-allows only for one argument and takes the second argument as the
-keyring to search.  This is for command line compatibility with PGP 2
-and has been removed in @command{gpg2}.
-@end ifset
 
 Avoid using the output of this command in scripts or other programs as
 it is likely to change as GnuPG changes. See @option{--with-colons} for a
@@ -296,10 +268,8 @@ secret key is not usable (for example, if it was created via
 @item --list-sigs
 @opindex list-sigs
 Same as @option{--list-keys}, but the signatures are listed too.
-@ifclear gpgone
-This command has the same effect as 
+This command has the same effect as
 using @option{--list-keys} with @option{--with-sig-list}.
-@end ifclear
 
 For each signature listed, there are several flags in between the "sig"
 tag and keyid. These flags give additional information about each
@@ -319,10 +289,8 @@ command "tsign").
 Same as @option{--list-sigs}, but the signatures are verified.  Note
 that for performance reasons the revocation status of a signing key is
 not shown.
-@ifclear gpgone
-This command has the same effect as 
+This command has the same effect as
 using @option{--list-keys} with @option{--with-sig-check}.
-@end ifclear
 
 The status of the verification is indicated by a flag directly following
 the "sig" tag (and thus before the flags described above for
@@ -331,7 +299,6 @@ successfully verified, a "-" denotes a bad signature and a "%" is used
 if an error occurred while checking the signature (e.g. a non supported
 algorithm).
 
-@ifclear gpgone
 @item --locate-keys
 @opindex locate-keys
 Locate the keys given as arguments.  This command basically uses the
@@ -339,8 +306,6 @@ same algorithm as used when locating keys for encryption or signing and
 may thus be used to see what keys @command{@gpgname} might use.  In
 particular external methods as defined by @option{--auto-key-locate} may
 be used to locate a key.  Only public keys are listed.
-@end ifclear
-
 
 @item --fingerprint
 @opindex fingerprint
@@ -353,8 +318,9 @@ listed too.
 
 @item --list-packets
 @opindex list-packets
-List only the sequence of packets. This is mainly
-useful for debugging.
+List only the sequence of packets. This is mainly useful for
+debugging.  When used with option @option{--verbose} the actual MPI
+values are dumped and not only their lengths.
 
 
 @item --card-edit
@@ -362,7 +328,7 @@ useful for debugging.
 Present a menu to work with a smartcard. The subcommand "help" provides
 an overview on available commands. For a detailed description, please
 see the Card HOWTO at
-http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
+https://gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
 
 @item --card-status
 @opindex card-status
@@ -374,15 +340,15 @@ Present a menu to allow changing the PIN of a smartcard. This
 functionality is also available as the subcommand "passwd" with the
 @option{--card-edit} command.
 
-@item --delete-key @code{name}
-@opindex delete-key
+@item --delete-keys @code{name}
+@itemx --delete-keys @code{name}
 Remove key from the public keyring. In batch mode either @option{--yes} is
 required or the key must be specified by fingerprint. This is a
 safeguard against accidental deletion of multiple keys.
 
-@item --delete-secret-key @code{name}
-@opindex delete-secret-key
-Remove key from the secret and public keyring. In batch mode the key
+@item --delete-secret-keys @code{name}
+@opindex delete-secret-keys
+Remove key from the secret keyring. In batch mode the key
 must be specified by fingerprint.
 
 @item --delete-secret-and-public-key @code{name}
@@ -394,8 +360,8 @@ removed first. In batch mode the key must be specified by fingerprint.
 @opindex export
 Either export all keys from all keyrings (default keyrings and those
 registered via option @option{--keyring}), or if at least one name is given,
-those of the given name. The new keyring is written to STDOUT or to the
-file given with option @option{--output}. Use together with
+those of the given name. The exported keys are written to STDOUT or to the
+file given with option @option{--output}.  Use together with
 @option{--armor} to mail those keys.
 
 @item --send-keys @code{key IDs}
@@ -410,13 +376,25 @@ or changed by you.  If no key IDs are given, @command{gpg} does nothing.
 @itemx --export-secret-subkeys
 @opindex export-secret-keys
 @opindex export-secret-subkeys
-Same as @option{--export}, but exports the secret keys instead.  This is
-normally not very useful and a security risk.  The second form of the
-command has the special property to render the secret part of the
-primary key useless; this is a GNU extension to OpenPGP and other
-implementations can not be expected to successfully import such a key.
-See the option @option{--simple-sk-checksum} if you want to import such
-an exported key with an older OpenPGP implementation.
+Same as @option{--export}, but exports the secret keys instead.  The
+exported keys are written to STDOUT or to the file given with option
+@option{--output}.  This command is often used along with the option
+@option{--armor} to allow easy printing of the key for paper backup;
+however the external tool @command{paperkey} does a better job for
+creating backups on paper.  Note that exporting a secret key can be a
+security risk if the exported keys are send over an insecure channel.
+
+The second form of the command has the special property to render the
+secret part of the primary key useless; this is a GNU extension to
+OpenPGP and other implementations can not be expected to successfully
+import such a key.  Its intended use is to generated a full key with
+an additional signing subkey on a dedicated machine and then using
+this command to export the key without the primary key to the main
+machine.
+
+GnuPG may ask you to enter the passphrase for the key.  This is
+required because the internal protection method of the secret key is
+different from the one specified by the OpenPGP protocol.
 
 @item --import
 @itemx --fast-import
@@ -527,12 +505,13 @@ Print message digest of algorithm ALGO for all given files or STDIN.
 With the second form (or a deprecated "*" as algo) digests for all
 available algorithms are printed.
 
-@item --gen-random @code{0|1|2}
+@item --gen-random @code{0|1|2} @code{count}
 @opindex gen-random
-Emit @var{count} random bytes of the given quality level. If count is
-not given or zero, an endless sequence of random bytes will be emitted.
-PLEASE, don't use this command unless you know what you are doing; it
-may remove precious entropy from the system!
+Emit @var{count} random bytes of the given quality level 0, 1 or 2. If
+@var{count} is not given or zero, an endless sequence of random bytes
+will be emitted.  If used with @option{--armor} the output will be
+base64 encoded.  PLEASE, don't use this command unless you know what
+you are doing; it may remove precious entropy from the system!
 
 @item --gen-prime @code{mode}  @code{bits}
 @opindex gen-prime
@@ -542,10 +521,16 @@ Use the source, Luke :-). The output format is still subject to change.
 @item --enarmor
 @item --dearmor
 @opindex enarmor
-@opindex --enarmor
+@opindex dearmor
 Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
 This is a GnuPG extension to OpenPGP and in general not very useful.
 
+
+@c @item --server
+@c @opindex server
+@c Run gpg in server mode.  This feature is not yet ready for use and
+@c thus not documented.
+
 @end table
 
 
@@ -559,14 +544,40 @@ This section explains the main commands for key management
 
 @table @gnupgtabopt
 
+@item --quick-gen-key @code{user-id}
+@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
+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 key ring.
+
+If invoked directly on the console without any special options an
+answer to a ``Continue?'' style confirmation prompt is required.  In
+case the user id already exists in the key ring a second prompt to
+force the creation of the key will show up.
+
+If this command is used with @option{--batch},
+@option{--pinentry-mode} has been set to @code{loopback}, and one of
+the passphrase options (@option{--passphrase},
+@option{--passphrase-fd}, or @option{passphrase-file}) is used, the
+supplied passphrase is used for the new key and the agent does not ask
+for it.  To create a key without any protection @code{--passphrase ''}
+may be used.
+
 @item --gen-key
 @opindex gen-key
-Generate a new key pair. This command is normally only used
-interactively.
+Generate a new key pair using teh current default parameters.  This is
+the standard command to create a new key.
+
+@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}.
 
-There is an experimental feature which allows you to create keys in
-batch mode. See the file @file{doc/DETAILS} in the source distribution
-on how to use this.
+There is also a feature which allows you to create keys in batch
+mode. See the the manual section ``Unattended key generation'' on how
+to use this.
 
 @item --gen-revoke @code{name}
 @opindex gen-revoke
@@ -589,42 +600,42 @@ line.
 @c ******** Begin Edit-key Options **********
 @table @asis
 
-@item uid @code{n}
-@opindex keyedit:uid
-Toggle selection of user ID or photographic user ID with index @code{n}.
-Use @code{*} to select all and @code{0} to deselect all.
-
-@item key @code{n}
-@opindex keyedit:key
-Toggle selection of subkey with index @code{n}.
-Use @code{*} to select all and @code{0} to deselect all.
-
-@item sign
-@opindex keyedit:sign
-Make a signature on key of user @code{name} If the key is not yet
-signed by the default user (or the users given with -u), the program
-displays the information of the key again, together with its
-fingerprint and asks whether it should be signed. This question is
-repeated for all users specified with
--u.
-
-@item lsign
-@opindex keyedit:lsign
-Same as "sign" but the signature is marked as non-exportable and will
-therefore never be used by others. This may be used to make keys
-valid only in the local environment.
-
-@item nrsign
-@opindex keyedit:nrsign
-Same as "sign" but the signature is marked as non-revocable and can
-therefore never be revoked.
-
-@item tsign
-@opindex keyedit:tsign
-Make a trust signature. This is a signature that combines the notions
-of certification (like a regular signature), and trust (like the
-"trust" command). It is generally only useful in distinct communities
-or groups.
+  @item uid @code{n}
+  @opindex keyedit:uid
+  Toggle selection of user ID or photographic user ID with index @code{n}.
+  Use @code{*} to select all and @code{0} to deselect all.
+
+  @item key @code{n}
+  @opindex keyedit:key
+  Toggle selection of subkey with index @code{n}.
+  Use @code{*} to select all and @code{0} to deselect all.
+
+  @item sign
+  @opindex keyedit:sign
+  Make a signature on key of user @code{name} If the key is not yet
+  signed by the default user (or the users given with -u), the program
+  displays the information of the key again, together with its
+  fingerprint and asks whether it should be signed. This question is
+  repeated for all users specified with
+  -u.
+
+  @item lsign
+  @opindex keyedit:lsign
+  Same as "sign" but the signature is marked as non-exportable and will
+  therefore never be used by others. This may be used to make keys
+  valid only in the local environment.
+
+  @item nrsign
+  @opindex keyedit:nrsign
+  Same as "sign" but the signature is marked as non-revocable and can
+  therefore never be revoked.
+
+  @item tsign
+  @opindex keyedit:tsign
+  Make a trust signature. This is a signature that combines the notions
+  of certification (like a regular signature), and trust (like the
+  "trust" command). It is generally only useful in distinct communities
+  or groups.
 @end table
 
 @c man:.RS
@@ -635,217 +646,217 @@ create a signature of any type desired.
 
 @table @asis
 
-@item delsig
-@opindex keyedit:delsig
-Delete a signature. Note that it is not possible to retract a signature,
-once it has been send to the public (i.e. to a keyserver).  In that case
-you better use @code{revsig}.
-
-@item revsig
-@opindex keyedit:revsig
-Revoke a signature. For every signature which has been generated by
-one of the secret keys, GnuPG asks whether a revocation certificate
-should be generated.
-
-@item check
-@opindex keyedit:check
-Check the signatures on all selected user IDs.
-
-@item adduid
-@opindex keyedit:adduid
-Create an additional user ID.
-
-@item addphoto
-@opindex keyedit:addphoto
-Create a photographic user ID. This will prompt for a JPEG file that
-will be embedded into the user ID. Note that a very large JPEG will make
-for a very large key. Also note that some programs will display your
-JPEG unchanged (GnuPG), and some programs will scale it to fit in a
-dialog box (PGP).
-
-@item showphoto
-@opindex keyedit:showphoto
-Display the selected photographic user ID.
-
-@item deluid
-@opindex keyedit:deluid
-Delete a user ID or photographic user ID.  Note that it is not
-possible to retract a user id, once it has been send to the public
-(i.e. to a keyserver).  In that case you better use @code{revuid}.
-
-@item revuid
-@opindex keyedit:revuid
-Revoke a user ID or photographic user ID.
-
-@item primary
-@opindex keyedit:primary
-Flag the current user id as the primary one, removes the primary user
-id flag from all other user ids and sets the timestamp of all affected
-self-signatures one second ahead. Note that setting a photo user ID
-as primary makes it primary over other photo user IDs, and setting a
-regular user ID as primary makes it primary over other regular user
-IDs.
-
-@item keyserver
-@opindex keyedit:keyserver
-Set a preferred keyserver for the specified user ID(s). This allows
-other users to know where you prefer they get your key from. See
-@option{--keyserver-options honor-keyserver-url} for more on how this
-works.  Setting a value of "none" removes an existing preferred
-keyserver.
-
-@item notation
-@opindex keyedit:notation
-Set a name=value notation for the specified user ID(s). See
-@option{--cert-notation} for more on how this works. Setting a value of
-"none" removes all notations, setting a notation prefixed with a minus
-sign (-) removes that notation, and setting a notation name (without the
-=value) prefixed with a minus sign removes all notations with that name.
-
-@item pref
-@opindex keyedit:pref
-List preferences from the selected user ID. This shows the actual
-preferences, without including any implied preferences.
-
-@item showpref
-@opindex keyedit:showpref
-More verbose preferences listing for the selected user ID. This shows
-the preferences in effect by including the implied preferences of 3DES
-(cipher), SHA-1 (digest), and Uncompressed (compression) if they are
-not already included in the preference list. In addition, the
-preferred keyserver and signature notations (if any) are shown.
-
-@item setpref @code{string}
-@opindex keyedit:setpref
-Set the list of user ID preferences to @code{string} for all (or just
-the selected) user IDs. Calling setpref with no arguments sets the
-preference list to the default (either built-in or set via
-@option{--default-preference-list}), and calling setpref with "none"
-as the argument sets an empty preference list. Use @command{@gpgname
---version} to get a list of available algorithms. Note that while you
-can change the preferences on an attribute user ID (aka "photo ID"),
-GnuPG does not select keys via attribute user IDs so these preferences
-will not be used by GnuPG.
-
-When setting preferences, you should list the algorithms in the order
-which you'd like to see them used by someone else when encrypting a
-message to your key.  If you don't include 3DES, it will be
-automatically added at the end.  Note that there are many factors that
-go into choosing an algorithm (for example, your key may not be the
-only recipient), and so the remote OpenPGP application being used to
-send to you may or may not follow your exact chosen order for a given
-message.  It will, however, only choose an algorithm that is present
-on the preference list of every recipient key.  See also the
-INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below.
-
-@item addkey
-@opindex keyedit:addkey
-Add a subkey to this key.
-
-@item addcardkey
-@opindex keyedit:addcardkey
-Generate a subkey on a card and add it to this key.
-
-@item keytocard
-@opindex keyedit:keytocard
-Transfer the selected secret subkey (or the primary key if no subkey
-has been selected) to a smartcard. The secret key in the keyring will
-be replaced by a stub if the key could be stored successfully on the
-card and you use the save command later. Only certain key types may be
-transferred to the card. A sub menu allows you to select on what card
-to store the key. Note that it is not possible to get that key back
-from the card - if the card gets broken your secret key will be lost
-unless you have a backup somewhere.
-
-@item bkuptocard @code{file}
-@opindex keyedit:bkuptocard
-Restore the given file to a card. This command may be used to restore a
-backup key (as generated during card initialization) to a new card. In
-almost all cases this will be the encryption key. You should use this
-command only with the corresponding public key and make sure that the
-file given as argument is indeed the backup to restore. You should then
-select 2 to restore as encryption key.  You will first be asked to enter
-the passphrase of the backup key and then for the Admin PIN of the card.
-
-@item delkey
-@opindex keyedit:delkey
-Remove a subkey (secondart key). Note that it is not possible to retract
-a subkey, once it has been send to the public (i.e. to a keyserver).  In
-that case you better use @code{revkey}.
-
-@item revkey
-@opindex keyedit:revkey
-Revoke a subkey.
-
-@item expire
-@opindex keyedit:expire
-Change the key or subkey expiration time. If a subkey is selected, the
-expiration time of this subkey will be changed. With no selection, the
-key expiration of the primary key is changed.
-
-@item trust
-@opindex keyedit:trust
-Change the owner trust value for the key. This updates the trust-db
-immediately and no save is required.
-
-@item disable
-@itemx enable
-@opindex keyedit:disable
-@opindex keyedit:enable
-Disable or enable an entire key. A disabled key can not normally be
-used for encryption.
-
-@item addrevoker
-@opindex keyedit:addrevoker
-Add a designated revoker to the key. This takes one optional argument:
-"sensitive". If a designated revoker is marked as sensitive, it will
-not be exported by default (see export-options).
-
-@item passwd
-@opindex keyedit:passwd
-Change the passphrase of the secret key.
-
-@item toggle
-@opindex keyedit:toggle
-Toggle between public and secret key listing.
-
-@item clean
-@opindex keyedit:clean
-Compact (by removing all signatures except the selfsig) any user ID
-that is no longer usable (e.g. revoked, or expired). Then, remove any
-signatures that are not usable by the trust calculations.
-Specifically, this removes any signature that does not validate, any
-signature that is superseded by a later signature, revoked signatures,
-and signatures issued by keys that are not present on the keyring.
-
-@item minimize
-@opindex keyedit:minimize
-Make the key as small as possible. This removes all signatures from
-each user ID except for the most recent self-signature.
-
-@item cross-certify
-@opindex keyedit:cross-certify
-Add cross-certification signatures to signing subkeys that may not
-currently have them. Cross-certification signatures protect against a
-subtle attack against signing subkeys. See
-@option{--require-cross-certification}.  All new keys generated have
-this signature by default, so this option is only useful to bring
-older keys up to date.
-
-@item save
-@opindex keyedit:save
-Save all changes to the key rings and quit.
-
-@item quit
-@opindex keyedit:quit
-Quit the program without updating the
-key rings.
-
+  @item delsig
+  @opindex keyedit:delsig
+  Delete a signature. Note that it is not possible to retract a signature,
+  once it has been send to the public (i.e. to a keyserver).  In that case
+  you better use @code{revsig}.
+
+  @item revsig
+  @opindex keyedit:revsig
+  Revoke a signature. For every signature which has been generated by
+  one of the secret keys, GnuPG asks whether a revocation certificate
+  should be generated.
+
+  @item check
+  @opindex keyedit:check
+  Check the signatures on all selected user IDs.
+
+  @item adduid
+  @opindex keyedit:adduid
+  Create an additional user ID.
+
+  @item addphoto
+  @opindex keyedit:addphoto
+  Create a photographic user ID. This will prompt for a JPEG file that
+  will be embedded into the user ID. Note that a very large JPEG will make
+  for a very large key. Also note that some programs will display your
+  JPEG unchanged (GnuPG), and some programs will scale it to fit in a
+  dialog box (PGP).
+
+  @item showphoto
+  @opindex keyedit:showphoto
+  Display the selected photographic user ID.
+
+  @item deluid
+  @opindex keyedit:deluid
+  Delete a user ID or photographic user ID.  Note that it is not
+  possible to retract a user id, once it has been send to the public
+  (i.e. to a keyserver).  In that case you better use @code{revuid}.
+
+  @item revuid
+  @opindex keyedit:revuid
+  Revoke a user ID or photographic user ID.
+
+  @item primary
+  @opindex keyedit:primary
+  Flag the current user id as the primary one, removes the primary user
+  id flag from all other user ids and sets the timestamp of all affected
+  self-signatures one second ahead. Note that setting a photo user ID
+  as primary makes it primary over other photo user IDs, and setting a
+  regular user ID as primary makes it primary over other regular user
+  IDs.
+
+  @item keyserver
+  @opindex keyedit:keyserver
+  Set a preferred keyserver for the specified user ID(s). This allows
+  other users to know where you prefer they get your key from. See
+  @option{--keyserver-options honor-keyserver-url} for more on how this
+  works.  Setting a value of "none" removes an existing preferred
+  keyserver.
+
+  @item notation
+  @opindex keyedit:notation
+  Set a name=value notation for the specified user ID(s). See
+  @option{--cert-notation} for more on how this works. Setting a value of
+  "none" removes all notations, setting a notation prefixed with a minus
+  sign (-) removes that notation, and setting a notation name (without the
+  =value) prefixed with a minus sign removes all notations with that name.
+
+  @item pref
+  @opindex keyedit:pref
+  List preferences from the selected user ID. This shows the actual
+  preferences, without including any implied preferences.
+
+  @item showpref
+  @opindex keyedit:showpref
+  More verbose preferences listing for the selected user ID. This shows
+  the preferences in effect by including the implied preferences of 3DES
+  (cipher), SHA-1 (digest), and Uncompressed (compression) if they are
+  not already included in the preference list. In addition, the
+  preferred keyserver and signature notations (if any) are shown.
+
+  @item setpref @code{string}
+  @opindex keyedit:setpref
+  Set the list of user ID preferences to @code{string} for all (or just
+  the selected) user IDs. Calling setpref with no arguments sets the
+  preference list to the default (either built-in or set via
+  @option{--default-preference-list}), and calling setpref with "none"
+  as the argument sets an empty preference list. Use @command{@gpgname
+  --version} to get a list of available algorithms. Note that while you
+  can change the preferences on an attribute user ID (aka "photo ID"),
+  GnuPG does not select keys via attribute user IDs so these preferences
+  will not be used by GnuPG.
+
+  When setting preferences, you should list the algorithms in the order
+  which you'd like to see them used by someone else when encrypting a
+  message to your key.  If you don't include 3DES, it will be
+  automatically added at the end.  Note that there are many factors that
+  go into choosing an algorithm (for example, your key may not be the
+  only recipient), and so the remote OpenPGP application being used to
+  send to you may or may not follow your exact chosen order for a given
+  message.  It will, however, only choose an algorithm that is present
+  on the preference list of every recipient key.  See also the
+  INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below.
+
+  @item addkey
+  @opindex keyedit:addkey
+  Add a subkey to this key.
+
+  @item addcardkey
+  @opindex keyedit:addcardkey
+  Generate a subkey on a card and add it to this key.
+
+  @item keytocard
+  @opindex keyedit:keytocard
+  Transfer the selected secret subkey (or the primary key if no subkey
+  has been selected) to a smartcard. The secret key in the keyring will
+  be replaced by a stub if the key could be stored successfully on the
+  card and you use the save command later. Only certain key types may be
+  transferred to the card. A sub menu allows you to select on what card
+  to store the key. Note that it is not possible to get that key back
+  from the card - if the card gets broken your secret key will be lost
+  unless you have a backup somewhere.
+
+  @item bkuptocard @code{file}
+  @opindex keyedit:bkuptocard
+  Restore the given file to a card. This command may be used to restore a
+  backup key (as generated during card initialization) to a new card. In
+  almost all cases this will be the encryption key. You should use this
+  command only with the corresponding public key and make sure that the
+  file given as argument is indeed the backup to restore. You should then
+  select 2 to restore as encryption key.  You will first be asked to enter
+  the passphrase of the backup key and then for the Admin PIN of the card.
+
+  @item delkey
+  @opindex keyedit:delkey
+  Remove a subkey (secondary key). Note that it is not possible to retract
+  a subkey, once it has been send to the public (i.e. to a keyserver).  In
+  that case you better use @code{revkey}.
+
+  @item revkey
+  @opindex keyedit:revkey
+  Revoke a subkey.
+
+  @item expire
+  @opindex keyedit:expire
+  Change the key or subkey expiration time. If a subkey is selected, the
+  expiration time of this subkey will be changed. With no selection, the
+  key expiration of the primary key is changed.
+
+  @item trust
+  @opindex keyedit:trust
+  Change the owner trust value for the key. This updates the trust-db
+  immediately and no save is required.
+
+  @item disable
+  @itemx enable
+  @opindex keyedit:disable
+  @opindex keyedit:enable
+  Disable or enable an entire key. A disabled key can not normally be
+  used for encryption.
+
+  @item addrevoker
+  @opindex keyedit:addrevoker
+  Add a designated revoker to the key. This takes one optional argument:
+  "sensitive". If a designated revoker is marked as sensitive, it will
+  not be exported by default (see export-options).
+
+  @item passwd
+  @opindex keyedit:passwd
+  Change the passphrase of the secret key.
+
+  @item toggle
+  @opindex keyedit:toggle
+  Toggle between public and secret key listing.
+
+  @item clean
+  @opindex keyedit:clean
+  Compact (by removing all signatures except the selfsig) any user ID
+  that is no longer usable (e.g. revoked, or expired). Then, remove any
+  signatures that are not usable by the trust calculations.
+  Specifically, this removes any signature that does not validate, any
+  signature that is superseded by a later signature, revoked signatures,
+  and signatures issued by keys that are not present on the keyring.
+
+  @item minimize
+  @opindex keyedit:minimize
+  Make the key as small as possible. This removes all signatures from
+  each user ID except for the most recent self-signature.
+
+  @item cross-certify
+  @opindex keyedit:cross-certify
+  Add cross-certification signatures to signing subkeys that may not
+  currently have them. Cross-certification signatures protect against a
+  subtle attack against signing subkeys. See
+  @option{--require-cross-certification}.  All new keys generated have
+  this signature by default, so this option is only useful to bring
+  older keys up to date.
+
+  @item save
+  @opindex keyedit:save
+  Save all changes to the key rings and quit.
+
+  @item quit
+  @opindex keyedit:quit
+  Quit the program without updating the
+  key rings.
 @end table
 
 @c man:.RS
 The listing shows you the key with its secondary keys and all user
-ids. Selected keys or user ids are indicated by an asterisk. The trust
+ids.  The primary user id is indicated by a dot, and selected keys or
+user ids are indicated by an asterisk.  The trust
 value is displayed with the primary key: the first is the assigned owner
 trust and the second is the calculated trust value. Letters are used for
 the values:
@@ -853,27 +864,28 @@ the values:
 
 @table @asis
 
-@item -
-No ownertrust assigned / not yet calculated.
+  @item -
+  No ownertrust assigned / not yet calculated.
+
+  @item e
+  Trust
+  calculation has failed; probably due to an expired key.
 
-@item e
-Trust
-calculation has failed; probably due to an expired key.
+  @item q
+  Not enough information for calculation.
 
-@item q
-Not enough information for calculation.
+  @item n
+  Never trust this key.
 
-@item n
-Never trust this key.
+  @item m
+  Marginally trusted.
 
-@item m
-Marginally trusted.
+  @item f
+  Fully trusted.
 
-@item f
-Fully trusted.
+  @item u
+  Ultimately trusted.
 
-@item u
-Ultimately trusted.
 @end table
 @c ******** End Edit-key Options **********
 
@@ -888,6 +900,37 @@ Signs a public key with your secret key but marks it as
 non-exportable. This is a shortcut version of the subcommand "lsign"
 from @option{--edit-key}.
 
+@item --quick-sign-key @code{fpr} [@code{names}]
+@itemx --quick-lsign-key @code{fpr} [@code{names}]
+@opindex quick-sign-key
+@opindex quick-lsign-key
+Directly sign a key from the passphrase without any further user
+interaction.  The @code{fpr} must be the verified primary fingerprint
+of a key in the local keyring. If no @code{names} are given, all
+useful user ids are signed; with given [@code{names}] only useful user
+ids matching one of theses names are signed.  The command
+@option{--quick-lsign-key} marks the signatures as non-exportable.  If
+such a non-exportable signature already exists the
+@option{--quick-sign-key} turns it into a exportable signature.
+
+This command uses reasonable defaults and thus does not provide the
+full flexibility of the "sign" subcommand from @option{--edit-key}.
+Its intended use is to help unattended key signing by utilizing a list
+of verified fingerprints.
+
+@item --quick-adduid  @var{user-id} @var{new-user-id}
+@opindex quick-adduid
+This command adds a new user id to an existing key.  In contrast to
+the interactive sub-command @code{adduid} of @option{--edit-key} the
+@var{new-user-id} is added verbatim with only leading and trailing
+white space removed, it is expected to be UTF-8 encoded, and no checks
+on its form are applied.
+
+@item --passwd @var{user_id}
+@opindex passwd
+Change the passphrase of the secret key belonging to the certificate
+specified as @var{user_id}.  This is a shortcut for the sub-command
+@code{passwd} of the edit key menu.
 
 @end table
 
@@ -901,7 +944,7 @@ from @option{--edit-key}.
 @node GPG Options
 @section Option Summary
 
-@command{@gpgname} comes features a bunch of options to control the exact
+@command{@gpgname} features a bunch of options to control the exact
 behaviour and to change the default configuration.
 
 @menu
@@ -909,7 +952,9 @@ behaviour and to change the default configuration.
 * GPG Key related Options::     Key related options.
 * GPG Input and Output::        Input and Output.
 * OpenPGP Options::             OpenPGP protocol specific options.
+* Compliance Options::          Compliance options.
 * GPG Esoteric Options::        Doing things one usually don't want to do.
+* Deprecated Options::          Deprecated options.
 @end menu
 
 Long options can be put in an options file (default
@@ -1009,121 +1054,164 @@ give the opposite meaning.  The options are:
 
 @table @asis
 
-@item show-photos
-@opindex list-options:show-photos
-Causes @option{--list-keys}, @option{--list-sigs},
-@option{--list-public-keys}, and @option{--list-secret-keys} to display
-any photo IDs attached to the key.  Defaults to no. See also
-@option{--photo-viewer}.
-
-@item show-policy-urls
-@opindex list-options:show-policy-urls
-Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
-listings.  Defaults to no.
-
-@item show-notations
-@itemx show-std-notations
-@itemx show-user-notations
-@opindex list-options:show-notations
-@opindex list-options:show-std-notations
-@opindex list-options:show-user-notations
-Show all, IETF standard, or user-defined signature notations in the
-@option{--list-sigs} or @option{--check-sigs} listings. Defaults to no.
-
-@item show-keyserver-urls
-
-Show any preferred keyserver URL in the @option{--list-sigs} or
-@option{--check-sigs} listings. Defaults to no.
-
-@item show-uid-validity
-Display the calculated validity of user IDs during key listings.
-Defaults to no.
+  @item show-photos
+  @opindex list-options:show-photos
+  Causes @option{--list-keys}, @option{--list-sigs},
+  @option{--list-public-keys}, and @option{--list-secret-keys} to
+  display any photo IDs attached to the key.  Defaults to no. See also
+  @option{--photo-viewer}.  Does not work with @option{--with-colons}:
+  see @option{--attribute-fd} for the appropriate way to get photo data
+  for scripts and other frontends.
+
+  @item show-usage
+  @opindex list-options:show-usage
+  Show usage information for keys and subkeys in the standard key
+  listing.  This is a list of letters indicating the allowed usage for a
+  key (@code{E}=encryption, @code{S}=signing, @code{C}=certification,
+  @code{A}=authentication).  Defaults to no.
+
+  @item show-policy-urls
+  @opindex list-options:show-policy-urls
+  Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
+  listings.  Defaults to no.
+
+  @item show-notations
+  @itemx show-std-notations
+  @itemx show-user-notations
+  @opindex list-options:show-notations
+  @opindex list-options:show-std-notations
+  @opindex list-options:show-user-notations
+  Show all, IETF standard, or user-defined signature notations in the
+  @option{--list-sigs} or @option{--check-sigs} listings. Defaults to no.
+
+  @item show-keyserver-urls
+  @opindex list-options:show-keyserver-urls
+  Show any preferred keyserver URL in the @option{--list-sigs} or
+  @option{--check-sigs} listings. Defaults to no.
+
+  @item show-uid-validity
+  @opindex list-options:show-uid-validity
+  Display the calculated validity of user IDs during key listings.
+  Defaults to no.
+
+  @item show-unusable-uids
+  @opindex list-options:show-unusable-uids
+  Show revoked and expired user IDs in key listings. Defaults to no.
+
+  @item show-unusable-subkeys
+  @opindex list-options:show-unusable-subkeys
+  Show revoked and expired subkeys in key listings. Defaults to no.
+
+  @item show-keyring
+  @opindex list-options:show-keyring
+  Display the keyring name at the head of key listings to show which
+  keyring a given key resides on. Defaults to no.
+
+  @item show-sig-expire
+  @opindex list-options:show-sig-expire
+  Show signature expiration dates (if any) during @option{--list-sigs} or
+  @option{--check-sigs} listings. Defaults to no.
+
+  @item show-sig-subpackets
+  @opindex list-options:show-sig-subpackets
+  Include signature subpackets in the key listing. This option can take an
+  optional argument list of the subpackets to list. If no argument is
+  passed, list all subpackets. Defaults to no. This option is only
+  meaningful when using @option{--with-colons} along with
+  @option{--list-sigs} or @option{--check-sigs}.
 
-@item show-unusable-uids
-Show revoked and expired user IDs in key listings. Defaults to no.
-
-@item show-unusable-subkeys
-Show revoked and expired subkeys in key listings. Defaults to no.
-
-@item show-keyring
-Display the keyring name at the head of key listings to show which
-keyring a given key resides on. Defaults to no.
-
-@item show-sig-expire
-Show signature expiration dates (if any) during @option{--list-sigs} or
-@option{--check-sigs} listings. Defaults to no.
-
-@item show-sig-subpackets
-Include signature subpackets in the key listing. This option can take an
-optional argument list of the subpackets to list. If no argument is
-passed, list all subpackets. Defaults to no. This option is only
-meaningful when using @option{--with-colons} along with
-@option{--list-sigs} or @option{--check-sigs}.
 @end table
 
 @item --verify-options @code{parameters}
+@opindex verify-options
 This is a space or comma delimited string that gives options used when
 verifying signatures. Options can be prepended with a `no-' to give
 the opposite meaning. The options are:
 
 @table @asis
 
-@item show-photos
-Display any photo IDs present on the key that issued the signature.
-Defaults to no. See also @option{--photo-viewer}.
-
-@item show-policy-urls
-Show policy URLs in the signature being verified. Defaults to no.
-
-@item show-notations
-@itemx show-std-notations
-@itemx show-user-notations
-Show all, IETF standard, or user-defined signature notations in the
-signature being verified. Defaults to IETF standard.
-
-@item show-keyserver-urls
-Show any preferred keyserver URL in the signature being verified.
-Defaults to no.
-
-@item show-uid-validity
-Display the calculated validity of the user IDs on the key that issued
-the signature. Defaults to no.
-
-@item show-unusable-uids
-Show revoked and expired user IDs during signature verification.
-Defaults to no.
-
-@item show-primary-uid-only
-Show only the primary user ID during signature verification.  That is
-all the AKA lines as well as photo Ids are not shown with the signature
-verification status.
-
-@item pka-lookups
-Enable PKA lookups to verify sender addresses. Note that PKA is based
-on DNS, and so enabling this option may disclose information on when
-and what signatures are verified or to whom data is encrypted. This
-is similar to the "web bug" described for the auto-key-retrieve
-feature.
-
-@item pka-trust-increase
-Raise the trust in a signature to full if the signature passes PKA
-validation. This option is only meaningful if pka-lookups is set.
+  @item show-photos
+  @opindex verify-options:show-photos
+  Display any photo IDs present on the key that issued the signature.
+  Defaults to no. See also @option{--photo-viewer}.
+
+  @item show-policy-urls
+  @opindex verify-options:show-policy-urls
+  Show policy URLs in the signature being verified. Defaults to no.
+
+  @item show-notations
+  @itemx show-std-notations
+  @itemx show-user-notations
+  @opindex verify-options:show-notations
+  @opindex verify-options:show-std-notations
+  @opindex verify-options:show-user-notations
+  Show all, IETF standard, or user-defined signature notations in the
+  signature being verified. Defaults to IETF standard.
+
+  @item show-keyserver-urls
+  @opindex verify-options:show-keyserver-urls
+  Show any preferred keyserver URL in the signature being verified.
+  Defaults to no.
+
+  @item show-uid-validity
+  @opindex verify-options:show-uid-validity
+  Display the calculated validity of the user IDs on the key that issued
+  the signature. Defaults to no.
+
+  @item show-unusable-uids
+  @opindex verify-options:show-unusable-uids
+  Show revoked and expired user IDs during signature verification.
+  Defaults to no.
+
+  @item show-primary-uid-only
+  @opindex verify-options:show-primary-uid-only
+  Show only the primary user ID during signature verification.  That is
+  all the AKA lines as well as photo Ids are not shown with the signature
+  verification status.
+
+  @item pka-lookups
+  @opindex verify-options:pka-lookups
+  Enable PKA lookups to verify sender addresses. Note that PKA is based
+  on DNS, and so enabling this option may disclose information on when
+  and what signatures are verified or to whom data is encrypted. This
+  is similar to the "web bug" described for the auto-key-retrieve
+  feature.
+
+  @item pka-trust-increase
+  @opindex verify-options:pka-trust-increase
+  Raise the trust in a signature to full if the signature passes PKA
+  validation. This option is only meaningful if pka-lookups is set.
 @end table
 
+@item --enable-large-rsa
+@itemx --disable-large-rsa
+@opindex enable-large-rsa
+@opindex disable-large-rsa
+With --gen-key and --batch, enable the creation of larger RSA secret
+keys than is generally recommended (up to 8192 bits).  These large
+keys are more expensive to use, and their signatures and
+certifications are also larger.
+
 @item --enable-dsa2
 @itemx --disable-dsa2
+@opindex enable-dsa2
+@opindex disable-dsa2
 Enable hash truncation for all DSA keys even for old DSA Keys up to
 1024 bit.  This is also the default with @option{--openpgp}.  Note
 that older versions of GnuPG also required this flag to allow the
 generation of DSA larger than 1024 bit.
 
 @item --photo-viewer @code{string}
+@opindex photo-viewer
 This is the command line that should be run to view a photo ID. "%i"
 will be expanded to a filename containing the photo. "%I" does the
 same, except the file will not be deleted once the viewer exits.
 Other flags are "%k" for the key ID, "%K" for the long key ID, "%f"
 for the key fingerprint, "%t" for the extension of the image type
 (e.g. "jpg"), "%T" for the MIME type of the image (e.g. "image/jpeg"),
+"%v" for the single-character calculated validity of the image being
+viewed (e.g. "f"), "%V" for the calculated validity as a string (e.g.
+"full"), "%U" for a base32 encoded hash of the user ID,
 and "%%" for an actual percent sign. If neither %i or %I are present,
 then the photo will be supplied to the viewer on standard input.
 
@@ -1132,6 +1220,7 @@ STDIN". Note that if your image viewer program is not secure, then
 executing it from GnuPG does not make it secure.
 
 @item --exec-path @code{string}
+@opindex exec-path
 Sets a list of directories to search for photo viewers and keyserver
 helpers. If not provided, keyserver helpers use the compiled-in
 default directory, and photo viewers use the $PATH environment
@@ -1140,6 +1229,7 @@ Note, that on W32 system this value is ignored when searching for
 keyserver helpers.
 
 @item --keyring @code{file}
+@opindex keyring
 Add @code{file} to the current list of keyrings. If @code{file} begins
 with a tilde and a slash, these are replaced by the $HOME directory. If
 the filename does not contain a slash, it is assumed to be in the GnuPG
@@ -1151,53 +1241,29 @@ use the specified keyring alone, use @option{--keyring} along with
 @option{--no-default-keyring}.
 
 @item --secret-keyring @code{file}
-Same as @option{--keyring} but for the secret keyrings.
+@opindex secret-keyring
+This is an obsolete option and ignored.  All secret keys are stored in
+the @file{private-keys-v1.d} directory below the GnuPG home directory.
 
 @item --primary-keyring @code{file}
+@opindex primary-keyring
 Designate @code{file} as the primary public keyring. This means that
 newly imported keys (via @option{--import} or keyserver
 @option{--recv-from}) will go to this keyring.
 
 @item --trustdb-name @code{file}
+@opindex trustdb-name
 Use @code{file} instead of the default trustdb. If @code{file} begins
 with a tilde and a slash, these are replaced by the $HOME directory. If
 the filename does not contain a slash, it is assumed to be in the GnuPG
 home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
 not used).
 
-@ifset gpgone
-@anchor{option --homedir}
-@end ifset
 @include opt-homedir.texi
 
 
-@ifset gpgone
-@item --pcsc-driver @code{file}
-Use @code{file} to access the smartcard reader. The current default is
-`libpcsclite.so.1' for GLIBC based systems,
-`/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
-`winscard.dll' for Windows and `libpcsclite.so' for other systems.
-@end ifset
-
-@ifset gpgone
-@item --disable-ccid
-Disable the integrated support for CCID compliant readers. This
-allows to fall back to one of the other drivers even if the internal
-CCID driver can handle the reader. Note, that CCID support is only
-available if libusb was available at build time.
-@end ifset
-
-@ifset gpgone
-@item --reader-port @code{number_or_string}
-This option may be used to specify the port of the card terminal. A
-value of 0 refers to the first serial device; add 32768 to access USB
-devices. The default is 32768 (first USB device). PC/SC or CCID
-readers might need a string here; run the program in verbose mode to get
-a list of available readers. The default is then the first reader
-found.
-@end ifset
-
 @item --display-charset @code{name}
+@opindex display-charset
 Set the name of the native character set. This is used to convert
 some informational strings like user IDs to the proper UTF-8 encoding.
 Note that this has nothing to do with the character set of data to be
@@ -1208,50 +1274,56 @@ Valid values for @code{name} are:
 
 @table @asis
 
-@item iso-8859-1
-This is the Latin 1 set.
+  @item iso-8859-1
+  @opindex display-charset:iso-8859-1
+  This is the Latin 1 set.
 
-@item iso-8859-2
-The Latin 2 set.
+  @item iso-8859-2
+  @opindex display-charset:iso-8859-2
+  The Latin 2 set.
 
-@item iso-8859-15
-This is currently an alias for
-the Latin 1 set.
+  @item iso-8859-15
+  @opindex display-charset:iso-8859-15
+  This is currently an alias for
+  the Latin 1 set.
 
-@item koi8-r
-The usual Russian set (rfc1489).
+  @item koi8-r
+  @opindex display-charset:koi8-r
+  The usual Russian set (rfc1489).
 
-@item utf-8
-Bypass all translations and assume
-that the OS uses native UTF-8 encoding.
+  @item utf-8
+  @opindex display-charset:utf-8
+  Bypass all translations and assume
+  that the OS uses native UTF-8 encoding.
 @end table
 
 @item --utf8-strings
 @itemx --no-utf8-strings
+@opindex utf8-strings
 Assume that command line arguments are given as UTF8 strings. The
 default (@option{--no-utf8-strings}) is to assume that arguments are
 encoded in the character set as specified by
 @option{--display-charset}. These options affect all following
 arguments. Both options may be used multiple times.
 
-@ifset gpgone
-@anchor{option --options}
-@end ifset
+@anchor{gpg-option --options}
 @item --options @code{file}
+@opindex options
 Read options from @code{file} and do not try to read them from the
 default options file in the homedir (see @option{--homedir}). This
 option is ignored if used in an options file.
 
 @item --no-options
+@opindex no-options
 Shortcut for @option{--options /dev/null}. This option is detected
 before an attempt to open an option file.  Using this option will also
 prevent the creation of a @file{~/.gnupg} homedir.
 
-
-
 @item -z @code{n}
 @itemx --compress-level @code{n}
 @itemx --bzip2-compress-level @code{n}
+@opindex compress-level
+@opindex bzip2-compress-level
 Set compression level to @code{n} for the ZIP and ZLIB compression
 algorithms. The default is to use the default compression level of zlib
 (normally 6). @option{--bzip2-compress-level} sets the compression level
@@ -1261,6 +1333,7 @@ significant amount of memory for each additional compression level.
 @option{-z} sets both. A value of 0 for @code{n} disables compression.
 
 @item --bzip2-decompress-lowmem
+@opindex bzip2-decompress-lowmem
 Use a different decompression method for BZIP2 compressed files. This
 alternate method uses a bit more than half the memory, but also runs
 at half the speed. This is useful under extreme low memory
@@ -1280,6 +1353,7 @@ platforms.
 
 @item --ask-cert-level
 @itemx --no-ask-cert-level
+@opindex ask-cert-level
 When making a key signature, prompt for a certification level. If this
 option is not specified, the certification level used is set via
 @option{--default-cert-level}. See @option{--default-cert-level} for
@@ -1288,6 +1362,7 @@ used. @option{--no-ask-cert-level} disables this option. This option
 defaults to no.
 
 @item --default-cert-level @code{n}
+@opindex default-cert-level
 The default to use for the check level when signing a key.
 
 0 means you make no particular claim as to how carefully you verified
@@ -1299,7 +1374,7 @@ useful for a "persona" verification, where you sign the key of a
 pseudonymous user.
 
 2 means you did casual verification of the key. For example, this
-could mean that you verified that the key fingerprint and checked the
+could mean that you verified the key fingerprint and checked the
 user ID on the key against a photo ID.
 
 3 means you did extensive verification of the key. For example, this
@@ -1317,12 +1392,14 @@ and "extensive" mean to you.
 This option defaults to 0 (no particular claim).
 
 @item --min-cert-level
+@opindex min-cert-level
 When building the trust database, treat any signatures with a
 certification level below this as invalid. Defaults to 2, which
 disregards level 1 signatures. Note that level 0 "no particular
 claim" signatures are always accepted.
 
 @item --trusted-key @code{long key ID}
+@opindex trusted-key
 Assume that the specified key (which must be given
 as a full 8 byte key ID) is as trustworthy as one of
 your own secret keys. This option is useful if you
@@ -1331,37 +1408,46 @@ online but still want to be able to check the validity of a given
 recipient's or signator's key.
 
 @item --trust-model @code{pgp|classic|direct|always|auto}
+@opindex trust-model
 Set what trust model GnuPG should follow. The models are:
 
 @table @asis
 
-@item pgp
-This is the Web of Trust combined with trust signatures as used in PGP
-5.x and later. This is the default trust model when creating a new
-trust database.
-
-@item classic
-This is the standard Web of Trust as used in PGP 2.x and earlier.
-
-@item direct
-Key validity is set directly by the user and not calculated via the
-Web of Trust.
-
-@item always
-Skip key validation and assume that used keys are always fully
-trusted. You generally won't use this unless you are using some
-external validation scheme. This option also suppresses the
-"[uncertain]" tag printed with signature checks when there is no
-evidence that the user ID is bound to the key.
-
-@item auto
-Select the trust model depending on whatever the internal trust
-database says. This is the default model if such a database already
-exists.
+  @item pgp
+  @opindex trust-mode:pgp
+  This is the Web of Trust combined with trust signatures as used in PGP
+  5.x and later. This is the default trust model when creating a new
+  trust database.
+
+  @item classic
+  @opindex trust-mode:classic
+  This is the standard Web of Trust as introduced by PGP 2.
+
+  @item direct
+  @opindex trust-mode:direct
+  Key validity is set directly by the user and not calculated via the
+  Web of Trust.
+
+  @item always
+  @opindex trust-mode:always
+  Skip key validation and assume that used keys are always fully
+  valid. You generally won't use this unless you are using some
+  external validation scheme. This option also suppresses the
+  "[uncertain]" tag printed with signature checks when there is no
+  evidence that the user ID is bound to the key.  Note that this
+  trust model still does not allow the use of expired, revoked, or
+  disabled keys.
+
+  @item auto
+  @opindex trust-mode:auto
+  Select the trust model depending on whatever the internal trust
+  database says. This is the default model if such a database already
+  exists.
 @end table
 
 @item --auto-key-locate @code{parameters}
 @itemx --no-auto-key-locate
+@opindex auto-key-locate
 GnuPG can automatically locate and retrieve keys as needed using this
 option. This happens when encrypting to an email address (in the
 "user@@example.com" form), and there are no user@@example.com keys on
@@ -1370,46 +1456,53 @@ mechanisms, in the order they are to be tried:
 
 @table @asis
 
-@item cert
-Locate a key using DNS CERT, as specified in rfc4398.
+  @item cert
+  Locate a key using DNS CERT, as specified in rfc4398.
 
-@item pka
-Locate a key using DNS PKA.
+  @item pka
+  Locate a key using DNS PKA.
 
-@item ldap
-Using DNS Service Discovery, check the domain in question for any LDAP
-keyservers to use.  If this fails, attempt to locate the key using the
-PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
+  @item ldap
+  Using DNS Service Discovery, check the domain in question for any LDAP
+  keyservers to use.  If this fails, attempt to locate the key using the
+  PGP Universal method of checking @samp{ldap://keys.(thedomain)}.
 
-@item keyserver
-Locate a key using whatever keyserver is defined using the
-@option{--keyserver} option.
+  @item keyserver
+  Locate a key using whatever keyserver is defined using the
+  @option{--keyserver} option.
 
-@item keyserver-URL
-In addition, a keyserver URL as used in the @option{--keyserver} option
-may be used here to query that particular keyserver.
+  @item keyserver-URL
+  In addition, a keyserver URL as used in the @option{--keyserver} option
+  may be used here to query that particular keyserver.
 
-@item local
-Locate the key using the local keyrings.  This mechanism allows to
-select the order a local key lookup is done.  Thus using
-@samp{--auto-key-locate local} is identical to
-@option{--no-auto-key-locate}.
+  @item local
+  Locate the key using the local keyrings.  This mechanism allows to
+  select the order a local key lookup is done.  Thus using
+  @samp{--auto-key-locate local} is identical to
+  @option{--no-auto-key-locate}.
 
-@item nodefault
-This flag disables the standard local key lookup, done before any of the
-mechanisms defined by the @option{--auto-key-locate} are tried.  The
-position of this mechanism in the list does not matter.  It is not
-required if @code{local} is also used.
+  @item nodefault
+  This flag disables the standard local key lookup, done before any of the
+  mechanisms defined by the @option{--auto-key-locate} are tried.  The
+  position of this mechanism in the list does not matter.  It is not
+  required if @code{local} is also used.
+
+  @item clear
+  Clear all defined mechanisms.  This is useful to override
+  mechanisms given in a config file.
 
 @end table
 
 @item --keyid-format @code{short|0xshort|long|0xlong}
+@opindex keyid-format
 Select how to display key IDs. "short" is the traditional 8-character
 key ID. "long" is the more accurate (but less convenient)
 16-character key ID. Add an "0x" to either to include an "0x" at the
-beginning of the key ID, as in 0x99242560.
+beginning of the key ID, as in 0x99242560.  Note that this option is
+ignored if the option --with-colons is used.
 
 @item --keyserver @code{name}
+@opindex keyserver
 Use @code{name} as your keyserver. This is the server that
 @option{--recv-keys}, @option{--send-keys}, and @option{--search-keys}
 will communicate with to receive keys from, send keys to, and search for
@@ -1428,7 +1521,8 @@ need to send keys to more than one server. The keyserver
 @code{hkp://keys.gnupg.net} uses round robin DNS to give a different
 keyserver each time you use it.
 
-@item --keyserver-options @code{name=value1 }
+@item --keyserver-options @code{name=value}
+@opindex keyserver-options
 This is a space or comma delimited string that gives options for the
 keyserver. Options can be prefixed with a `no-' to give the opposite
 meaning. Valid import-options or export-options may be used here as
@@ -1438,121 +1532,96 @@ are available for all keyserver types, some common options are:
 
 @table @asis
 
-@item include-revoked
-When searching for a key with @option{--search-keys}, include keys that
-are marked on the keyserver as revoked. Note that not all keyservers
-differentiate between revoked and unrevoked keys, and for such
-keyservers this option is meaningless. Note also that most keyservers do
-not have cryptographic verification of key revocations, and so turning
-this option off may result in skipping keys that are incorrectly marked
-as revoked.
-
-@item include-disabled
-When searching for a key with @option{--search-keys}, include keys that
-are marked on the keyserver as disabled. Note that this option is not
-used with HKP keyservers.
-
-@item auto-key-retrieve
-This option enables the automatic retrieving of keys from a keyserver
-when verifying signatures made by keys that are not on the local
-keyring.
-
-Note that this option makes a "web bug" like behavior possible.
-Keyserver operators can see which keys you request, so by sending you
-a message signed by a brand new key (which you naturally will not have
-on your local keyring), the operator can tell both your IP address and
-the time when you verified the signature.
-
-@item honor-keyserver-url
-When using @option{--refresh-keys}, if the key in question has a preferred
-keyserver URL, then use that preferred keyserver to refresh the key
-from. In addition, if auto-key-retrieve is set, and the signature
-being verified has a preferred keyserver URL, then use that preferred
-keyserver to fetch the key from. Defaults to yes.
-
-@item honor-pka-record
-If auto-key-retrieve is set, and the signature being verified has a
-PKA record, then use the PKA information to fetch the key. Defaults
-to yes.
-
-@item include-subkeys
-When receiving a key, include subkeys as potential targets. Note that
-this option is not used with HKP keyservers, as they do not support
-retrieving keys by subkey id.
-
-@item use-temp-files
-On most Unix-like platforms, GnuPG communicates with the keyserver
-helper program via pipes, which is the most efficient method. This
-option forces GnuPG to use temporary files to communicate. On some
-platforms (such as Win32 and RISC OS), this option is always enabled.
-
-@item keep-temp-files
-If using `use-temp-files', do not delete the temp files after using
-them. This option is useful to learn the keyserver communication
-protocol by reading the temporary files.
-
-@item verbose
-Tell the keyserver helper program to be more verbose. This option can
-be repeated multiple times to increase the verbosity level.
-
-@item timeout
-Tell the keyserver helper program how long (in seconds) to try and
-perform a keyserver action before giving up. Note that performing
-multiple actions at the same time uses this timeout value per action.
-For example, when retrieving multiple keys via @option{--recv-keys}, the
-timeout applies separately to each key retrieval, and not to the
-@option{--recv-keys} command as a whole. Defaults to 30 seconds.
-
-@item http-proxy=@code{value}
-Set the proxy to use for HTTP and HKP keyservers.  This overrides the
-"http_proxy" environment variable, if any.
-
-@item max-cert-size
-When retrieving a key via DNS CERT, only accept keys up to this size.
-Defaults to 16384 bytes.
-
-@item debug
-Turn on debug output in the keyserver helper program.  Note that the
-details of debug output depends on which keyserver helper program is
-being used, and in turn, on any libraries that the keyserver helper
-program uses internally (libcurl, openldap, etc).
-
-@item check-cert
-Enable certificate checking if the keyserver presents one (for hkps or
-ldaps).  Defaults to on.
-
-@item ca-cert-file
-Provide a certificate store to override the system default.  Only
-necessary if check-cert is enabled, and the keyserver is using a
-certificate that is not present in a system default certificate list.
-
-Note that depending on the SSL library that the keyserver helper is
-built with, this may actually be a directory or a file.
+  @item include-revoked
+  When searching for a key with @option{--search-keys}, include keys that
+  are marked on the keyserver as revoked. Note that not all keyservers
+  differentiate between revoked and unrevoked keys, and for such
+  keyservers this option is meaningless. Note also that most keyservers do
+  not have cryptographic verification of key revocations, and so turning
+  this option off may result in skipping keys that are incorrectly marked
+  as revoked.
+
+  @item include-disabled
+  When searching for a key with @option{--search-keys}, include keys that
+  are marked on the keyserver as disabled. Note that this option is not
+  used with HKP keyservers.
+
+  @item auto-key-retrieve
+  This option enables the automatic retrieving of keys from a keyserver
+  when verifying signatures made by keys that are not on the local
+  keyring.
+
+  Note that this option makes a "web bug" like behavior possible.
+  Keyserver operators can see which keys you request, so by sending you
+  a message signed by a brand new key (which you naturally will not have
+  on your local keyring), the operator can tell both your IP address and
+  the time when you verified the signature.
+
+  @item honor-keyserver-url
+  When using @option{--refresh-keys}, if the key in question has a preferred
+  keyserver URL, then use that preferred keyserver to refresh the key
+  from. In addition, if auto-key-retrieve is set, and the signature
+  being verified has a preferred keyserver URL, then use that preferred
+  keyserver to fetch the key from. Note that this option introduces a
+  "web bug": The creator of the key can see when the keys is
+  refreshed.  Thus this option is not enabled by default.
+
+  @item honor-pka-record
+  If auto-key-retrieve is set, and the signature being verified has a
+  PKA record, then use the PKA information to fetch the key. Defaults
+  to "yes".
+
+  @item include-subkeys
+  When receiving a key, include subkeys as potential targets. Note that
+  this option is not used with HKP keyservers, as they do not support
+  retrieving keys by subkey id.
+
+  @item timeout
+  Tell the keyserver helper program how long (in seconds) to try and
+  perform a keyserver action before giving up. Note that performing
+  multiple actions at the same time uses this timeout value per action.
+  For example, when retrieving multiple keys via @option{--recv-keys}, the
+  timeout applies separately to each key retrieval, and not to the
+  @option{--recv-keys} command as a whole. Defaults to 30 seconds.
+
+  @item http-proxy=@code{value}
+  Set the proxy to use for HTTP and HKP keyservers.
+  This overrides any proxy defined in @file{dirmngr.conf}.
+
+  @item verbose
+  This option has no more function since GnuPG 2.1.  Use the
+  @code{dirmngr} configuration options instead.
+
+  @item debug
+  This option has no more function since GnuPG 2.1.  Use the
+  @code{dirmngr} configuration options instead.
+
+  @item check-cert
+  This option has no more function since GnuPG 2.1.  Use the
+  @code{dirmngr} configuration options instead.
+
+  @item ca-cert-file
+  This option has no more function since GnuPG 2.1.  Use the
+  @code{dirmngr} configuration options instead.
+
 @end table
 
 @item --completes-needed @code{n}
+@opindex compliant-needed
 Number of completely trusted users to introduce a new
 key signer (defaults to 1).
 
 @item --marginals-needed @code{n}
+@opindex marginals-needed
 Number of marginally trusted users to introduce a new
 key signer (defaults to 3)
 
 @item --max-cert-depth @code{n}
+@opindex max-cert-depth
 Maximum depth of a certification chain (default is 5).
 
-@item --simple-sk-checksum
-Secret keys are integrity protected by using a SHA-1 checksum. This
-method is part of the upcoming enhanced OpenPGP specification but
-GnuPG already uses it as a countermeasure against certain attacks.
-Old applications don't understand this new format, so this option may
-be used to switch back to the old behaviour. Using this option bears
-a security risk. Note that using this option only takes effect when
-the secret key is encrypted - the simplest way to make this happen is
-to change the passphrase on the key (even changing it to the same
-value is acceptable).
-
 @item --no-sig-cache
+@opindex no-sig-cache
 Do not cache the verification status of key signatures.
 Caching gives a much better performance in key listings. However, if
 you suspect that your public keyring is not save against write
@@ -1561,6 +1630,7 @@ probably does not make sense to disable it because all kind of damage
 can be done if someone else has write access to your public keyring.
 
 @item --no-sig-create-check
+@opindex no-sig-create-check
 GnuPG normally verifies each signature right after creation to protect
 against bugs and hardware malfunctions which could leak out bits from
 the secret key. This extra verification needs some time (about 115%
@@ -1570,6 +1640,7 @@ interaction, this performance penalty does not matter in most settings.
 
 @item --auto-check-trustdb
 @itemx --no-auto-check-trustdb
+@opindex auto-check-trustdb
 If GnuPG feels that its information about the Web of Trust has to be
 updated, it automatically runs the @option{--check-trustdb} command
 internally.  This may be a time consuming
@@ -1577,37 +1648,51 @@ process. @option{--no-auto-check-trustdb} disables this option.
 
 @item --use-agent
 @itemx --no-use-agent
-@ifclear gpgone
+@opindex use-agent
 This is dummy option. @command{@gpgname} always requires the agent.
-@end ifclear
-@ifset gpgone
-Try to use the GnuPG-Agent.  With this option, GnuPG first tries to
-connect to the agent before it asks for a
-passphrase. @option{--no-use-agent} disables this option.
-@end ifset
 
 @item --gpg-agent-info
-@ifclear gpgone
+@opindex gpg-agent-info
 This is dummy option. It has no effect when used with @command{gpg2}.
-@end ifclear
-@ifset gpgone
-Override the value of the environment variable
-@samp{GPG_AGENT_INFO}. This is only used when @option{--use-agent} has
-been given.  Given that this option is not anymore used by
-@command{gpg2}, it should be avoided if possible.
-@end ifset
+
+
+@item --agent-program @var{file}
+@opindex agent-program
+Specify an agent program to be used for secret key operations.  The
+default value is determined by running @command{gpgconf} with the
+option @option{--list-dirs}.  Note that the pipe symbol (@code{|}) is
+used for a regression test suite hack and may thus not be used in the
+file name.
+
+@item --dirmngr-program @var{file}
+@opindex dirmngr-program
+Specify a dirmngr program to be used for keyserver access.  The
+default value is @file{@value{BINDIR}/dirmngr}.  This is only used as a
+fallback when the environment variable @code{DIRMNGR_INFO} is not set or
+a running dirmngr cannot be connected.
+
+@item --no-autostart
+@opindex no-autostart
+Do not start the gpg-agent or the dirmngr if it has not yet been
+started and its service is required.  This option is mostly useful on
+machines where the connection to gpg-agent has been redirected to
+another machines.  If dirmngr is required on the remote machine, it
+may be started manually using @command{gpgconf --launch dirmngr}.
 
 @item --lock-once
+@opindex lock-once
 Lock the databases the first time a lock is requested
 and do not release the lock until the process
 terminates.
 
 @item --lock-multiple
+@opindex lock-multiple
 Release the locks every time a lock is no longer
 needed. Use this to override a previous @option{--lock-once}
 from a config file.
 
 @item --lock-never
+@opindex lock-never
 Disable locking entirely. This option should be used only in very
 special environments, where it can be assured that only one process
 is accessing those files. A bootable floppy with a stand-alone
@@ -1615,6 +1700,7 @@ encryption system will probably use this. Improper usage of this
 option may lead to data and key corruption.
 
 @item --exit-on-status-write-error
+@opindex exit-on-status-write-error
 This option will cause write errors on the status FD to immediately
 terminate the process. That should in fact be the default but it never
 worked this way and thus we need an option to enable this, so that the
@@ -1624,6 +1710,7 @@ connected pipe too early. Using this option along with
 running gpg operations.
 
 @item --limit-card-insert-tries @code{n}
+@opindex limit-card-insert-tries
 With @code{n} greater than 0 the number of prompts asking to insert a
 smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
 all ask to insert a card if none has been inserted at startup. This
@@ -1632,18 +1719,22 @@ not know about the smartcard support and waits ad infinitum for an
 inserted card.
 
 @item --no-random-seed-file
+@opindex no-random-seed-file
 GnuPG uses a file to store its internal random pool over invocations.
 This makes random generation faster; however sometimes write operations
 are not desired. This option can be used to achieve that with the cost of
 slower random generation.
 
 @item --no-greeting
+@opindex no-greeting
 Suppress the initial copyright message.
 
 @item --no-secmem-warning
+@opindex no-secmem-warning
 Suppress the warning about "using insecure memory".
 
 @item --no-permission-warning
+@opindex permission-warning
 Suppress the warning about unsafe file and home directory (@option{--homedir})
 permissions. Note that the permission checks that GnuPG performs are
 not intended to be authoritative, but rather they simply warn about
@@ -1657,16 +1748,19 @@ warnings about itself. The @option{--homedir} permissions warning may only be
 suppressed on the command line.
 
 @item --no-mdc-warning
+@opindex no-mdc-warning
 Suppress the warning about missing MDC integrity protection.
 
 @item --require-secmem
 @itemx --no-require-secmem
+@opindex require-secmem
 Refuse to run if GnuPG cannot get secure memory. Defaults to no
 (i.e. run, but give a warning).
 
 
 @item --require-cross-certification
 @itemx --no-require-cross-certification
+@opindex require-cross-certification
 When verifying a signature made from a subkey, ensure that the cross
 certification "back signature" on the subkey is present and valid.  This
 protects against a subtle attack against subkeys that can sign.
@@ -1675,6 +1769,7 @@ Defaults to @option{--require-cross-certification} for
 
 @item --expert
 @itemx --no-expert
+@opindex expert
 Allow the user to do certain nonsensical or "silly" things like
 signing an expired or revoked key, or certain potentially incompatible
 things like generating unusual key types. This also disables certain
@@ -1683,9 +1778,6 @@ implies, this option is for experts only. If you don't fully
 understand the implications of what it allows you to do, leave this
 off. @option{--no-expert} disables this option.
 
-
-
-
 @end table
 
 
@@ -1714,6 +1806,7 @@ limited countermeasure against traffic analysis. If this option or
 @option{--default-recipient} is given.
 
 @item --encrypt-to @code{name}
+@opindex encrypt-to
 Same as @option{--recipient} but this one is intended for use in the
 options file and may be used with your own user-id as an
 "encrypt-to-self". These keys are only used when there are other
@@ -1722,6 +1815,7 @@ user id.  No trust checking is performed for these user ids and even
 disabled keys can be used.
 
 @item --hidden-encrypt-to @code{name}
+@opindex hidden-encrypt-to
 Same as @option{--hidden-recipient} but this one is intended for use in the
 options file and may be used with your own user-id as a hidden
 "encrypt-to-self". These keys are only used when there are other
@@ -1730,10 +1824,12 @@ No trust checking is performed for these user ids and even disabled
 keys can be used.
 
 @item --no-encrypt-to
+@opindex no-encrypt-to
 Disable the use of all @option{--encrypt-to} and
 @option{--hidden-encrypt-to} keys.
 
 @item --group @code{name=value1 }
+@opindex group
 Sets up a named group, which is similar to aliases in email programs.
 Any time the group name is a recipient (@option{-r} or
 @option{--recipient}), it will be expanded to the values
@@ -1749,9 +1845,11 @@ this option to prevent the shell from treating it as multiple
 arguments.
 
 @item --ungroup @code{name}
+@opindex ungroup
 Remove a given entry from the @option{--group} list.
 
 @item --no-groups
+@opindex no-groups
 Remove all entries from the @option{--group} list.
 
 @item --local-user @var{name}
@@ -1760,13 +1858,25 @@ Remove all entries from the @option{--group} list.
 Use @var{name} as the key to sign with. Note that this option overrides
 @option{--default-key}.
 
+@item --try-secret-key @var{name}
+@opindex try-secret-key
+For hidden recipients GPG needs to know the keys to use for trial
+decryption.  The key set with @option{--default-key} is always tried
+first, but this is often not sufficient.  This option allows to set more
+keys to be used for trial decryption.  Although any valid user-id
+specification may be used for @var{name} it makes sense to use at least
+the long keyid to avoid ambiguities.  Note that gpg-agent might pop up a
+pinentry for a lot keys to do the trial decryption.  If you want to stop
+all further trial decryption you may use close-window button instead of
+the cancel button.
+
 @item --try-all-secrets
 @opindex try-all-secrets
 Don't look at the key ID as stored in the message but try all secret
 keys in turn to find the right decryption key. This option forces the
 behaviour as used by anonymous recipients (created by using
-@option{--throw-keyids}) and might come handy in case where an encrypted
-message contains a bogus key ID.
+@option{--throw-keyids} or @option{--hidden-recipient}) and might come
+handy in case where an encrypted message contains a bogus key ID.
 
 @item --skip-hidden-recipients
 @itemx --no-skip-hidden-recipients
@@ -1776,7 +1886,7 @@ During decryption skip all anonymous recipients.  This option helps in
 the case that people use the hidden recipients feature to hide there
 own encrypt-to key from others.  If oneself has many secret keys this
 may lead to a major annoyance because all keys are tried in turn to
-decrypt soemthing which was not really intended for it.  The drawback
+decrypt something which was not really intended for it.  The drawback
 of this option is that it is currently not possible to decrypt a
 message which includes real anonymous recipients.
 
@@ -1798,6 +1908,7 @@ Create ASCII armored output.  The default is to create the binary
 OpenPGP format.
 
 @item --no-armor
+@opindex no-armor
 Assume the input data is not in ASCII armored format.
 
 @item --output @var{file}
@@ -1816,85 +1927,100 @@ maximum file size that will be generated before processing is forced to
 stop by the OS limits. Defaults to 0, which means "no limit".
 
 @item --import-options @code{parameters}
+@opindex import-options
 This is a space or comma delimited string that gives options for
 importing keys. Options can be prepended with a `no-' to give the
 opposite meaning. The options are:
 
 @table @asis
 
-@item import-local-sigs
-Allow importing key signatures marked as "local". This is not
-generally useful unless a shared keyring scheme is being used.
-Defaults to no.
-
-@item repair-pks-subkey-bug
-During import, attempt to repair the damage caused by the PKS keyserver
-bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
-that this cannot completely repair the damaged key as some crucial data
-is removed by the keyserver, but it does at least give you back one
-subkey. Defaults to no for regular @option{--import} and to yes for
-keyserver @option{--recv-keys}.
-
-@item merge-only
-During import, allow key updates to existing keys, but do not allow
-any new keys to be imported. Defaults to no.
-
-@item import-clean
-After import, compact (remove all signatures except the
-self-signature) any user IDs from the new key that are not usable.
-Then, remove any signatures from the new key that are not usable.
-This includes signatures that were issued by keys that are not present
-on the keyring. This option is the same as running the @option{--edit-key}
-command "clean" after import. Defaults to no.
-
-@item import-minimal
-Import the smallest key possible. This removes all signatures except
-the most recent self-signature on each user ID. This option is the
-same as running the @option{--edit-key} command "minimize" after import.
-Defaults to no.
+  @item import-local-sigs
+  Allow importing key signatures marked as "local". This is not
+  generally useful unless a shared keyring scheme is being used.
+  Defaults to no.
+
+  @item keep-ownertrust
+  Normally possible still existing ownertrust values of a key are
+  cleared if a key is imported.  This is in general desirable so that
+  a formerly deleted key does not automatically gain an ownertrust
+  values merely due to import.  On the other hand it is sometimes
+  necessary to re-import a trusted set of keys again but keeping
+  already assigned ownertrust values.  This can be achived by using
+  this option.
+
+  @item repair-pks-subkey-bug
+  During import, attempt to repair the damage caused by the PKS keyserver
+  bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
+  that this cannot completely repair the damaged key as some crucial data
+  is removed by the keyserver, but it does at least give you back one
+  subkey. Defaults to no for regular @option{--import} and to yes for
+  keyserver @option{--recv-keys}.
+
+  @item merge-only
+  During import, allow key updates to existing keys, but do not allow
+  any new keys to be imported. Defaults to no.
+
+  @item import-clean
+  After import, compact (remove all signatures except the
+  self-signature) any user IDs from the new key that are not usable.
+  Then, remove any signatures from the new key that are not usable.
+  This includes signatures that were issued by keys that are not present
+  on the keyring. This option is the same as running the @option{--edit-key}
+  command "clean" after import. Defaults to no.
+
+  @item import-minimal
+  Import the smallest key possible. This removes all signatures except
+  the most recent self-signature on each user ID. This option is the
+  same as running the @option{--edit-key} command "minimize" after import.
+  Defaults to no.
 @end table
 
 @item --export-options @code{parameters}
+@opindex export-options
 This is a space or comma delimited string that gives options for
 exporting keys. Options can be prepended with a `no-' to give the
 opposite meaning. The options are:
 
 @table @asis
 
-@item export-local-sigs
-Allow exporting key signatures marked as "local". This is not
-generally useful unless a shared keyring scheme is being used.
-Defaults to no.
-
-@item export-attributes
-Include attribute user IDs (photo IDs) while exporting. This is
-useful to export keys if they are going to be used by an OpenPGP
-program that does not accept attribute user IDs. Defaults to yes.
-
-@item export-sensitive-revkeys
-Include designated revoker information that was marked as
-"sensitive". Defaults to no.
-
-@item export-reset-subkey-passwd
-When using the @option{--export-secret-subkeys} command, this option resets
-the passphrases for all exported subkeys to empty. This is useful
-when the exported subkey is to be used on an unattended machine where
-a passphrase doesn't necessarily make sense. Defaults to no.
-
-@item export-clean
-Compact (remove all signatures from) user IDs on the key being
-exported if the user IDs are not usable. Also, do not export any
-signatures that are not usable. This includes signatures that were
-issued by keys that are not present on the keyring. This option is
-the same as running the @option{--edit-key} command "clean" before export
-except that the local copy of the key is not modified. Defaults to
-no.
-
-@item export-minimal
-Export the smallest key possible. This removes all signatures except the
-most recent self-signature on each user ID. This option is the same as
-running the @option{--edit-key} command "minimize" before export except
-that the local copy of the key is not modified. Defaults to no.
+  @item export-local-sigs
+  Allow exporting key signatures marked as "local". This is not
+  generally useful unless a shared keyring scheme is being used.
+  Defaults to no.
+
+  @item export-attributes
+  Include attribute user IDs (photo IDs) while exporting. This is
+  useful to export keys if they are going to be used by an OpenPGP
+  program that does not accept attribute user IDs. Defaults to yes.
+
+  @item export-sensitive-revkeys
+  Include designated revoker information that was marked as
+  "sensitive". Defaults to no.
+
+  @c Since GnuPG 2.1 gpg-agent manages the secret key and thus the
+  @c export-reset-subkey-passwd hack is not anymore justified.  Such use
+  @c cases may be implemented using a specialized secret key export
+  @c tool.
+  @c @item export-reset-subkey-passwd
+  @c When using the @option{--export-secret-subkeys} command, this option resets
+  @c the passphrases for all exported subkeys to empty. This is useful
+  @c when the exported subkey is to be used on an unattended machine where
+  @c a passphrase doesn't necessarily make sense. Defaults to no.
+
+  @item export-clean
+  Compact (remove all signatures from) user IDs on the key being
+  exported if the user IDs are not usable. Also, do not export any
+  signatures that are not usable. This includes signatures that were
+  issued by keys that are not present on the keyring. This option is
+  the same as running the @option{--edit-key} command "clean" before export
+  except that the local copy of the key is not modified. Defaults to
+  no.
+
+  @item export-minimal
+  Export the smallest key possible. This removes all signatures except the
+  most recent self-signature on each user ID. This option is the same as
+  running the @option{--edit-key} command "minimize" before export except
+  that the local copy of the key is not modified. Defaults to no.
 @end table
 
 @item --with-colons
@@ -1906,20 +2032,44 @@ as it is easily machine parsed. The details of this format are
 documented in the file @file{doc/DETAILS}, which is included in the GnuPG
 source distribution.
 
+
+@item --print-pka-records
+@opindex print-pka-records
+Modify the output of the list commands to print PKA records suitable
+to put into DNS zone files.  An ORIGIN line is printed before each
+record to allow diverting the records to the corresponding zone file.
+
 @item --fixed-list-mode
 @opindex fixed-list-mode
 Do not merge primary user ID and primary key in @option{--with-colon}
 listing mode and print all timestamps as seconds since 1970-01-01.
-@ifclear gpgone
 Since GnuPG 2.0.10, this mode is always used and thus this option is
 obsolete; it does not harm to use it though.
-@end ifclear
+
+@item --legacy-list-mode
+@opindex legacy-list-mode
+Revert to the pre-2.1 public key list mode.  This only affects the
+human readable output and not the machine interface
+(i.e. @code{--with-colons}).  Note that the legacy format does not
+allow to convey suitable information for elliptic curves.
 
 @item --with-fingerprint
 @opindex with-fingerprint
 Same as the command @option{--fingerprint} but changes only the format
 of the output and may be used together with another command.
 
+@item --with-icao-spelling
+@opindex with-icao-spelling
+Print the ICAO spelling of the fingerprint in addition to the hex digits.
+
+@item --with-keygrip
+@opindex with-keygrip
+Include the keygrip in the key listings.
+
+@item --with-secret
+@opindex with-secret
+Include info about the presence of a secret key in public key listings
+done with @code{--with-colons}.
 
 @end table
 
@@ -1933,6 +2083,7 @@ of the output and may be used together with another command.
 
 @item -t, --textmode
 @itemx --no-textmode
+@opindex textmode
 Treat input files as text and store them in the OpenPGP canonical text
 form with standard "CRLF" line endings. This also sets the necessary
 flags to inform the recipient that the encrypted or signed data is text
@@ -1942,42 +2093,27 @@ platforms that have different line ending conventions (UNIX-like to Mac,
 Mac to Windows, etc). @option{--no-textmode} disables this option, and
 is the default.
 
-@ifset gpgone
-If @option{-t} (but not @option{--textmode}) is used together with
-armoring and signing, this enables clearsigned messages. This kludge is
-needed for command-line compatibility with command-line versions of PGP;
-normally you would use @option{--sign} or @option{--clearsign} to select
-the type of the signature.
-@end ifset
-
 @item --force-v3-sigs
 @itemx --no-force-v3-sigs
-OpenPGP states that an implementation should generate v4 signatures
-but PGP versions 5 through 7 only recognize v4 signatures on key
-material. This option forces v3 signatures for signatures on data.
-Note that this option implies @option{--ask-sig-expire},
-@option{--sig-policy-url}, @option{--sig-notation}, and
-@option{--sig-keyserver-url}, as these features cannot be used with v3
-signatures.  @option{--no-force-v3-sigs} disables this option.
-
 @item --force-v4-certs
 @itemx --no-force-v4-certs
-Always use v4 key signatures even on v3 keys. This option also
-changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
-@option{--no-force-v4-certs} disables this option.
+These options are obsolete and have no effect since GnuPG 2.1.
 
 @item --force-mdc
+@opindex force-mdc
 Force the use of encryption with a modification detection code. This
 is always used with the newer ciphers (those with a blocksize greater
 than 64 bits), or if all of the recipient keys indicate MDC support in
 their feature flags.
 
 @item --disable-mdc
+@opindex disable-mdc
 Disable the use of the modification detection code. Note that by
 using this option, the encrypted message becomes vulnerable to a
 message modification attack.
 
 @item --personal-cipher-preferences @code{string}
+@opindex personal-cipher-preferences
 Set the list of personal cipher preferences to @code{string}.  Use
 @command{@gpgname --version} to get a list of available algorithms,
 and use @code{none} to set no preference at all.  This allows the user
@@ -1987,6 +2123,7 @@ all recipients.  The most highly ranked cipher in this list is also
 used for the @option{--symmetric} encryption command.
 
 @item --personal-digest-preferences @code{string}
+@opindex personal-digest-preferences
 Set the list of personal digest preferences to @code{string}.  Use
 @command{@gpgname --version} to get a list of available algorithms,
 and use @code{none} to set no preference at all.  This allows the user
@@ -1994,10 +2131,10 @@ to safely override the algorithm chosen by the recipient key
 preferences, as GPG will only select an algorithm that is usable by
 all recipients.  The most highly ranked digest algorithm in this list
 is also used when signing without encryption
-(e.g. @option{--clearsign} or @option{--sign}). The default value is
-SHA-1.
+(e.g. @option{--clearsign} or @option{--sign}).
 
 @item --personal-compress-preferences @code{string}
+@opindex personal-compress-preferences
 Set the list of personal compression preferences to @code{string}.
 Use @command{@gpgname --version} to get a list of available
 algorithms, and use @code{none} to set no preference at all.  This
@@ -2008,29 +2145,34 @@ algorithm in this list is also used when there are no recipient keys
 to consider (e.g. @option{--symmetric}).
 
 @item --s2k-cipher-algo @code{name}
+@opindex s2k-cipher-algo
 Use @code{name} as the cipher algorithm used to protect secret keys.
-The default cipher is CAST5. This cipher is also used for
-conventional encryption if @option{--personal-cipher-preferences} and
-@option{--cipher-algo} is not given.
+The default cipher is @value{GPGSYMENCALGO}. This cipher is also used
+for symmetric encryption with a passphrase if
+@option{--personal-cipher-preferences} and @option{--cipher-algo} is
+not given.
 
 @item --s2k-digest-algo @code{name}
+@opindex s2k-digest-algo
 Use @code{name} as the digest algorithm used to mangle the passphrases.
 The default algorithm is SHA-1.
 
 @item --s2k-mode @code{n}
+@opindex s2k-mode
 Selects how passphrases are mangled. If @code{n} is 0 a plain
 passphrase (which is not recommended) will be used, a 1 adds a salt to
 the passphrase and a 3 (the default) iterates the whole process a
 number of times (see --s2k-count).  Unless @option{--rfc1991} is used,
-this mode is also used for conventional encryption.
+this mode is also used for symmetric encryption with a passphrase.
 
 @item --s2k-count @code{n}
+@opindex s2k-count
 Specify how many times the passphrase mangling is repeated.  This
-value may range between 1024 and 65011712 inclusive, and the default
-is 65536.  Note that not all values in the 1024-65011712 range are
-legal and if an illegal value is selected, GnuPG will round up to the
-nearest legal value.  This option is only meaningful if
-@option{--s2k-mode} is 3.
+value may range between 1024 and 65011712 inclusive.  The default is
+inquired from gpg-agent.  Note that not all values in the
+1024-65011712 range are legal and if an illegal value is selected,
+GnuPG will round up to the nearest legal value.  This option is only
+meaningful if @option{--s2k-mode} is 3.
 
 
 @end table
@@ -2038,6 +2180,7 @@ nearest legal value.  This option is only meaningful if
 @c ***************************
 @c ******* Compliance ********
 @c ***************************
+@node Compliance Options
 @subsection Compliance options
 
 These options control what GnuPG is compliant to. Only one of these
@@ -2075,9 +2218,11 @@ behavior. Note that this is currently the same thing as
 Reset all packet, cipher and digest options to strict RFC-2440
 behavior.
 
+@ifclear gpgtowone
 @item --rfc1991
 @opindex rfc1991
-Try to be more RFC-1991 (PGP 2.x) compliant.
+Try to be more RFC-1991 (PGP 2.x) compliant.  This option is
+deprecated will be removed in GnuPG 2.1.
 
 @item --pgp2
 @opindex pgp2
@@ -2087,10 +2232,17 @@ a message that PGP 2.x will not be able to handle. Note that `PGP
 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
 available, but the MIT release is a good common baseline.
 
-This option implies @option{--rfc1991 --disable-mdc
---no-force-v4-certs --escape-from-lines --force-v3-sigs --cipher-algo
-IDEA --digest-algo MD5 --compress-algo ZIP}. It also disables
-@option{--textmode} when encrypting.
+This option implies
+@option{--rfc1991 --disable-mdc --no-force-v4-certs
+ --escape-from-lines  --force-v3-sigs --allow-weak-digest-algos
+ --cipher-algo IDEA --digest-algo MD5 --compress-algo ZIP}.
+It also disables @option{--textmode} when encrypting.
+
+This option is deprecated will be removed in GnuPG 2.1.  The reason
+for dropping PGP-2 support is that the PGP 2 format is not anymore
+considered safe (for example due to the use of the broken MD5 algorithm).
+Note that the decryption of PGP-2 created messages will continue to work.
+@end ifclear
 
 @item --pgp6
 @opindex pgp6
@@ -2101,8 +2253,7 @@ compression algorithms none and ZIP. This also disables
 --throw-keyids, and making signatures with signing subkeys as PGP 6
 does not understand signatures made by signing subkeys.
 
-This option implies @option{--disable-mdc --escape-from-lines
---force-v3-sigs}.
+This option implies @option{--disable-mdc --escape-from-lines}.
 
 @item --pgp7
 @opindex pgp7
@@ -2136,6 +2287,7 @@ SHA224, SHA384, and SHA512 digests.
 Don't make any changes (this is not completely implemented).
 
 @item --list-only
+@opindex list-only
 Changes the behaviour of some commands. This is like @option{--dry-run} but
 different in some cases. The semantic of this command may be extended in
 the future. Currently it only skips the actual decryption pass and
@@ -2146,54 +2298,99 @@ therefore enables a fast listing of the encryption keys.
 @opindex interactive
 Prompt before overwriting any files.
 
+@item --debug-level @var{level}
+@opindex debug-level
+Select the debug level for investigating problems. @var{level} may be
+a numeric value or by a keyword:
+
+@table @code
+  @item none
+  No debugging at all.  A value of less than 1 may be used instead of
+  the keyword.
+  @item basic
+  Some basic debug messages.  A value between 1 and 2 may be used
+  instead of the keyword.
+  @item advanced
+  More verbose debug messages.  A value between 3 and 5 may be used
+  instead of the keyword.
+  @item expert
+  Even more detailed messages.  A value between 6 and 8 may be used
+  instead of the keyword.
+  @item guru
+  All of the debug messages you can get. A value greater than 8 may be
+  used instead of the keyword.  The creation of hash tracing files is
+  only enabled if the keyword is used.
+@end table
+
+How these messages are mapped to the actual debugging flags is not
+specified and may change with newer releases of this program. They are
+however carefully selected to best aid in debugging.
+
 @item --debug @var{flags}
 @opindex debug
-Set debugging flags. All flags are or-ed and @var{flags} may
-be given in C syntax (e.g. 0x0042).
+Set debugging flags. All flags are or-ed and @var{flags} may be given
+in C syntax (e.g. 0x0042) or as a comma separated list of flag names.
+To get a list of all supported flags the single word "help" can be
+used.
 
 @item --debug-all
+@opindex debug-all
 Set all useful debugging flags.
 
-@ifset gpgone
-@item --debug-ccid-driver
-Enable debug output from the included CCID driver for smartcards.
-Note that this option is only available on some system.
-@end ifset
+@item --debug-iolbf
+@opindex debug-iolbf
+Set stdout into line buffered mode.  This option is only honored when
+given on the command line.
+
+@item --faked-system-time @var{epoch}
+@opindex faked-system-time
+This option is only useful for testing; it sets the system time back or
+forth to @var{epoch} which is the number of seconds elapsed since the year
+1970.  Alternatively @var{epoch} may be given as a full ISO time string
+(e.g. "20070924T154812").
 
 @item --enable-progress-filter
+@opindex enable-progress-filter
 Enable certain PROGRESS status outputs. This option allows frontends
 to display a progress indicator while gpg is processing larger files.
 There is a slight performance overhead using it.
 
 @item --status-fd @code{n}
+@opindex status-fd
 Write special status strings to the file descriptor @code{n}.
 See the file DETAILS in the documentation for a listing of them.
 
 @item --status-file @code{file}
+@opindex status-file
 Same as @option{--status-fd}, except the status data is written to file
 @code{file}.
 
 @item --logger-fd @code{n}
+@opindex logger-fd
 Write log output to file descriptor @code{n} and not to STDERR.
 
 @item --log-file @code{file}
 @itemx --logger-file @code{file}
+@opindex log-file
 Same as @option{--logger-fd}, except the logger data is written to file
 @code{file}.  Note that @option{--log-file} is only implemented for
 GnuPG-2.
 
 @item --attribute-fd @code{n}
+@opindex attribute-fd
 Write attribute subpackets to the file descriptor @code{n}. This is most
 useful for use with @option{--status-fd}, since the status messages are
 needed to separate out the various subpackets from the stream delivered
 to the file descriptor.
 
 @item --attribute-file @code{file}
+@opindex attribute-file
 Same as @option{--attribute-fd}, except the attribute data is written to
 file @code{file}.
 
 @item --comment @code{string}
 @itemx --no-comments
+@opindex comment
 Use @code{string} as a comment string in clear text signatures and ASCII
 armored messages or keys (see @option{--armor}). The default behavior is
 not to use a comment string. @option{--comment} may be repeated multiple
@@ -2205,12 +2402,20 @@ protected by the signature.
 
 @item --emit-version
 @itemx --no-emit-version
-Force inclusion of the version string in ASCII armored output.
-@option{--no-emit-version} disables this option.
+@opindex emit-version
+Force inclusion of the version string in ASCII armored output.  If
+given once only the name of the program and the major number is
+emitted (default), given twice the minor is also emitted, given triple
+the micro is added, and given quad an operating system identification
+is also emitted.  @option{--no-emit-version} disables the version
+line.
 
 @item --sig-notation @code{name=value}
 @itemx --cert-notation @code{name=value}
 @itemx -N, --set-notation @code{name=value}
+@opindex sig-notation
+@opindex cert-notation
+@opindex set-notation
 Put the name value pair into the signature as notation data.
 @code{name} must consist only of printable characters or spaces, and
 must contain a '@@' character in the form keyname@@domain.example.com
@@ -2221,7 +2426,7 @@ check. @code{value} may be any printable string; it will be encoded in
 UTF8, so you should check that your @option{--display-charset} is set
 correctly. If you prefix @code{name} with an exclamation mark (!), the
 notation data will be flagged as critical
-(rfc2440:5.2.3.15). @option{--sig-notation} sets a notation for data
+(rfc4880:5.2.3.16). @option{--sig-notation} sets a notation for data
 signatures. @option{--cert-notation} sets a notation for key signatures
 (certifications). @option{--set-notation} sets both.
 
@@ -2240,7 +2445,10 @@ meaningful when using the OpenPGP smartcard.
 @item --sig-policy-url @code{string}
 @itemx --cert-policy-url @code{string}
 @itemx --set-policy-url @code{string}
-Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).  If
+@opindex sig-policy-url
+@opindex cert-policy-url
+@opindex set-policy-url
+Use @code{string} as a Policy URL for signatures (rfc4880:5.2.3.20).  If
 you prefix it with an exclamation mark (!), the policy URL packet will
 be flagged as critical. @option{--sig-policy-url} sets a policy url for
 data signatures. @option{--cert-policy-url} sets a policy url for key
@@ -2249,6 +2457,7 @@ signatures (certifications). @option{--set-policy-url} sets both.
 The same %-expandos used for notation data are available here as well.
 
 @item --sig-keyserver-url @code{string}
+@opindex sig-keyserver-url
 Use @code{string} as a preferred keyserver URL for data signatures. If
 you prefix it with an exclamation mark (!), the keyserver URL packet
 will be flagged as critical.
@@ -2256,12 +2465,14 @@ will be flagged as critical.
 The same %-expandos used for notation data are available here as well.
 
 @item --set-filename @code{string}
+@opindex set-filename
 Use @code{string} as the filename which is stored inside messages.
 This overrides the default, which is to use the actual filename of the
 file being encrypted.
 
 @item --for-your-eyes-only
 @itemx --no-for-your-eyes-only
+@opindex for-your-eyes-only
 Set the `for your eyes only' flag in the message. This causes GnuPG to
 refuse to save the file unless the @option{--output} option is given,
 and PGP to use a "secure viewer" with a claimed Tempest-resistant font
@@ -2270,10 +2481,12 @@ to display the message. This option overrides @option{--set-filename}.
 
 @item --use-embedded-filename
 @itemx --no-use-embedded-filename
+@opindex use-embedded-filename
 Try to create a file with a name as embedded in the data. This can be
 a dangerous option as it allows to overwrite files. Defaults to no.
 
 @item --cipher-algo @code{name}
+@opindex cipher-algo
 Use @code{name} as cipher algorithm. Running the program with the
 command @option{--version} yields a list of supported algorithms. If
 this is not used the cipher algorithm is selected from the preferences
@@ -2283,6 +2496,7 @@ it allows you to violate the OpenPGP standard.
 same thing.
 
 @item --digest-algo @code{name}
+@opindex digest-algo
 Use @code{name} as the message digest algorithm. Running the program
 with the command @option{--version} yields a list of supported algorithms. In
 general, you do not want to use this option as it allows you to
@@ -2290,6 +2504,7 @@ violate the OpenPGP standard. @option{--personal-digest-preferences} is the
 safe way to accomplish the same thing.
 
 @item --compress-algo @code{name}
+@opindex compress-algo
 Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB
 compression. "zip" is RFC-1951 ZIP compression which is used by PGP.
 "bzip2" is a more modern compression scheme that can compress some
@@ -2312,6 +2527,7 @@ violate the OpenPGP standard. @option{--personal-compress-preferences} is the
 safe way to accomplish the same thing.
 
 @item --cert-digest-algo @code{name}
+@opindex cert-digest-algo
 Use @code{name} as the message digest algorithm used when signing a
 key. Running the program with the command @option{--version} yields a
 list of supported algorithms. Be aware that if you choose an algorithm
@@ -2320,17 +2536,20 @@ users will not be able to use the key signatures you make, or quite
 possibly your entire key.
 
 @item --disable-cipher-algo @code{name}
+@opindex disable-cipher-algo
 Never allow the use of @code{name} as cipher algorithm.
 The given name will not be checked so that a later loaded algorithm
 will still get disabled.
 
 @item --disable-pubkey-algo @code{name}
+@opindex disable-pubkey-algo
 Never allow the use of @code{name} as public key algorithm.
 The given name will not be checked so that a later loaded algorithm
 will still get disabled.
 
 @item --throw-keyids
 @itemx --no-throw-keyids
+@opindex throw-keyids
 Do not put the recipient key IDs into encrypted messages. This helps to
 hide the receivers of the message and is a limited countermeasure
 against traffic analysis.@footnote{Using a little social engineering
@@ -2342,6 +2561,7 @@ is essentially the same as using @option{--hidden-recipient} for all
 recipients.
 
 @item --not-dash-escaped
+@opindex not-dash-escaped
 This option changes the behavior of cleartext signatures
 so that they can be used for patch files. You should not
 send such an armored file via email because all spaces
@@ -2352,6 +2572,7 @@ line tells GnuPG about this cleartext signature option.
 
 @item --escape-from-lines
 @itemx --no-escape-from-lines
+@opindex escape-from-lines
 Because some mailers change lines starting with "From " to ">From " it
 is good to handle such lines in a special way when creating cleartext
 signatures to prevent the mail system from breaking the signature. Note
@@ -2359,42 +2580,60 @@ that all other PGP versions do it this way too.  Enabled by
 default. @option{--no-escape-from-lines} disables this option.
 
 @item --passphrase-repeat @code{n}
+@opindex passphrase-repeat
 Specify how many times @command{@gpgname} will request a new
 passphrase be repeated.  This is useful for helping memorize a
 passphrase.  Defaults to 1 repetition.
 
 @item --passphrase-fd @code{n}
+@opindex passphrase-fd
 Read the passphrase from file descriptor @code{n}. Only the first line
 will be read from file descriptor @code{n}. If you use 0 for @code{n},
 the passphrase will be read from STDIN. This can only be used if only
 one passphrase is supplied.
-@ifclear gpgone
+
 Note that this passphrase is only used if the option @option{--batch}
-has also been given.  This is different from @command{gpg}.
-@end ifclear
+has also been given.  This is different from GnuPG version 1.x.
 
 @item --passphrase-file @code{file}
+@opindex passphrase-file
 Read the passphrase from file @code{file}. Only the first line will
 be read from file @code{file}. This can only be used if only one
 passphrase is supplied. Obviously, a passphrase stored in a file is
 of questionable security if other users can read this file. Don't use
 this option if you can avoid it.
-@ifclear gpgone
 Note that this passphrase is only used if the option @option{--batch}
-has also been given.  This is different from @command{gpg}.
-@end ifclear
+has also been given.  This is different from GnuPG version 1.x.
 
 @item --passphrase @code{string}
+@opindex passphrase
 Use @code{string} as the passphrase. This can only be used if only one
 passphrase is supplied. Obviously, this is of very questionable
 security on a multi-user system. Don't use this option if you can
 avoid it.
-@ifclear gpgone
 Note that this passphrase is only used if the option @option{--batch}
-has also been given.  This is different from @command{gpg}.
-@end ifclear
+has also been given.  This is different from GnuPG version 1.x.
+
+@item --pinentry-mode @code{mode}
+@opindex pinentry-mode
+Set the pinentry mode to @code{mode}.  Allowed values for @code{mode}
+are:
+@table @asis
+  @item default
+  Use the default of the agent, which is @code{ask}.
+  @item ask
+  Force the use of the Pinentry.
+  @item cancel
+  Emulate use of Pinentry's cancel button.
+  @item error
+  Return a Pinentry error (``No Pinentry'').
+  @item loopback
+  Redirect Pinentry queries to the caller.  Note that in contrast to
+  Pinentry the user is not prompted again if he enters a bad password.
+@end table
 
 @item --command-fd @code{n}
+@opindex command-fd
 This is a replacement for the deprecated shared-memory IPC mode.
 If this option is enabled, user input on questions is not expected
 from the TTY but from the given file descriptor. It should be used
@@ -2402,21 +2641,25 @@ together with @option{--status-fd}. See the file doc/DETAILS in the source
 distribution for details on how to use it.
 
 @item --command-file @code{file}
+@opindex command-file
 Same as @option{--command-fd}, except the commands are read out of file
 @code{file}
 
 @item --allow-non-selfsigned-uid
 @itemx --no-allow-non-selfsigned-uid
+@opindex allow-non-selfsigned-uid
 Allow the import and use of keys with user IDs which are not
 self-signed. This is not recommended, as a non self-signed user ID is
 trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
 
 @item --allow-freeform-uid
+@opindex allow-freeform-uid
 Disable all checks on the form of the user ID while generating a new
 one. This option should only be used in very special environments as
 it does not ensure the de-facto standard format of user IDs.
 
 @item --ignore-time-conflict
+@opindex ignore-time-conflict
 GnuPG normally checks that the timestamps associated with keys and
 signatures have plausible values. However, sometimes a signature
 seems to be older than the key due to clock problems. This option
@@ -2424,13 +2667,15 @@ makes these checks just a warning. See also @option{--ignore-valid-from} for
 timestamp issues on subkeys.
 
 @item --ignore-valid-from
+@opindex ignore-valid-from
 GnuPG normally does not select and use subkeys created in the future.
 This option allows the use of such keys and thus exhibits the
-pre-1.0.7 behaviour. You should not use this option unless you there
+pre-1.0.7 behaviour. You should not use this option unless there
 is some clock problem. See also @option{--ignore-time-conflict} for timestamp
 issues with signatures.
 
 @item --ignore-crc-error
+@opindex ignore-crc-error
 The ASCII armor used by OpenPGP is protected by a CRC checksum against
 transmission errors. Occasionally the CRC gets mangled somewhere on
 the transmission channel but the actual content (which is protected by
@@ -2438,13 +2683,21 @@ the OpenPGP protocol anyway) is still okay. This option allows GnuPG
 to ignore CRC errors.
 
 @item --ignore-mdc-error
+@opindex ignore-mdc-error
 This option changes a MDC integrity protection failure into a warning.
 This can be useful if a message is partially corrupt, but it is
 necessary to get as much data as possible out of the corrupt message.
 However, be aware that a MDC protection failure may also mean that the
 message was tampered with intentionally by an attacker.
 
+@item --allow-weak-digest-algos
+@opindex allow-weak-digest-algos
+Signatures made with the broken MD5 algorithm are normally rejected
+with an ``invalid digest algorithm'' message.  This option allows the
+verification of signatures made with such weak algorithms.
+
 @item --no-default-keyring
+@opindex no-default-keyring
 Do not add the default keyrings to the list of keyrings. Note that
 GnuPG will not operate without any keyrings, so if you use this option
 and do not provide alternate keyrings via @option{--keyring} or
@@ -2452,15 +2705,18 @@ and do not provide alternate keyrings via @option{--keyring} or
 secret keyrings.
 
 @item --skip-verify
+@opindex skip-verify
 Skip the signature verification step. This may be
 used to make the decryption faster if the signature
 verification is not needed.
 
 @item --with-key-data
+@opindex with-key-data
 Print key listings delimited by colons (like @option{--with-colons}) and
 print the public key data.
 
 @item --fast-list-mode
+@opindex fast-list-mode
 Changes the output of the list commands to work faster; this is achieved
 by leaving some parts empty. Some applications don't need the user ID
 and the trust information given in the listings. By using this options
@@ -2469,22 +2725,31 @@ change in future versions.  If you are missing some information, don't
 use this option.
 
 @item --no-literal
+@opindex no-literal
 This is not for normal use. Use the source to see for what it might be useful.
 
 @item --set-filesize
+@opindex set-filesize
 This is not for normal use. Use the source to see for what it might be useful.
 
 @item --show-session-key
+@opindex show-session-key
 Display the session key used for one message. See
 @option{--override-session-key} for the counterpart of this option.
 
 We think that Key Escrow is a Bad Thing; however the user should have
 the freedom to decide whether to go to prison or to reveal the content
 of one specific message without compromising all messages ever
-encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
-FORCED TO DO SO.
+encrypted for one secret key.
+
+You can also use this option if you receive an encrypted message which
+is abusive or offensive, to prove to the administrators of the
+messaging system that the ciphertext transmitted corresponds to an
+inappropriate plaintext so they can take action against the offending
+user.
 
 @item --override-session-key @code{string}
+@opindex override-session-key
 Don't use the public key but the session key @code{string}. The format
 of this string is the same as the one printed by
 @option{--show-session-key}. This option is normally not used but comes
@@ -2494,15 +2759,14 @@ secret key.
 
 @item --ask-sig-expire
 @itemx --no-ask-sig-expire
+@opindex ask-sig-expire
 When making a data signature, prompt for an expiration time. If this
 option is not specified, the expiration time set via
 @option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
-disables this option. Note that by default, @option{--force-v3-sigs} is
-set which also disables this option. If you want signature expiration,
-you must set @option{--no-force-v3-sigs} as well as turning
-@option{--ask-sig-expire} on.
+disables this option.
 
 @item --default-sig-expire
+@opindex default-sig-expire
 The default expiration time to use for signature expiration. Valid
 values are "0" for no expiration, a number followed by the letter d
 (for days), w (for weeks), m (for months), or y (for years) (for
@@ -2511,12 +2775,14 @@ date in the form YYYY-MM-DD. Defaults to "0".
 
 @item --ask-cert-expire
 @itemx --no-ask-cert-expire
+@opindex ask-cert-expire
 When making a key signature, prompt for an expiration time. If this
 option is not specified, the expiration time set via
 @option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
 disables this option.
 
 @item --default-cert-expire
+@opindex default-cert-expire
 The default expiration time to use for key signature expiration.
 Valid values are "0" for no expiration, a number followed by the
 letter d (for days), w (for weeks), m (for months), or y (for years)
@@ -2524,29 +2790,34 @@ letter d (for days), w (for weeks), m (for months), or y (for years)
 absolute date in the form YYYY-MM-DD. Defaults to "0".
 
 @item --allow-secret-key-import
+@opindex allow-secret-key-import
 This is an obsolete option and is not used anywhere.
 
 @item --allow-multiple-messages
 @item --no-allow-multiple-messages
+@opindex allow-multiple-messages
 Allow processing of multiple OpenPGP messages contained in a single file
 or stream.  Some programs that call GPG are not prepared to deal with
 multiple messages being processed together, so this option defaults to
 no.  Note that versions of GPG prior to 1.4.7 always allowed multiple
-messages.  
+messages.
 
 Warning: Do not use this option unless you need it as a temporary
 workaround!
 
 
 @item --enable-special-filenames
+@opindex enable-special-filenames
 This options enables a mode in which filenames of the form
 @file{-&n}, where n is a non-negative decimal number,
 refer to the file descriptor n and not to a file with that name.
 
 @item --no-expensive-trust-checks
+@opindex no-expensive-trust-checks
 Experimental use only.
 
 @item --preserve-permissions
+@opindex preserve-permissions
 Don't change the permissions of a secret keyring back to user
 read/write only. Use this option only if you really know what you are doing.
 
@@ -2571,6 +2842,10 @@ source distribution for the details of which configuration items may be
 listed. @option{--list-config} is only usable with
 @option{--with-colons} set.
 
+@item --list-gcrypt-config
+@opindex list-gcrypt-config
+Display various internal configuration parameters of Libgcrypt.
+
 @item --gpgconf-list
 @opindex gpgconf-list
 This command is similar to @option{--list-config} but in general only
@@ -2588,20 +2863,14 @@ on the configuration file.
 @c *******************************
 @c ******* Deprecated ************
 @c *******************************
+@node Deprecated Options
 @subsection Deprecated options
 
 @table @gnupgtabopt
 
-@ifset gpgone
-@item --load-extension @code{name}
-Load an extension module. If @code{name} does not contain a slash it is
-searched for in the directory configured when GnuPG was built
-(generally "/usr/local/lib/gnupg"). Extensions are not generally
-useful anymore, and the use of this option is deprecated.
-@end ifset
-
 @item --show-photos
 @itemx --no-show-photos
+@opindex show-photos
 Causes @option{--list-keys}, @option{--list-sigs},
 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
 a signature to also display the photo ID attached to the key, if
@@ -2610,22 +2879,18 @@ any. See also @option{--photo-viewer}. These options are deprecated. Use
 [no-]show-photos} instead.
 
 @item --show-keyring
+@opindex show-keyring
 Display the keyring name at the head of key listings to show which
 keyring a given key resides on. This option is deprecated: use
 @option{--list-options [no-]show-keyring} instead.
 
-@ifset gpgone
-@item --ctapi-driver @code{file}
-Use @code{file} to access the smartcard reader. The current default
-is `libtowitoko.so'. Note that the use of this interface is
-deprecated; it may be removed in future releases.
-@end ifset
-
 @item --always-trust
+@opindex always-trust
 Identical to @option{--trust-model always}. This option is deprecated.
 
 @item --show-notation
 @itemx --no-show-notation
+@opindex show-notation
 Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings
 as well as when verifying a signature with a notation in it. These
 options are deprecated. Use @option{--list-options [no-]show-notation}
@@ -2633,6 +2898,7 @@ and/or @option{--verify-options [no-]show-notation} instead.
 
 @item --show-policy-url
 @itemx --no-show-policy-url
+@opindex show-policy-url
 Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
 listings as well as when verifying a signature with a policy URL in
 it. These options are deprecated. Use @option{--list-options
@@ -2658,58 +2924,77 @@ current home directory (@pxref{option --homedir}).
 
 @table @file
 
-@item gpg.conf
-@cindex gpg.conf
-This is the standard configuration file read by @command{@gpgname} on
-startup.  It may contain any valid long option; the leading two dashes
-may not be entered and the option may not be abbreviated.  This default
-name may be changed on the command line (@pxref{option --options}).
-You should backup this file.
+  @item gpg.conf
+  @cindex gpg.conf
+  This is the standard configuration file read by @command{@gpgname} on
+  startup.  It may contain any valid long option; the leading two dashes
+  may not be entered and the option may not be abbreviated.  This default
+  name may be changed on the command line (@pxref{gpg-option --options}).
+  You should backup this file.
 
 @end table
 
 @c man:.RE
 Note that on larger installations, it is useful to put predefined files
-into the directory @file{/etc/skel/.gnupg/} so that newly created users
-start up with a working configuration.
-@ifclear gpgone
-For existing users the a small
+into the directory @file{@value{SYSCONFSKELDIR}} so that
+newly created users start up with a working configuration.
+For existing users a small
 helper script is provided to create these files (@pxref{addgnupghome}).
-@end ifclear
 
 For internal purposes @command{@gpgname} creates and maintains a few other
 files; They all live in in the current home directory (@pxref{option
---homedir}).  Only the @command{@gpgname} may modify these files.
+--homedir}).  Only the @command{@gpgname} program may modify these files.
 
 
 @table @file
-@item ~/.gnupg/secring.gpg
-The secret keyring.  You should backup this file.
+  @item ~/.gnupg/pubring.gpg
+  The public keyring.  You should backup this file.
+
+  @item ~/.gnupg/pubring.gpg.lock
+  The lock file for the public keyring.
+
+  @item ~/.gnupg/pubring.kbx
+  The public keyring using a different format.  This file is sharred
+  with @command{gpgsm}.  You should backup this file.
 
-@item ~/.gnupg/secring.gpg.lock
-The lock file for the secret keyring.
+  @item ~/.gnupg/pubring.kbx.lock
+  The lock file for @file{pubring.kbx}.
 
-@item ~/.gnupg/pubring.gpg
-The public keyring.  You should backup this file.
+  @item ~/.gnupg/secring.gpg
+  A secret keyring as used by GnuPG versions before 2.1.  It is not
+  used by GnuPG 2.1 and later.
 
-@item ~/.gnupg/pubring.gpg.lock
-The lock file for the public keyring.
+  @item ~/.gnupg/.gpg-v21-migrated
+  File indicating that a migration to GnuPG 2.1 has been done.
 
-@item ~/.gnupg/trustdb.gpg
-The trust database.  There is no need to backup this file; it is better
-to backup the ownertrust values (@pxref{option --export-ownertrust}).
+  @item ~/.gnupg/trustdb.gpg
+  The trust database.  There is no need to backup this file; it is better
+  to backup the ownertrust values (@pxref{option --export-ownertrust}).
 
-@item ~/.gnupg/trustdb.gpg.lock
-The lock file for the trust database.
+  @item ~/.gnupg/trustdb.gpg.lock
+  The lock file for the trust database.
 
-@item ~/.gnupg/random_seed
-A file used to preserve the state of the internal random pool.
+  @item ~/.gnupg/random_seed
+  A file used to preserve the state of the internal random pool.
 
-@item /usr[/local]/share/gnupg/options.skel
-The skeleton options file.
+  @item ~/.gnupg/secring.gpg.lock
+  The lock file for the secret keyring.
 
-@item /usr[/local]/lib/gnupg/
-Default location for extensions.
+  @item ~/.gnupg/openpgp-revocs.d/
+  This is the directory where gpg stores pre-generated revocation
+  certificates.  The file name corresponds to the OpenPGP fingerprint of
+  the respective key.  It is suggested to backup those certificates and
+  if the primary private key is not stored on the disk to move them to
+  an external storage device.  Anyone who can access theses files is
+  able to revoke the corresponding key.  You may want to print them out.
+  You should backup all files in this directory and take care to keep
+  this backup closed away.
+
+  @item @value{DATADIR}/options.skel
+  The skeleton options file.
+
+  @item @value{LIBDIR}/
+  Default location for extensions.
 
 @end table
 
@@ -2718,41 +3003,34 @@ Operation is further controlled by a few environment variables:
 
 @table @asis
 
-@item HOME
-Used to locate the default home directory.
+  @item HOME
+  Used to locate the default home directory.
 
-@item GNUPGHOME
-If set directory used instead of "~/.gnupg".
+  @item GNUPGHOME
+  If set directory used instead of "~/.gnupg".
 
-@item GPG_AGENT_INFO
-Used to locate the gpg-agent.
-@ifset gpgone
-This is only honored when @option{--use-agent} is set.
-@end ifset
-The value consists of 3 colon delimited fields: The first is the path
-to the Unix Domain Socket, the second the PID of the gpg-agent and the
-protocol version which should be set to 1. When starting the gpg-agent
-as described in its documentation, this variable is set to the correct
-value. The option @option{--gpg-agent-info} can be used to override it.
-
-@item PINENTRY_USER_DATA
-This value is passed via gpg-agent to pinentry.  It is useful to convey
-extra information to a custom pinentry.
-
-@item COLUMNS
-@itemx LINES
-Used to size some displays to the full size of the screen.
-
-
-@item LANGUAGE
-Apart from its use by GNU, it is used in the W32 version to override the
-language selection done through the Registry.  If used and set to a
-valid and available language name (@var{langid}), the file with the
-translation is loaded from
-@code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
-directory out of which the gpg binary has been loaded.  If it can't be
-loaded the Registry is tried and as last resort the native Windows
-locale system is used.  
+  @item GPG_AGENT_INFO
+  This variable was used by GnuPG versions before 2.1
+
+  @item PINENTRY_USER_DATA
+  This value is passed via gpg-agent to pinentry.  It is useful to convey
+  extra information to a custom pinentry.
+
+  @item COLUMNS
+  @itemx LINES
+  Used to size some displays to the full size of the screen.
+
+
+  @item LANGUAGE
+  Apart from its use by GNU, it is used in the W32 version to override the
+  language selection done through the Registry.  If used and set to a
+  valid and available language name (@var{langid}), the file with the
+  translation is loaded from
+
+  @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}.  Here @var{gpgdir} is the
+  directory out of which the gpg binary has been loaded.  If it can't be
+  loaded the Registry is tried and as last resort the native Windows
+  locale system is used.
 
 @end table
 
@@ -2864,7 +3142,7 @@ violation of OpenPGP, but rather reduce the available algorithms to a
 @mansect bugs
 @chapheading BUGS
 
-On many systems this program should be installed as setuid(root). This
+On older systems this program should be installed as setuid(root). This
 is necessary to lock memory pages. Locking memory pages prevents the
 operating system from writing memory pages (which may contain
 passphrases or other sensitive material) to disk. If you get no
@@ -2879,12 +3157,261 @@ powered off mode.  Unless measures are taken in the operating system
 to protect the saved memory, passphrases or other sensitive material
 may be recoverable from it later.
 
+Before you report a bug you should first search the mailing list
+archives for similar problems and second check whether such a bug has
+already been reported to our bug tracker at http://bugs.gnupg.org .
+
+@c *******************************************
+@c ***************              **************
+@c ***************  UNATTENDED  **************
+@c ***************              **************
+@c *******************************************
+@manpause
+@node Unattended Usage of GPG
+@section Unattended Usage
+
+@command{gpg} is often used as a backend engine by other software.  To help
+with this a machine interface has been defined to have an unambiguous
+way to do this.  The options @option{--status-fd} and @option{--batch}
+are almost always required for this.
+
+@menu
+* Unattended GPG key generation::  Unattended key generation
+@end menu
+
+
+@node Unattended GPG key generation
+@subsection Unattended key generation
+
+The command @option{--gen-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:
+
+@itemize @bullet
+  @item Text only, line length is limited to about 1000 characters.
+  @item UTF-8 encoding must be used to specify non-ASCII characters.
+  @item Empty lines are ignored.
+  @item Leading and trailing while space is ignored.
+  @item A hash sign as the first non white space character indicates
+  a comment line.
+  @item Control statements are indicated by a leading percent sign, the
+  arguments are separated by white space from the keyword.
+  @item Parameters are specified by a keyword, followed by a colon.  Arguments
+  are separated by white space.
+  @item
+  The first parameter must be @samp{Key-Type}; control statements may be
+  placed anywhere.
+  @item
+  The order of the parameters does not matter except for @samp{Key-Type}
+  which must be the first parameter.  The parameters are only used for
+  the generated keyblock (primary and subkeys); parameters from previous
+  sets are not used.  Some syntactically checks may be performed.
+  @item
+  Key generation takes place when either the end of the parameter file
+  is reached, the next @samp{Key-Type} parameter is encountered or at the
+  control statement @samp{%commit} is encountered.
+@end itemize
+
+@noindent
+Control statements:
+
+@table @asis
+
+@item %echo @var{text}
+Print @var{text} as diagnostic.
+
+@item %dry-run
+Suppress actual key generation (useful for syntax checking).
+
+@item %commit
+Perform the key generation.  Note that an implicit commit is done at
+the next @asis{Key-Type} parameter.
+
+@item %pubring @var{filename}
+@itemx %secring @var{filename}
+Do not write the key to the default or commandline given keyring but
+to @var{filename}.  This must be given before the first commit to take
+place, duplicate specification of the same filename is ignored, the
+last filename before a commit is used.  The filename is used until a
+new filename is used (at commit points) and all keys are written to
+that file. If a new filename is given, this file is created (and
+overwrites an existing one).  For GnuPG versions prior to 2.1, both
+control statements must be given. For GnuPG 2.1 and later
+@samp{%secring} is a no-op.
+
+@item %ask-passphrase
+@itemx %no-ask-passphrase
+This option is a no-op for GnuPG 2.1 and later.
+
+@item %no-protection
+Using this option allows the creation of keys without any passphrase
+protection.  This option is mainly intended for regression tests.
+
+@item %transient-key
+If given the keys are created using a faster and a somewhat less
+secure random number generator.  This option may be used for keys
+which are only used for a short time and do not require full
+cryptographic strength.  It takes only effect if used together with
+the control statement @samp{%no-protection}.
+
+@end table
+
+@noindent
+General Parameters:
+
+@table @asis
+
+@item Key-Type: @var{algo}
+Starts a new parameter block by giving the type of the primary
+key. The algorithm must be capable of signing.  This is a required
+parameter.  @var{algo} may either be an OpenPGP algorithm number or a
+string with the algorithm name.  The special value @samp{default} may
+be used for @var{algo} to create the default key type; in this case a
+@samp{Key-Usage} shall not be given and @samp{default} also be used
+for @samp{Subkey-Type}.
+
+@item Key-Length: @var{nbits}
+The requested length of the generated key in bits.  The default is
+returned by running the command @samp{gpg2 --gpgconf-list}.
+
+@item Key-Grip: @var{hexstring}
+This is optional and used to generate a CSR or certificate for an
+already existing key.  Key-Length will be ignored when given.
+
+@item Key-Usage: @var{usage-list}
+Space or comma delimited list of key usages.  Allowed values are
+@samp{encrypt}, @samp{sign}, and @samp{auth}.  This is used to
+generate the key flags.  Please make sure that the algorithm is
+capable of this usage.  Note that OpenPGP requires that all primary
+keys are capable of certification, so no matter what usage is given
+here, the @samp{cert} flag will be on.  If no @samp{Key-Usage} is
+specified and the @samp{Key-Type} is not @samp{default}, all allowed
+usages for that particular algorithm are used; if it is not given but
+@samp{default} is used the usage will be @samp{sign}.
+
+@item Subkey-Type: @var{algo}
+This generates a secondary key (subkey).  Currently only one subkey
+can be handled.  See also @samp{Key-Type} above.
+
+@item Subkey-Length: @var{nbits}
+Length of the secondary key (subkey) in bits.  The default is returned
+by running the command @samp{gpg2 --gpgconf-list}".
+
+@item Subkey-Usage: @var{usage-list}
+Key usage lists for a subkey; similar to @samp{Key-Usage}.
+
+@item Passphrase: @var{string}
+If you want to specify a passphrase for the secret key, enter it here.
+Default is to use the Pinentry dialog to ask for a passphrase.
+
+@item Name-Real: @var{name}
+@itemx Name-Comment: @var{comment}
+@itemx Name-Email: @var{email}
+The three parts of a user name.  Remember to use UTF-8 encoding here.
+If you don't give any of them, no user ID is created.
+
+@item Expire-Date: @var{iso-date}|(@var{number}[d|w|m|y])
+Set the expiration date for the key (and the subkey).  It may either
+be entered in ISO date format (e.g. "20000815T145012") or as number of
+days, weeks, month or years after the creation date.  The special
+notation "seconds=N" is also allowed to specify a number of seconds
+since creation.  Without a letter days are assumed.  Note that there
+is no check done on the overflow of the type used by OpenPGP for
+timestamps.  Thus you better make sure that the given value make
+sense.  Although OpenPGP works with time intervals, GnuPG uses an
+absolute value internally and thus the last year we can represent is
+2105.
+
+@item  Creation-Date: @var{iso-date}
+Set the creation date of the key as stored in the key information and
+which is also part of the fingerprint calculation.  Either a date like
+"1986-04-26" or a full timestamp like "19860426T042640" may be used.
+The time is considered to be UTC.  The special notation "seconds=N"
+may be used to directly specify a the number of seconds since Epoch
+(Unix time).  If it is not given the current time is used.
+
+@item Preferences: @var{string}
+Set the cipher, hash, and compression preference values for this key.
+This expects the same type of string as the sub-command @samp{setpref}
+in the @option{--edit-key} menu.
+
+@item  Revoker: @var{algo}:@var{fpr} [sensitive]
+Add a designated revoker to the generated key.  Algo is the public key
+algorithm of the designated revoker (i.e. RSA=1, DSA=17, etc.)
+@var{fpr} is the fingerprint of the designated revoker.  The optional
+@samp{sensitive} flag marks the designated revoker as sensitive
+information.  Only v4 keys may be designated revokers.
+
+@item Keyserver: @var{string}
+This is an optional parameter that specifies the preferred keyserver
+URL for the key.
+
+@item Handle: @var{string}
+This is an optional parameter only used with the status lines
+KEY_CREATED and KEY_NOT_CREATED.  @var{string} may be up to 100
+characters and should not contain spaces.  It is useful for batch key
+generation to associate a key parameter block with a status line.
+
+@end table
+
+@noindent
+Here is an example on how to create a key:
+@smallexample
+$ cat >foo <<EOF
+     %echo Generating a basic OpenPGP key
+     Key-Type: DSA
+     Key-Length: 1024
+     Subkey-Type: ELG-E
+     Subkey-Length: 1024
+     Name-Real: Joe Tester
+     Name-Comment: with stupid passphrase
+     Name-Email: joe@@foo.bar
+     Expire-Date: 0
+     Passphrase: abc
+     %pubring foo.pub
+     %secring foo.sec
+     # Do a commit here, so that we can later print "done" :-)
+     %commit
+     %echo done
+EOF
+$ gpg2 --batch --gen-key foo
+ [...]
+$ gpg2 --no-default-keyring --secret-keyring ./foo.sec \
+       --keyring ./foo.pub --list-secret-keys
+/home/wk/work/gnupg-stable/scratch/foo.sec
+------------------------------------------
+sec  1024D/915A878D 2000-03-09 Joe Tester (with stupid passphrase) <joe@@foo.bar>
+ssb  1024g/8F70E2C0 2000-03-09
+@end smallexample
+
+
+@noindent
+If you want to create a key with the default algorithms you would use
+these parameters:
+@smallexample
+     %echo Generating a default key
+     Key-Type: default
+     Subkey-Type: default
+     Name-Real: Joe Tester
+     Name-Comment: with stupid passphrase
+     Name-Email: joe@@foo.bar
+     Expire-Date: 0
+     Passphrase: abc
+     %pubring foo.pub
+     %secring foo.sec
+     # Do a commit here, so that we can later print "done" :-)
+     %commit
+     %echo done
+@end smallexample
+
+
+
+
 @mansect see also
 @ifset isman
-@command{gpgv}(1), 
-@ifclear gpgone
-@command{gpgsm}(1), 
+@command{gpgv}(1),
+@command{gpgsm}(1),
 @command{gpg-agent}(1)
-@end ifclear
 @end ifset
 @include see-also-note.texi