diff --git a/doc/dirmngr.texi b/doc/dirmngr.texi
index 9fc58ea24..8da4dcd37 100644
--- a/doc/dirmngr.texi
+++ b/doc/dirmngr.texi
@@ -1,1362 +1,1362 @@
 @c Copyright (C) 2002 Klar"alvdalens Datakonsult AB
 @c Copyright (C) 2004, 2005, 2006, 2007 g10 Code GmbH
 @c This is part of the GnuPG manual.
 @c For copying conditions, see the file gnupg.texi.
 
 @include defs.inc
 
 @node Invoking DIRMNGR
 @chapter Invoking DIRMNGR
 @cindex DIRMNGR command options
 @cindex command options
 @cindex options, DIRMNGR command
 
 @manpage dirmngr.8
 @ifset manverb
 .B dirmngr
 \- GnuPG's network access daemon
 @end ifset
 
 @mansect synopsis
 @ifset manverb
 .B  dirmngr
 .RI [ options ]
 .I command
 .RI [ args ]
 @end ifset
 
 @mansect description
 Since version 2.1 of GnuPG, @command{dirmngr} takes care of accessing
 the OpenPGP keyservers.  As with previous versions it is also used as
 a server for managing and downloading certificate revocation lists
 (CRLs) for X.509 certificates, downloading X.509 certificates, and
 providing access to OCSP providers.  Dirmngr is invoked internally by
 @command{gpg}, @command{gpgsm}, or via the @command{gpg-connect-agent}
 tool.
 
 @manpause
 @noindent
 @xref{Option Index},for an index to @command{DIRMNGR}'s commands and
 options.
 @mancont
 
 @menu
 * Dirmngr Commands::      List of all commands.
 * Dirmngr Options::       List of all options.
 * Dirmngr Configuration:: Configuration files.
 * Dirmngr Signals::       Use of signals.
 * Dirmngr Examples::      Some usage examples.
 * Dirmngr Protocol::      The protocol dirmngr uses.
 @end menu
 
 
 @node Dirmngr Commands
 @section Commands
 @mansect commands
 
 Commands are not distinguished from options except for the fact that
 only one command is allowed.
 
 @table @gnupgtabopt
 @item --version
 @opindex version
 Print the program version and licensing information.  Note that you cannot
 abbreviate this command.
 
 @item --help, -h
 @opindex help
 Print a usage message summarizing the most useful command-line options.
 Note that you cannot abbreviate this command.
 
 @item --dump-options
 @opindex dump-options
 Print a list of all available options and commands.  Note that you cannot
 abbreviate this command.
 
 @item --server
 @opindex server
 Run in server mode and wait for commands on the @code{stdin}.  The
 default mode is to create a socket and listen for commands there.
 This is only used for testing.
 
 @item --daemon
 @opindex daemon
 Run in background daemon mode and listen for commands on a socket.
 This is the way @command{dirmngr} is started on demand by the other
 GnuPG components.  To force starting @command{dirmngr} it is in
 general best to use @code{gpgconf --launch dirmngr}.
 
 @item --supervised
 @opindex supervised
 Run in the foreground, sending logs to stderr, and listening on file
 descriptor 3, which must already be bound to a listening socket.  This
 option is deprecated and not supported on Windows.
 
 @item --list-crls
 @opindex list-crls
 List the contents of the CRL cache on @code{stdout}. This is probably
 only useful for debugging purposes.
 
 @item --load-crl @var{file}
 @opindex load-crl
 This command requires a filename as additional argument, and it will
 make Dirmngr try to import the CRL in @var{file} into it's cache.
 Note, that this is only possible if Dirmngr is able to retrieve the
 CA's certificate directly by its own means.  In general it is better
 to use @code{gpgsm}'s @code{--call-dirmngr loadcrl filename} command
 so that @code{gpgsm} can help dirmngr.
 
 @item --fetch-crl @var{url}
 @opindex fetch-crl
 This command requires an URL as additional argument, and it will make
 dirmngr try to retrieve and import the CRL from that @var{url} into
 it's cache.  This is mainly useful for debugging purposes.  The
 @command{dirmngr-client} provides the same feature for a running dirmngr.
 
 @item --shutdown
 @opindex shutdown
 This commands shuts down an running instance of Dirmngr.  This command
 has currently no effect.
 
 @item --flush
 @opindex flush
 This command removes all CRLs from Dirmngr's cache.  Client requests
 will thus trigger reading of fresh CRLs.
 
 @end table
 
 
 @mansect options
 @node Dirmngr Options
 @section Option Summary
 
 Note that all long options with the exception of @option{--options}
 and @option{--homedir} may also be given in the configuration file
 after stripping off the two leading dashes.
 
 @table @gnupgtabopt
 
 @item --options @var{file}
 @opindex options
 Reads configuration from @var{file} instead of from the default
 per-user configuration file.  The default configuration file is named
 @file{dirmngr.conf} and expected in the home directory.
 
 @item --homedir @var{dir}
 @opindex options
 Set the name of the home directory to @var{dir}.  This option is only
 effective when used on the command line.  The default is
 the directory named @file{.gnupg} directly below the home directory
 of the user unless the environment variable @code{GNUPGHOME} has been set
 in which case its value will be used.  Many kinds of data are stored within
 this directory.
 
 
 @item -v
 @item --verbose
 @opindex v
 @opindex verbose
 Outputs additional information while running.
 You can increase the verbosity by giving several
 verbose commands to @sc{dirmngr}, such as @option{-vv}.
 
 
 @item --log-file @var{file}
 @opindex log-file
 Append all logging output to @var{file}.  This is very helpful in
 seeing what the agent actually does.  Use @file{socket://} to log to
 socket.
 
 @item --compatibility-flags @var{flags}
 @opindex compatibility-flags
 Set compatibility flags to work around certain problems or to emulate
 bugs.  The @var{flags} are given as a comma separated list of flag
 names and are OR-ed together.  The special flag "none" clears the list
 and allows to start over with an empty list.  To get a list of
 available flags the sole word "help" can be used.
 
 @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 --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 debug 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.
 This option is only useful for debugging and the behavior may change
 at any time without notice.
 
 @item --debug-all
 @opindex debug-all
 Same as @code{--debug=0xffffffff}
 
 @item --tls-debug @var{level}
 @opindex tls-debug
 Enable debugging of the TLS layer at @var{level}.  The details of the
 debug level depend on the used TLS library and are not set in stone.
 
 @item --debug-wait @var{n}
 @opindex debug-wait
 When running in server mode, wait @var{n} seconds before entering the
 actual processing loop and print the pid.  This gives time to attach a
 debugger.
 
 @item --disable-check-own-socket
 @opindex disable-check-own-socket
 On some platforms @command{dirmngr} is able to detect the removal of
 its socket file and shutdown itself.  This option disable this
 self-test for debugging purposes.
 
 @item -s
 @itemx --sh
 @itemx -c
 @itemx --csh
 @opindex s
 @opindex sh
 @opindex c
 @opindex csh
 Format the info output in daemon mode for use with the standard Bourne
 shell respective the C-shell. The default is to guess it based on the
 environment variable @code{SHELL} which is in almost all cases
 sufficient.
 
 @item --force
 @opindex force
 Enabling this option forces loading of expired CRLs; this is only
 useful for debugging.
 
 @item --use-tor
 @itemx --no-use-tor
 @opindex use-tor
 @opindex no-use-tor
 The option @option{--use-tor} switches Dirmngr and thus GnuPG into
 ``Tor mode'' to route all network access via Tor (an anonymity
 network).  Certain other features are disabled in this mode.  The
 effect of @option{--use-tor} cannot be overridden by any other command
 or even by reloading dirmngr.  The use of @option{--no-use-tor}
 disables the use of Tor.  The default is to use Tor if it is available
 on startup or after reloading dirmngr.  The test on the availability of
 Tor is done by trying to connect to a SOCKS proxy at either port 9050
 or 9150; if another type of proxy is listening on one of these ports,
 you should use @option{--no-use-tor}.
 
 @item --standard-resolver
 @opindex standard-resolver
 This option forces the use of the system's standard DNS resolver code.
 This is mainly used for debugging.  Note that on Windows a standard
 resolver is not used and all DNS access will return the error ``Not
 Implemented'' if this option is used.  Using this together with enabled
 Tor mode returns the error ``Not Enabled''.
 
 @item --recursive-resolver
 @opindex recursive-resolver
 When possible use a recursive resolver instead of a stub resolver.
 
 @item --resolver-timeout @var{n}
 @opindex resolver-timeout
 Set the timeout for the DNS resolver to N seconds.  The default are 30
 seconds.
 
 @item --connect-timeout @var{n}
 @item --connect-quick-timeout @var{n}
 @opindex connect-timeout
 @opindex connect-quick-timeout
 Set the timeout for HTTP and generic TCP connection attempts to N
 seconds.  The value set with the quick variant is used when the
 @option{--quick} option has been given to certain Assuan commands.  The quick
 value is capped at the value of the regular connect timeout.  The
 default values are 15 and 2 seconds.  Note that the timeout values are
 for each connection attempt; the connection code will attempt to
 connect all addresses listed for a server.
 
 @item --listen-backlog @var{n}
 @opindex listen-backlog
 Set the size of the queue for pending connections.  The default is 64.
 
 @item --allow-version-check
 @opindex allow-version-check
 Allow Dirmngr to connect to @code{https://versions.gnupg.org} to get
 the list of current software versions.  If this option is enabled
 the list is retrieved in case the local
 copy does not exist or is older than 5 to 7 days.  See the option
 @option{--query-swdb} of the command @command{gpgconf} for more
 details.  Note, that regardless of this option a version check can
 always be triggered using this command:
 
 @example
        gpg-connect-agent --dirmngr 'loadswdb --force' /bye
 @end example
 
 
 @item --keyserver @var{name}
 @opindex keyserver
 Use @var{name} as your keyserver.  This is the server that @command{gpg}
 communicates with to receive keys, send keys, and search for
 keys.  The format of the @var{name} is a URI:
 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
 "hkp" for the HTTP (or compatible) keyservers or "ldap" for the LDAP
 keyservers. Note that your particular installation of GnuPG may have
 other keyserver types available as well. Keyserver schemes are
 case-insensitive. After the keyserver name, optional keyserver
 configuration options may be provided.  These are the same as the
 @option{--keyserver-options} of @command{gpg}, but apply only to this
 particular keyserver.
 
 Some keyservers synchronize with each other, so there is not always a
 need to send keys to more than one server. Some keyservers use round
 robin DNS to give a different keyserver each time you use it.
 
 If exactly two keyservers are configured and only one is a Tor hidden
 service (.onion), Dirmngr selects the keyserver to use depending on
 whether Tor is locally running or not.  The check for a running Tor is
 done for each new connection.
 
 If no keyserver is explicitly configured, dirmngr will use the
 built-in default of @code{https://keyserver.ubuntu.com}.
 
 Windows users with a keyserver running on their Active Directory
 may use the short form @code{ldap:///} for @var{name} to access this directory.
 
 For accessing anonymous LDAP keyservers @var{name} is in general just
 a @code{ldaps://ldap.example.com}.  A BaseDN parameter should never be
 specified.  If authentication is required things are more complicated
 and two methods are available:
 
 The modern method (since version 2.2.28) is to use the very same syntax
 as used with the option @option{--ldapserver}.  Please see over
 there for details; here is an example:
 
 @example
        keyserver ldap:ldap.example.com::uid=USERNAME,ou=GnuPG Users,
        dc=example,dc=com:PASSWORD::starttls
 @end example
 
        The other method is to use a full URL for @var{name}; for example:
 
 @example
        keyserver ldaps://ldap.example.com/????bindname=uid=USERNAME
        %2Cou=GnuPG%20Users%2Cdc=example%2Cdc=com,password=PASSWORD
 @end example
 
        Put this all on one line without any spaces and keep the '%2C'
        as given.  Replace USERNAME, PASSWORD, and the 'dc' parts
        according to the instructions received from your LDAP
        administrator.  Note that only simple authentication
        (i.e., cleartext passwords) is supported and thus using ldaps is
        strongly suggested (since 2.2.28 "ldaps" defaults to port 389
        and uses STARTTLS).  On Windows authentication via AD can be
        requested by adding @code{gpgNtds=1} after the fourth question
        mark instead of the bindname and password parameter.
 
 
 
 @item --nameserver @var{ipaddr}
 @opindex nameserver
 In ``Tor mode'' Dirmngr uses a public resolver via Tor to resolve DNS
 names.  If the default public resolver, which is @code{8.8.8.8}, shall
 not be used a different one can be given using this option.  Note that
 a numerical IP address must be given (IPv6 or IPv4) and that no error
 checking is done for @var{ipaddr}.
 
 @item --disable-ipv4
 @item --disable-ipv6
 @opindex disable-ipv4
 @opindex disable-ipv6
 Disable the use of all IPv4 or IPv6 addresses.
 
 @item --disable-ldap
 @opindex disable-ldap
 Entirely disables the use of LDAP.
 
 @item --disable-http
 @opindex disable-http
 Entirely disables the use of HTTP.
 
 @item --ignore-http-dp
 @opindex ignore-http-dp
 When looking for the location of a CRL, the to be tested certificate
 usually contains so called @dfn{CRL Distribution Point} (DP) entries
 which are URLs describing the way to access the CRL.  The first found DP
 entry is used.  With this option all entries using the @acronym{HTTP}
 scheme are ignored when looking for a suitable DP.
 
 @item --ignore-ldap-dp
 @opindex ignore-ldap-dp
 This is similar to @option{--ignore-http-dp} but ignores entries using
 the @acronym{LDAP} scheme.  Both options may be combined resulting in
 ignoring DPs entirely.
 
 @item --ignore-ocsp-service-url
 @opindex ignore-ocsp-service-url
 Ignore all OCSP URLs contained in the certificate.  The effect is to
 force the use of the default responder.
 
 @item --honor-http-proxy
 @opindex honor-http-proxy
 If the environment variable @env{http_proxy} has been set, use its
 value to access HTTP servers.
 
 @item --http-proxy @var{host}[:@var{port}]
 @opindex http-proxy
 @efindex http_proxy
 Use @var{host} and @var{port} to access HTTP servers.  The use of this
 option overrides the environment variable @env{http_proxy} regardless
 whether @option{--honor-http-proxy} has been set.
 
 
 @item --ldap-proxy @var{host}[:@var{port}]
 @opindex ldap-proxy
 Use @var{host} and @var{port} to connect to LDAP servers.  If @var{port}
 is omitted, port 389 (standard LDAP port) is used.  This overrides any
 specified host and port part in a LDAP URL and will also be used if host
 and port have been omitted from the URL.
 
 @item --only-ldap-proxy
 @opindex only-ldap-proxy
 Never use anything else but the LDAP "proxy" as configured with
 @option{--ldap-proxy}.  Usually @command{dirmngr} tries to use other
 configured LDAP server if the connection using the "proxy" failed.
 
 
 @item --ldapserverlist-file @var{file}
 @opindex ldapserverlist-file
 Read the list of LDAP servers to consult for CRLs and X.509 certificates from
 file instead of the default per-user ldap server list file. The default
 value for @var{file} is @file{dirmngr_ldapservers.conf}.
 
 This server list file contains one LDAP server per line in the format
 
 @sc{hostname:port:username:password:base_dn:flags}
 
 Lines starting with a  @samp{#} are comments.
 
 Note that as usual all strings entered are expected to be UTF-8 encoded.
 Obviously this will lead to problems if the password has originally been
 encoded as Latin-1.  There is no other solution here than to put such a
 password in the binary encoding into the file (i.e., non-ascii characters
 won't show up readable).@footnote{The @command{gpgconf} tool might be
 helpful for frontends as it enables editing this configuration file using
 percent-escaped strings.}
 
 
 @item --ldapserver @var{spec}
 @opindex ldapserver
 This is an alternative way to specify LDAP servers for CRL and X.509
 certificate retrieval.  If this option is used the servers configured
 in @file{dirmngr_ldapservers.conf} (or the file given by
 @option{--ldapserverlist-file}) are cleared.  Note that
 @file{dirmngr_ldapservers.conf} is not read again by a reload
 signal. However, @option{--ldapserver} options are read again.
 
 @var{spec} is either a proper LDAP URL or a colon delimited list of
 the form
 
 @sc{hostname:port:username:password:base_dn:flags:}
 
 with an optional prefix of @code{ldap:} (but without the two slashes
 which would turn this into a proper LDAP URL).  @sc{flags} is a list
 of one or more comma delimited keywords:
 @table @code
 @item plain
 The default: Do not use a TLS secured connection at all; the default
 port is 389.
 @item starttls
 Use STARTTLS to secure the connection; the default port is 389.
 @item ldaptls
 Tunnel LDAP through a TLS connection; the default port is 636.
 @item ntds
 On Windows authenticate the LDAP connection using the Active Directory
 with the current user.
 @item areconly
 On Windows use only the A or AAAA record when resolving the LDAP
 server name.
 @end table
 
 Note that in an URL style specification the scheme @code{ldaps://}
 refers to STARTTLS and _not_ to LDAP-over-TLS.
 
 
 @item --ldaptimeout @var{secs}
 @opindex ldaptimeout
 Specify the number of seconds to wait for an LDAP query before timing
 out.  The default are 15 seconds.  0 will never timeout.
 
 
 @item --add-servers
 @opindex add-servers
 This option makes dirmngr add any servers it discovers when validating
 certificates against CRLs to the internal list of servers to consult for
 certificates and CRLs.  This option should in general not be used.
 
 This option might be useful when trying to validate a certificate that
 has a CRL distribution point that points to a server that is not
 already listed in the ldapserverlist.  Dirmngr will always go to this
 server and try to download the CRL, but chances are high that the
 certificate used to sign the CRL is located on the same server. So if
 dirmngr doesn't add that new server to list, it will often not be able
 to verify the signature of the CRL unless the @code{--add-servers}
 option is used.
 
 Caveat emptor: Using this option may enable denial-of-service attacks
 and leak search requests to unknown third parties.  This is because
 arbitrary servers are added to the internal list of LDAP servers which
 in turn is used for all unspecific LDAP queries as well as a fallback
 for queries which did not return a result.
 
 
 @item --allow-ocsp
 @opindex allow-ocsp
 This option enables OCSP support if requested by the client.
 
 OCSP requests are rejected by default because they may violate the
 privacy of the user; for example it is possible to track the time when
 a user is reading a mail.
 
 
 @item --ocsp-responder @var{url}
 @opindex ocsp-responder
 Use @var{url} as the default OCSP Responder if the certificate does
 not contain information about an assigned responder.  Note, that
 @code{--ocsp-signer} must also be set to a valid certificate.
 
 @item --ocsp-signer @var{fpr}|@var{file}
 @opindex ocsp-signer
 Use the certificate with the fingerprint @var{fpr} to check the
 responses of the default OCSP Responder.  Alternatively a filename can be
 given in which case the response is expected to be signed by one of the
 certificates described in that file.  Any argument which contains a
 slash, dot or tilde is considered a filename.  Usual filename expansion
 takes place: A tilde at the start followed by a slash is replaced by the
 content of @env{HOME}, no slash at start describes a relative filename
 which will be searched at the home directory.  To make sure that the
 @var{file} is searched in the home directory, either prepend the name
 with "./" or use a name which contains a dot.
 
 If a response has been signed by a certificate described by these
 fingerprints no further check upon the validity of this certificate is
 done.
 
 The format of the @var{FILE} is a list of SHA-1 fingerprint, one per
 line with optional colons between the bytes.  Empty lines and lines
 prefix with a hash mark are ignored.
 
 
 @item --ocsp-max-clock-skew @var{n}
 @opindex ocsp-max-clock-skew
 The number of seconds a skew between the OCSP responder and them local
 clock is accepted.  Default is 600 (10 minutes).
 
 @item --ocsp-max-period @var{n}
 @opindex ocsp-max-period
 Seconds a response is at maximum considered valid after the time given
 in the thisUpdate field.  Default is 7776000 (90 days).
 
 @item --ocsp-current-period @var{n}
 @opindex ocsp-current-period
 The number of seconds an OCSP response is considered valid after the
 time given in the NEXT_UPDATE datum.  Default is 10800 (3 hours).
 
 
 @item --max-replies @var{n}
 @opindex max-replies
 Do not return more that @var{n} items in one query.  The default is
 10.
 
 @item --ignore-cert-extension @var{oid}
 @opindex ignore-cert-extension
 Add @var{oid} to the list of ignored certificate extensions.  The
 @var{oid} is expected to be in dotted decimal form, like
 @code{2.5.29.3}.  This option may be used more than once.  Critical
 flagged certificate extensions matching one of the OIDs in the list
 are treated as if they are actually handled and thus the certificate
 won't be rejected due to an unknown critical extension.  Use this
 option with care because extensions are usually flagged as critical
 for a reason.
 
 @item --ignore-crl-extension @var{oid}
 @opindex ignore-crl-extension
 Add @var{oid} to the list of ignored CRL extensions.  The @var{oid} is
 expected to be in dotted decimal form.  Critical flagged CRL
 extensions matching one of the OIDs in the list are treated as if they
 are actually handled and thus the certificate won't be rejected due to
 an unknown critical extension.  Use this option with care because
 extensions are usually flagged as critical for a reason.
 
 @item --ignore-cert @var{fpr}|@var{file}
 @opindex ignore-cert
 Entirely ignore certificates with the fingerprint @var{fpr}.  As an
 alternative to the fingerprint a filename can be given in which case
 all certificates described in that file are ignored.  Any argument
 which contains a slash, dot or tilde is considered a filename.  Usual
 filename expansion takes place: A tilde at the start followed by a
 slash is replaced by the content of @env{HOME}, no slash at start
 describes a relative filename which will be searched at the home
 directory.  To make sure that the @var{file} is searched in the home
 directory, either prepend the name with "./" or use a name which
 contains a dot.  The format of such a file is a list of SHA-1
 fingerprint, one per line with optional colons between the bytes.
 Empty lines and lines prefixed with a hash mark are ignored.
 
 This option is useful as a quick workaround to exclude certain
 certificates from the system store.
 
 
 @item --hkp-cacert @var{file}
 Use the root certificates in @var{file} for verification of the TLS
 certificates used with @code{hkps} (keyserver access over TLS).  If
 the file is in PEM format a suffix of @code{.pem} is expected for
 @var{file}.  This option may be given multiple times to add more
 root certificates.  Tilde expansion is supported.
 
 If no @code{hkp-cacert} directive is present, dirmngr will use the
 system CAs.
 
 @end table
 
 
 @c
 @c Dirmngr Configuration
 @c
 @mansect files
 @node Dirmngr Configuration
 @section Configuration
 
 Dirmngr makes use of several directories when running in daemon mode:
 There are a few configuration files to control the operation of
 dirmngr.  By default they may all be found in the current home
 directory (@pxref{option --homedir}).
 
 @table @file
 
 @item dirmngr.conf
 @efindex dirmngr.conf
 This is the standard configuration file read by @command{dirmngr} 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 file
 is also read after a @code{SIGHUP} however not all options will
 actually have an effect.  This default name may be changed on the
 command line (@pxref{option --options}).  You should backup this file.
 
 @item /etc/gnupg/trusted-certs
 This directory should be filled with certificates of Root CAs you
 are trusting in checking the CRLs and signing OCSP Responses.
 
 Usually these are the same certificates you use with the applications
 making use of dirmngr.  It is expected that each of these certificate
 files contain exactly one @acronym{DER} encoded certificate in a file
 with the suffix @file{.crt} or @file{.der}.  @command{dirmngr} reads
 those certificates on startup and when given a SIGHUP.  Certificates
 which are not readable or do not make up a proper X.509 certificate
 are ignored; see the log file for details.
 
 Applications using dirmngr (e.g., gpgsm) can request these
 certificates to complete a trust chain in the same way as with the
 extra-certs directory (see below).
 
 Note that for OCSP responses the certificate specified using the option
 @option{--ocsp-signer} is always considered valid to sign OCSP requests.
 
 @item /etc/gnupg/extra-certs
 This directory may contain extra certificates which are preloaded
 into the internal cache on startup. Applications using dirmngr (e.g., gpgsm)
 can request cached certificates to complete a trust chain.
 This is convenient in cases you have a couple intermediate CA certificates
 or certificates usually used to sign OCSP responses.
 These certificates are first tried before going
 out to the net to look for them.  These certificates must also be
 @acronym{DER} encoded and suffixed with @file{.crt} or @file{.der}.
 
 @item ~/.gnupg/crls.d
 This directory is used to store cached CRLs.  The @file{crls.d}
 part will be created by dirmngr if it does not exists but you need to
 make sure that the upper directory exists.
 
 @end table
 
 Several options control the use of trusted certificates for TLS and
 CRLs.  Here is an Overview on the use and origin of those Root CA
 certificates:
 @table @asis
 
 @item System
 
 These System root certificates are used by:  FIXME
 
 The origin of the system provided certificates depends on the
 platform.  On Windows all certificates from the Windows System Stores
 @code{ROOT} and @code{CA} are used.
 
 On other platforms the certificates are read from the first file found
 form this list: @file{/etc/ssl/ca-bundle.pem},
 @file{/etc/ssl/certs/ca-certificates.crt},
 @file{/etc/pki/tls/cert.pem},
 @file{/usr/local/share/certs/ca-root-nss.crt},
 @file{/etc/ssl/cert.pem}.
 
 @item GnuPG
 
 The GnuPG specific certificates stored in the directory
 @file{/etc/gnupg/trusted-certs} are only used to validate CRLs.
 
 @c Note that dirmngr's VALIDATE command also uses them but that
 @c command is anyway only intended for debugging.
 
 @item OpenPGP keyserver
 
 For accessing the OpenPGP keyservers the only certificates used are
 those set with the configuration option @option{hkp-cacert}.
 
 @item OpenPGP keyserver pool
 
 This is usually only one certificate read from the file
 @file{@value{DATADIR}/gnupg/sks-keyservers.netCA.pem}.  If this
 certificate exists it is used to access the special keyservers
 @code{hkps.pool.sks-keyservers.net} (or @file{hkps://keys.gnupg.net}).
 
 @end table
 
 Please note that @command{gpgsm} accepts Root CA certificates for its
 own purposes only if they are listed in its file @file{trustlist.txt}.
-@command{dirmngr} does not make use of this list - except FIXME.
+@command{dirmngr} does not make use of this list --- except FIXME.
 
 
 @mansect notes
 
 To be able to see diagnostics it is often useful to put at least the
 following lines into the configuration file
 @file{~/gnupg/dirmngr.conf}:
 
 @example
 log-file ~/dirmngr.log
 verbose
 @end example
 
 You may want to check the log file to see whether all desired root CA
 certificates are correctly loaded.
 
 To be able to perform OCSP requests you probably want to add the line:
 
 @example
 allow-ocsp
 @end example
 
 To make sure that new options are read or that after the installation
 of a new GnuPG versions the right dirmngr version is running, you
 should kill an existing dirmngr so that a new instance is started as
 needed by the other components:
 
 @example
 gpgconf --kill dirmngr
 @end example
 
 Direct interfaction with the dirmngr is possible by using the command
 
 @example
 gpg-connect-agent --dirmngr
 @end example
 
 Enter @code{HELP} at the prompt to see a list of commands and enter
 @code{HELP} followed by a command name to get help on that command.
 
 
 
 @c
 @c Dirmngr Signals
 @c
 @mansect signals
 @node Dirmngr Signals
 @section Use of signals
 
 A running @command{dirmngr} may be controlled by signals, i.e., using
 the @command{kill} command to send a signal to the process.
 
 Here is a list of supported signals:
 
 @table @gnupgtabopt
 
 @item SIGHUP
 @cpindex SIGHUP
 This signal flushes all internally cached CRLs as well as any cached
 certificates.  Then the certificate cache is reinitialized as on
 startup.  Options are re-read from the configuration file.  Instead of
 sending this signal it is better to use
 @example
 gpgconf --reload dirmngr
 @end example
 
 @item SIGTERM
 @cpindex SIGTERM
 Shuts down the process but waits until all current requests are
 fulfilled.  If the process has received 3 of these signals and requests
 are still pending, a shutdown is forced.  You may also use
 @example
 gpgconf --kill dirmngr
 @end example
 instead of this signal
 
 @item SIGINT
 @cpindex SIGINT
 Shuts down the process immediately.
 
 
 @item SIGUSR1
 @cpindex SIGUSR1
 This prints some caching statistics to the log file.
 
 @end table
 
 
 
 @c
 @c  Examples
 @c
 @mansect examples
 @node Dirmngr Examples
 @section Examples
 
 Here is an example on how to show dirmngr's internal table of OpenPGP
 keyserver addresses.  The output is intended for debugging purposes
 and not part of a defined API.
 
 @example
   gpg-connect-agent --dirmngr 'keyserver --hosttable' /bye
 @end example
 
 To inhibit the use of a particular host you have noticed in one of the
 keyserver pools, you may use
 
 @example
  gpg-connect-agent --dirmngr 'keyserver --dead pgpkeys.bnd.de' /bye
 @end example
 
 The description of the @code{keyserver} command can be printed using
 
 @example
  gpg-connect-agent --dirmngr 'help keyserver' /bye
 @end example
 
 
 
 @c
 @c  Assuan Protocol
 @c
 @manpause
 @node Dirmngr Protocol
 @section Dirmngr's Assuan Protocol
 
 Assuan is the IPC protocol used to access dirmngr.  This is a
 description of the commands implemented by dirmngr.
 
 @menu
 * Dirmngr LOOKUP::      Look up a certificate via LDAP
 * Dirmngr ISVALID::     Validate a certificate using a CRL or OCSP.
 * Dirmngr CHECKCRL::    Validate a certificate using a CRL.
 * Dirmngr CHECKOCSP::   Validate a certificate using OCSP.
 * Dirmngr CACHECERT::   Put a certificate into the internal cache.
 * Dirmngr VALIDATE::    Validate a certificate for debugging.
 @end menu
 
 @node Dirmngr LOOKUP
 @subsection Return the certificate(s) found
 
 Lookup certificate.  To allow multiple patterns (which are ORed)
 quoting is required: Spaces are to be translated into "+" or into
 "%20"; obviously this requires that the usual escape quoting rules
 are applied.  The server responds with:
 
 @example
   S: D <DER encoded certificate>
   S: END
   S: D <second DER encoded certificate>
   S: END
   S: OK
 @end example
 
 In this example 2 certificates are returned.  The server may return
 any number of certificates; OK will also be returned when no
 certificates were found.  The dirmngr might return a status line
 
 @example
   S: S TRUNCATED <n>
 @end example
 
 
 To indicate that the output was truncated to N items due to a
 limitation of the server or by an arbitrary set limit.
 
 The option @option{--url} may be used if instead of a search pattern a
 complete URL to the certificate is known:
 
 @example
   C: LOOKUP --url CN%3DWerner%20Koch,o%3DIntevation%20GmbH,c%3DDE?userCertificate
 @end example
 
 If the option @option{--cache-only} is given, no external lookup is done
 so that only certificates from the cache are returned.
 
 With the option @option{--single}, the first and only the first match
 will be returned.  Unless option @option{--cache-only} is also used, no
 local lookup will be done in this case.
 
 
 
 @node Dirmngr ISVALID
 @subsection Validate a certificate using a CRL or OCSP
 
 @example
   ISVALID [--only-ocsp] [--force-default-responder] @var{certid}|@var{certfpr}
 @end example
 
 Check whether the certificate described by the @var{certid} has been
 revoked.  Due to caching, the Dirmngr is able to answer immediately in
 most cases.
 
 The @var{certid} is a hex encoded string consisting of two parts,
 delimited by a single dot.  The first part is the SHA-1 hash of the
 issuer name and the second part the serial number.
 
 Alternatively the certificate's SHA-1 fingerprint @var{certfpr} may be
 given in which case an OCSP request is done before consulting the CRL.
 If the option @option{--only-ocsp} is given, no fallback to a CRL check
 will be used.  If the option @option{--force-default-responder} is
 given, only the default OCSP responder will be used and any other
 methods of obtaining an OCSP responder URL won't be used.
 
 @noindent
 Common return values are:
 
 @table @code
 @item GPG_ERR_NO_ERROR (0)
 This is the positive answer: The certificate is not revoked and we have
 an up-to-date revocation list for that certificate.  If OCSP was used
 the responder confirmed that the certificate has not been revoked.
 
 @item GPG_ERR_CERT_REVOKED
 This is the negative answer: The certificate has been revoked.  Either
 it is in a CRL and that list is up to date or an OCSP responder informed
 us that it has been revoked.
 
 @item GPG_ERR_NO_CRL_KNOWN
 No CRL is known for this certificate or the CRL is not valid or out of
 date.
 
 @item GPG_ERR_NO_DATA
 The OCSP responder returned an ``unknown'' status.  This means that it
 is not aware of the certificate's status.
 
 @item GPG_ERR_NOT_SUPPORTED
 This is commonly seen if OCSP support has not been enabled in the
 configuration.
 @end table
 
 If DirMngr has not enough information about the given certificate (which
 is the case for not yet cached certificates), it will inquire the
 missing data:
 
 @example
   S: INQUIRE SENDCERT <CertID>
   C: D <DER encoded certificate>
   C: END
 @end example
 
 A client should be aware that DirMngr may ask for more than one
 certificate.
 
 If Dirmngr has a certificate but the signature of the certificate
 could not been validated because the root certificate is not known to
 dirmngr as trusted, it may ask back to see whether the client trusts
 this the root certificate:
 
 @example
   S: INQUIRE ISTRUSTED <CertHexfpr>
   C: D 1
   C: END
 @end example
 
 Only this answer will let Dirmngr consider the certificate as valid.
 
 
 @node Dirmngr CHECKCRL
 @subsection Validate a certificate using a CRL
 
 Check whether the certificate with FINGERPRINT (SHA-1 hash of the
 entire X.509 certificate blob) is valid or not by consulting the CRL
 responsible for this certificate.  If the fingerprint has not been
 given or the certificate is not known, the function inquires the
 certificate using:
 
 @example
   S: INQUIRE TARGETCERT
   C: D <DER encoded certificate>
   C: END
 @end example
 
 Thus the caller is expected to return the certificate for the request
 (which should match FINGERPRINT) as a binary blob.  Processing then
 takes place without further interaction; in particular dirmngr tries
 to locate other required certificate by its own mechanism which
 includes a local certificate store as well as a list of trusted root
 certificates.
 
 @noindent
 The return code is 0 for success; i.e., the certificate has not been
 revoked or one of the usual error codes from libgpg-error.
 
 @node Dirmngr CHECKOCSP
 @subsection Validate a certificate using OCSP
 
 @example
   CHECKOCSP [--force-default-responder] [@var{fingerprint}]
 @end example
 
 Check whether the certificate with @var{fingerprint} (the SHA-1 hash of
 the entire X.509 certificate blob) is valid by consulting the appropriate
 OCSP responder.  If the fingerprint has not been given or the
 certificate is not known by Dirmngr, the function inquires the
 certificate using:
 
 @example
   S: INQUIRE TARGETCERT
   C: D <DER encoded certificate>
   C: END
 @end example
 
 Thus the caller is expected to return the certificate for the request
 (which should match @var{fingerprint}) as a binary blob.  Processing
 then takes place without further interaction; in particular dirmngr
 tries to locate other required certificates by its own mechanism which
 includes a local certificate store as well as a list of trusted root
 certificates.
 
 If the option @option{--force-default-responder} is given, only the
 default OCSP responder is used.  This option is the per-command variant
 of the global option @option{--ignore-ocsp-service-url}.
 
 
 @noindent
 The return code is 0 for success; i.e., the certificate has not been
 revoked or one of the usual error codes from libgpg-error.
 
 @node Dirmngr CACHECERT
 @subsection Put a certificate into the internal cache
 
 Put a certificate into the internal cache.  This command might be
 useful if a client knows in advance certificates required for a test and
 wants to make sure they get added to the internal cache.  It is also
 helpful for debugging.  To get the actual certificate, this command
 immediately inquires it using
 
 @example
   S: INQUIRE TARGETCERT
   C: D <DER encoded certificate>
   C: END
 @end example
 
 Thus the caller is expected to return the certificate for the request
 as a binary blob.
 
 @noindent
 The return code is 0 for success; i.e., the certificate has not been
 successfully cached or one of the usual error codes from libgpg-error.
 
 @node Dirmngr VALIDATE
 @subsection Validate a certificate for debugging
 
 Validate a certificate using the certificate validation function used
 internally by dirmngr.  This command is only useful for debugging.  To
 get the actual certificate, this command immediately inquires it using
 
 @example
   S: INQUIRE TARGETCERT
   C: D <DER encoded certificate>
   C: END
 @end example
 
 Thus the caller is expected to return the certificate for the request
 as a binary blob.
 
 
 @mansect see also
 @ifset isman
 @command{gpgsm}(1),
 @command{dirmngr-client}(1)
 @end ifset
 @include see-also-note.texi
 
 @c
 @c !!! UNDER CONSTRUCTION !!!
 @c
 @c
 @c @section Verifying a Certificate
 @c
 @c There are several ways to request services from Dirmngr.  Almost all of
 @c them are done using the Assuan protocol.  What we describe here is the
 @c Assuan command CHECKCRL as used for example by the dirmnr-client tool if
 @c invoked as
 @c
 @c @example
 @c   dirmngr-client foo.crt
 @c @end example
 @c
 @c This command will send an Assuan request to an already running Dirmngr
 @c instance.  foo.crt is expected to be a standard X.509 certificate and
 @c dirmngr will receive the Assuan command
 @c
 @c @example
 @c    CHECKCRL @var [{fingerprint}]
 @c @end example
 @c
 @c @var{fingerprint} is optional and expected to be the SHA-1 has of the
 @c DER encoding of the certificate under question.  It is to be HEX
 @c encoded.  The rationale for sending the fingerprint is that it allows
 @c dirmngr to reply immediately if it has already cached such a request.  If
 @c this is not the case and no certificate has been found in dirmngr's
 @c internal certificate storage, dirmngr will request the certificate using
 @c the Assuan inquiry
 @c
 @c @example
 @c       INQUIRE TARGETCERT
 @c @end example
 @c
 @c The caller (in our example dirmngr-client) is then expected to return
 @c the certificate for the request (which should match @var{fingerprint})
 @c as a binary blob.
 @c
 @c Dirmngr now passes control to @code{crl_cache_cert_isvalid}.  This
 @c function checks whether a CRL item exists for target certificate.  These
 @c CRL items are kept in a database of already loaded and verified CRLs.
 @c This mechanism is called the CRL cache.  Obviously timestamps are kept
 @c there with each item to cope with the expiration date of the CRL.  The
 @c possible return values are: @code{0} to indicate that a valid CRL is
 @c available for the certificate and the certificate itself is not listed
 @c in this CRL, @code{GPG_ERR_CERT_REVOKED} to indicate that the certificate is
 @c listed in the CRL or @code{GPG_ERR_NO_CRL_KNOWN} in cases where no CRL or no
 @c information is available.  The first two codes are immediately returned to
 @c the caller and the processing of this request has been done.
 @c
 @c Only the @code{GPG_ERR_NO_CRL_KNOWN} needs more attention: Dirmngr now
 @c calls @code{clr_cache_reload_crl} and if this succeeds calls
 @c @code{crl_cache_cert_isvald) once more.  All further errors are
 @c immediately returned to the caller.
 @c
 @c @code{crl_cache_reload_crl} is the actual heart of the CRL management.
 @c It locates the corresponding CRL for the target certificate, reads and
 @c verifies this CRL and stores it in the CRL cache.  It works like this:
 @c
 @c * Loop over all crlDPs in the target certificate.
 @c     * If the crlDP is invalid immediately terminate the loop.
 @c     * Loop over all names in the current crlDP.
 @c         * If the URL scheme is unknown or not enabled
 @c           (--ignore-http-dp, --ignore-ldap-dp) continues with
 @c           the next name.
 @c         * @code{crl_fetch} is called to actually retrieve the CRL.
 @c           In case of problems this name is ignore and we continue with
 @c           the next name.  Note that @code{crl_fetch} does only return
 @c           a descriptor for the CRL for further reading so does the CRL
 @c           does not yet end up in memory.
 @c         * @code{crl_cache_insert} is called with that descriptor to
 @c           actually read the CRL into the cache. See below for a
 @c           description of this function.  If there is any error (e.g., read
 @c           problem, CRL not correctly signed or verification of signature
 @c           not possible), this descriptor is rejected and we continue
 @c           with the next name.  If the CRL has been successfully loaded,
 @c           the loop is terminated.
 @c * If no crlDP has been found in the previous loop use a default CRL.
 @c   Note, that if any crlDP has been found but loading of the CRL failed,
 @c   this condition is not true.
 @c     * Try to load a CRL from all configured servers (ldapservers.conf)
 @c       in turn.  The first server returning a CRL is used.
 @c     * @code(crl_cache_insert) is then used to actually insert the CRL
 @c       into the cache.  If this failed we give up immediately without
 @c       checking the rest of the servers from the first step.
 @c * Ready.
 @c
 @c
 @c The @code{crl_cache_insert} function takes care of reading the bulk of
 @c the CRL, parsing it and checking the signature.  It works like this: A
 @c new database file is created using a temporary file name.  The CRL
 @c parsing machinery is started and all items of the CRL are put into
 @c this database file.  At the end the issuer certificate of the CRL
 @c needs to be retrieved.  Three cases are to be distinguished:
 @c
 @c  a) An authorityKeyIdentifier with an issuer and serialno exits: The
 @c     certificate is retrieved using @code{find_cert_bysn}.  If
 @c     the certificate is in the certificate cache, it is directly
 @c     returned. Then the requester (i.e., the client who requested the
 @c     CRL check) is asked via the Assuan inquiry ``SENDCERT'' whether
 @c     he can provide this certificate.  If this succeed the returned
 @c     certificate gets cached and returned.  Note, that dirmngr does not
 @c     verify in any way whether the expected certificate is returned.
 @c     It is in the interest of the client to return a useful certificate
 @c     as otherwise the service request will fail due to a bad signature.
 @c     The last way to get the certificate is by looking it up at
 @c     external resources.  This is done using the @code{ca_cert_fetch}
 @c     and @code{fetch_next_ksba_cert} and comparing the returned
 @c     certificate to match the requested issuer and seriano (This is
 @c     needed because the LDAP layer may return several certificates as
 @c     LDAP as no standard way to retrieve by serial number).
 @c
 @c  b) An authorityKeyIdentifier with a key ID exists: The certificate is
 @c     retrieved using @code{find_cert_bysubject}.  If the certificate is
 @c     in the certificate cache, it is directly returned.  Then the
 @c     requester is asked via the Assuan inquiry ``SENDCERT_SKI'' whether
 @c     he can provide this certificate.  If this succeed the returned
 @c     certificate gets cached and returned.  Note, that dirmngr does not
 @c     verify in any way whether the expected certificate is returned.
 @c     It is in the interest of the client to return a useful certificate
 @c     as otherwise the service request will fail due to a bad signature.
 @c     The last way to get the certificate is by looking it up at
 @c     external resources.  This is done using the @code{ca_cert_fetch}
 @c     and @code{fetch_next_ksba_cert} and comparing the returned
 @c     certificate to match the requested subject and key ID.
 @c
 @c  c) No authorityKeyIdentifier exits: The certificate is retrieved
 @c     using @code{find_cert_bysubject} without the key ID argument.  If
 @c     the certificate is in the certificate cache the first one with a
 @c     matching subject is directly returned.  Then the requester is
 @c     asked via the Assuan inquiry ``SENDCERT'' and an exact
 @c     specification of the subject whether he can
 @c     provide this certificate.  If this succeed the returned
 @c     certificate gets cached and returned.  Note, that dirmngr does not
 @c     verify in any way whether the expected certificate is returned.
 @c     It is in the interest of the client to return a useful certificate
 @c     as otherwise the service request will fail due to a bad signature.
 @c     The last way to get the certificate is by looking it up at
 @c     external resources.  This is done using the @code{ca_cert_fetch}
 @c     and @code{fetch_next_ksba_cert} and comparing the returned
 @c     certificate to match the requested subject; the first certificate
 @c     with a matching subject is then returned.
 @c
 @c If no certificate was found, the function returns with the error
 @c GPG_ERR_MISSING_CERT.  Now the signature is verified.  If this fails,
 @c the error is returned.  On success the @code{validate_cert_chain} is
 @c used to verify that the certificate is actually valid.
 @c
 @c Here we may encounter a recursive situation:
 @c @code{validate_cert_chain} needs to look at other certificates and
 @c also at CRLs to check whether these other certificates and well, the
 @c CRL issuer certificate itself are not revoked.  FIXME: We need to make
 @c sure that @code{validate_cert_chain} does not try to lookup the CRL we
 @c are currently processing. This would be a catch-22 and may indicate a
 @c broken PKI.  However, due to overlapping expiring times and imprecise
 @c clocks this may actually happen.
 @c
 @c For historical reasons the Assuan command ISVALID is a bit different
 @c to CHECKCRL but this is mainly due to different calling conventions.
 @c In the end the same fucntionality is used, albeit hidden by a couple
 @c of indirection and argument and result code mangling.  It furthere
 @c ingetrages OCSP checking depending on options are the way it is
 @c called.  GPGSM still uses this command but might eventually switch over
 @c to CHECKCRL and CHECKOCSP so that ISVALID can be retired.
 @c
 @c
 @c @section Validating a certificate
 @c
 @c We describe here how the internal function @code{validate_cert_chain}
 @c works. Note that mainly testing purposes this functionality may be
 @c called directly using @cmd{dirmngr-client --validate @file{foo.crt}}.
 @c
 @c The function takes the target certificate and a mode argument as
 @c parameters and returns an error code and optionally the closes
 @c expiration time of all certificates in the chain.
 @c
 @c We first check that the certificate may be used for the requested
 @c purpose (i.e., OCSP or CRL signing).  If this is not the case
 @c GPG_ERR_WRONG_KEY_USAGE is returned.
 @c
 @c The next step is to find the trust anchor (root certificate) and to
 @c assemble the chain in memory: Starting with the target certificate,
 @c the expiration time is checked against the current date, unknown
 @c critical extensions are detected and certificate policies are matched
 @c (We only allow 2.289.9.9 but I have no clue about that OID and from
 @c where I got it - it does not even seem to be assigned - debug cruft?).
 @c
 @c Now if this certificate is a self-signed one, we have reached the
 @c trust anchor.  In this case we check that the signature is good, the
 @c certificate is allowed to act as a CA, that it is a trusted one (by
 @c checking whether it is has been put into the trusted-certs
 @c configuration directory) and finally prepend into to our list
 @c representing the certificate chain.  This steps ends then.
 @c
 @c If it is not a self-signed certificate, we check that the chain won't
 @c get too long (current limit is 100), if this is the case we terminate
 @c with the error GPG_ERR_BAD_CERT_CHAIN.
 @c
 @c Now the issuer's certificate is looked up: If an
 @c authorityKeyIdentifier is available, this one is used to locate the
 @c certificate either using issuer and serialnumber or subject DN
 @c (i.e., the issuer's DN) and the keyID.  The functions
 @c @code{find_cert_bysn) and @code{find_cert_bysubject} are used
 @c respectively. The have already been described above under the
 @c description of @code{crl_cache_insert}.  If no certificate was found
 @c or with no authorityKeyIdentifier, only the cache is consulted using
 @c @code{get_cert_bysubject}.  The latter is done under the assumption
 @c that a matching certificate has explicitly been put into the
 @c certificate cache.  If the issuer's certificate could not be found,
 @c the validation terminates with the error code @code{GPG_ERR_MISSING_CERT}.
 @c
 @c If the issuer's certificate has been found, the signature of the
 @c actual certificate is checked and in case this fails the error
 @c #code{GPG_ERR_BAD_CERT_CHAIN} is returned.  If the signature checks out, the
 @c maximum chain length of the issuing certificate is checked as well as
 @c the capability of the certificate (i.e., whether he may be used for
 @c certificate signing).  Then the certificate is prepended to our list
 @c representing the certificate chain.  Finally the loop is continued now
 @c with the issuer's certificate as the current certificate.
 @c
 @c After the end of the loop and if no error as been encountered
 @c (i.e., the certificate chain has been assempled correctly), a check is
 @c done whether any certificate expired or a critical policy has not been
 @c met.  In any of these cases the validation terminates with an
 @c appropriate error.
 @c
 @c Finally the function @code{check_revocations} is called to verify no
 @c certificate in the assempled chain has been revoked: This is an
 @c recursive process because a CRL has to be checked for each certificate
 @c in the chain except for the root certificate, of which we already know
 @c that it is trusted and we avoid checking a CRL here due to common
 @c setup problems and the assumption that a revoked root certificate has
 @c been removed from the list of trusted certificates.
 @c
 @c
 @c
 @c
 @c @section Looking up certificates through LDAP.
 @c
 @c This describes the LDAP layer to retrieve certificates.
 @c the functions @code{ca_cert_fetch} and @code{fetch_next_ksba_cert} are
 @c used for this.  The first one starts a search and the second one is
 @c used to retrieve certificate after certificate.
 @c
diff --git a/doc/gpg.texi b/doc/gpg.texi
index 760582c8e..8203c1466 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -1,4707 +1,4707 @@
 @c Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
 @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 standard stuff
 @ifclear gpgtwohack
 @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 ifclear
 @c End standard stuff
 
 @c Begin gpg2 hack stuff
 @ifset gpgtwohack
 @manpage gpg2.1
 @ifset manverb
 .B gpg2
 \- OpenPGP encryption and signing tool
 @end ifset
 
 @mansect synopsis
 @ifset manverb
 .B  gpg2
 .RB [ \-\-homedir
 .IR dir ]
 .RB [ \-\-options
 .IR file ]
 .RI [ options ]
 .I command
 .RI [ args ]
 @end ifset
 @end ifset
 @c End gpg2 hack stuff
 
 
 @mansect description
 @command{@gpgname} is the OpenPGP part of the GNU Privacy Guard (GnuPG). It
 is a tool to provide digital encryption and signing services using the
 OpenPGP standard. @command{@gpgname} features complete key management and
 all the bells and whistles you would expect from a full OpenPGP
 implementation.
 
 There are two main versions of GnuPG: GnuPG 1.x and GnuPG 2.x.  GnuPG
 2.x supports modern encryption algorithms and thus should be preferred
 over GnuPG 1.x.  You only need to use GnuPG 1.x if your platform
 doesn't support GnuPG 2.x, or you need support for some features that
 GnuPG 2.x has deprecated, e.g., decrypting data created with PGP-2
 keys.
 
 @ifclear gpgtwohack
 If you are looking for version 1 of GnuPG, you may find that version
 installed under the name @command{gpg1}.
 @end ifclear
 @ifset gpgtwohack
 In contrast to the standalone command @command{gpg} from GnuPG 1.x,
 the 2.x version is commonly installed under the name
 @command{@gpgname}.
 @end ifset
 
 @manpause
 
 @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.
 
 Developer information:
 * Unattended Usage of GPG:: Using @command{gpg} from other programs.
 @end menu
 
 @c * GPG Protocol::        The protocol the server mode uses.
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  COMMANDS  ****************
 @c ***************            ****************
 @c *******************************************
 @mansect commands
 @node GPG Commands
 @section Commands
 
 Commands are not distinguished from options except for the fact that
 only one command is allowed.  Generally speaking, irrelevant options
 are silently ignored, and may not be checked for correctness.
 
 @command{@gpgname} may be run with no commands. In this case it will
 print a warning perform a reasonable action depending on the type of
 file it is given as input (an encrypted message is decrypted, a
 signature is verified, a file containing keys is listed, etc.).
 
 If you run into any problems, please add the option @option{--verbose}
 to the invocation to see more diagnostics.
 
 
 @menu
 * General GPG Commands::        Commands not specific to the functionality.
 * Operational GPG Commands::    Commands to select the type of operation.
 * OpenPGP Key Management::      How to manage your keys.
 @end menu
 
 
 @c *******************************************
 @c **********  GENERAL COMMANDS  *************
 @c *******************************************
 @node General GPG Commands
 @subsection Commands not specific to the function
 
 @table @gnupgtabopt
 @item --version
 @opindex version
 Print the program version and licensing information.  Note that you
 cannot abbreviate this command.
 
 @item --help
 @itemx -h
 @opindex help
 Print a usage message summarizing the most useful command-line options.
 Note that you cannot arbitrarily abbreviate this command
 (though you can use its short form @option{-h}).
 
 @item --warranty
 @opindex warranty
 Print warranty information.
 
 @item --dump-options
 @opindex dump-options
 Print a list of all available options and commands.  Note that you cannot
 abbreviate this command.
 @end table
 
 
 @c *******************************************
 @c ********  OPERATIONAL COMMANDS  ***********
 @c *******************************************
 @node Operational GPG Commands
 @subsection Commands to select the type of operation
 
 
 @table @gnupgtabopt
 
 @item --sign
 @itemx -s
 @opindex sign
 Sign a message. This command may be combined with @option{--encrypt}
 (to sign and encrypt a message), @option{--symmetric} (to sign and
 symmetrically encrypt a message), or both @option{--encrypt} and
 @option{--symmetric} (to sign and encrypt a message that can be
 decrypted using a secret key or a passphrase).  The signing key is
 chosen by default or can be set explicitly using the
 @option{--local-user} and @option{--default-key} options.
 
 @item --clear-sign
 @opindex clear-sign
 @itemx --clearsign
 @opindex clearsign
 Make a cleartext signature.  The content in a cleartext signature is
 readable without any special software. OpenPGP software is only needed
 to verify the signature.  cleartext signatures may modify end-of-line
 whitespace for platform independence and are not intended to be
 reversible.  The signing key is chosen by default or can be set
 explicitly using the @option{--local-user} and @option{--default-key}
 options.
 
 
 @item --detach-sign
 @itemx -b
 @opindex detach-sign
 Make a detached signature.
 
 @item --encrypt
 @itemx -e
 @opindex encrypt
 Encrypt data to one or more public keys. This command may be combined
 with @option{--sign} (to sign and encrypt a message),
 @option{--symmetric} (to encrypt a message that can be decrypted using a
 secret key or a passphrase), or @option{--sign} and
 @option{--symmetric} together (for a signed message that can be
 decrypted using a secret key or a passphrase).  @option{--recipient}
 and related options specify which public keys to use for encryption.
 
 @item --symmetric
 @itemx -c
 @opindex symmetric
 Encrypt with a symmetric cipher using a passphrase. The default
 symmetric cipher used is @value{GPGSYMENCALGO}, but may be chosen with the
 @option{--cipher-algo} option. This command 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
 or a passphrase), or @option{--sign} and @option{--encrypt} together
 (for a signed message that may be decrypted via a secret key or a
 passphrase).  @command{@gpgname} caches the passphrase used for
 symmetric encryption so that a decrypt operation may not require that
 the user needs to enter the passphrase.  The option
 @option{--no-symkey-cache} can be used to disable this feature.
 
 @item --store
 @opindex store
 Store only (make a simple literal data packet).
 
 @item --decrypt
 @itemx -d
 @opindex decrypt
 Decrypt the file given on the command line (or STDIN if no file
 is specified) and write it to STDOUT (or the file specified with
 @option{--output}). If the decrypted file is signed, the signature is also
 verified. This command differs from the default operation, as it never
 writes to the filename which is included in the file and it rejects
 files that don't begin with an encrypted message.
 
 @item --verify
 @opindex verify
 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 one argument is given, the specified file is
 expected to include a complete signature.
 
 With more than one argument, the first argument should specify a file
 with a detached signature and the remaining files should contain the
 signed data. To read the signed data from STDIN, use @samp{-} as the
 second filename.  For security reasons, a detached signature will not
 read the signed material from STDIN if not explicitly specified.
 
 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; you should always specify the data file
 explicitly.
 
 Note: When verifying a cleartext signature, @command{@gpgname} verifies
 only what makes up the cleartext signed data and not any extra data
 outside of the cleartext signature or the header lines directly following
 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.
 
 Note: To check whether a file was signed by a certain key the option
 @option{--assert-signer} can be used.  As an alternative the
 @command{gpgv} tool can be used.  @command{gpgv} is designed to
 compare signed data against a list of trusted keys and returns with
 success only for a good signature.  It has its own manual page.
 
 
 @item --multifile
 @opindex multifile
 This modifies certain other commands to accept multiple files for
 processing on the command line or read from STDIN with each filename on
 a separate line. This allows for many files to be processed at
 once. @option{--multifile} may currently be used along with
 @option{--verify}, @option{--encrypt}, and @option{--decrypt}. Note that
 @option{--multifile --verify} may not be used with detached signatures.
 
 @item --verify-files
 @opindex verify-files
 Identical to @option{--multifile --verify}.
 
 @item --encrypt-files
 @opindex encrypt-files
 Identical to @option{--multifile --encrypt}.
 
 @item --decrypt-files
 @opindex decrypt-files
 Identical to @option{--multifile --decrypt}.
 
 @item --list-keys
 @itemx -k
 @itemx --list-public-keys
 @opindex list-keys
 List the specified keys.  If no keys are specified, then all keys from
 the configured public keyrings are listed.
 
 Never use the output of this command in scripts or other programs.
 The output is intended only for humans and its format is likely to
 change.  The @option{--with-colons} option emits the output in a
 stable, machine-parseable format, which is intended for use by scripts
 and other programs.
 
 @item --list-secret-keys
 @itemx -K
 @opindex list-secret-keys
 List the specified secret keys.  If no keys are specified, then all
 known secret keys are listed.  A @code{#} after the initial tags
 @code{sec} or @code{ssb} means that the secret key or subkey is
 currently not usable.  We also say that this key has been taken
 offline (for example, a primary key can be taken offline by exporting
 the key using the command @option{--export-secret-subkeys}).  A
 @code{>} after these tags indicate that the key is stored on a
 smartcard.  See also @option{--list-keys}.
 
 @item --check-signatures
 @opindex check-signatures
 @itemx --check-sigs
 @opindex check-sigs
 Same as @option{--list-keys}, but the key signatures are verified and
 listed too.  Note that for performance reasons the revocation status
 of a signing key is not shown.  This command has the same effect as
 using @option{--list-keys} with @option{--with-sig-check}.
 
 The status of the verification is indicated by a flag directly
 following the "sig" tag (and thus before the flags described below.  A
 "!" indicates that the signature has been 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).  Signatures
 where the public key is not available are not listed; to see their
 keyids the command @option{--list-sigs} can be used.
 
 For each signature listed, there are several flags in between the
 signature status flag and keyid.  These flags give additional
 information about each key signature.  From left to right, they are
 the numbers 1--3 for certificate check level (see
 @option{--ask-cert-level}), "L" for a local or non-exportable
 signature (see @option{--lsign-key}), "R" for a nonRevocable signature
 (see the @option{--edit-key} command "nrsign"), "P" for a signature
 that contains a policy URL (see @option{--cert-policy-url}), "N" for a
 signature that contains a notation (see @option{--cert-notation}), "X"
 for an eXpired signature (see @option{--ask-cert-expire}), and the
 numbers 1--9 or "T" for 10 and above to indicate trust signature levels
 (see the @option{--edit-key} command "tsign").
 
 
 @item --locate-keys
 @itemx --locate-external-keys
 @opindex locate-keys
 @opindex locate-external-keys
 Locate the keys given as arguments.  This command basically uses the
 same algorithm as used when locating keys for encryption and may thus
 be used to see what keys @command{@gpgname} might use.  In particular
 external methods as defined by @option{--auto-key-locate} are used to
 locate a key if the arguments comain valid mail addresses.  Only
 public keys are listed.
 
 The variant @option{--locate-external-keys} does not consider a
 locally existing key and can thus be used to force the refresh of a
 key via the defined external methods.  If a fingerprint is given and
 and the methods defined by @option{--auto-key-locate} define LDAP
 servers, the key is fetched from these resources; defined non-LDAP
 keyservers are skipped.
 
 
 @item --show-keys
 @opindex show-keys
 This commands takes OpenPGP keys as input and prints information about
 them in the same way the command @option{--list-keys} does for locally
 stored key.  In addition the list options @code{show-unusable-uids},
 @code{show-unusable-subkeys}, @code{show-notations} and
 @code{show-policy-urls} are also enabled.  As usual for automated
 processing, this command should be combined with the option
 @option{--with-colons}.
 
 @item --fingerprint
 @opindex fingerprint
 List all keys (or the specified ones) along with their
 fingerprints. This is the same output as @option{--list-keys} but with
 the additional output of a line with the fingerprint. May also be
 combined with @option{--check-signatures}.  If this
 command is given twice, the fingerprints of all secondary keys are
 listed too.  This command also forces pretty printing of fingerprints
 if the keyid format has been set to "none".
 
 @item --list-packets
 @opindex list-packets
 List only the sequence of packets.  This command is only useful for
 debugging.  When used with option @option{--verbose} the actual MPI
 values are dumped and not only their lengths.  Note that the output of
 this command may change with new releases.
 
 
 @item --edit-card
 @opindex edit-card
 @itemx --card-edit
 @opindex card-edit
 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
 https://gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .  Please
 note that the command "openpgp" can be used to switch to the OpenPGP
 application of cards which by default are presenting another
 application (e.g., PIV).
 
 @item --card-status
 @opindex card-status
 Show the content of the smart card.
 
 @item --change-pin
 @opindex change-pin
 Present a menu to allow changing the PIN of a smartcard. This
 functionality is also available as the subcommand "passwd" with the
 @option{--edit-card} command.
 
 @item --delete-keys @var{name}
 @opindex delete-keys
 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.  If the
 exclamation mark syntax is used with the fingerprint of a subkey only
 that subkey is deleted; if the exclamation mark is used with the
 fingerprint of the primary key the entire public key is deleted.
 
 @item --delete-secret-keys @var{name}
 @opindex delete-secret-keys
 Remove key from the secret keyring. In batch mode the key must be
 specified by fingerprint.  The option @option{--yes} can be used to
 advise gpg-agent not to request a confirmation.  This extra
 pre-caution is done because @command{@gpgname} can't be sure that the
 secret key (as controlled by gpg-agent) is only used for the given
 OpenPGP public key.  If the exclamation mark syntax is used with the
 fingerprint of a subkey only the secret part of that subkey is
 deleted; if the exclamation mark is used with the fingerprint of the
 primary key only the secret part of the primary key is deleted.
 
 
 @item --delete-secret-and-public-key @var{name}
 @opindex delete-secret-and-public-key
 Same as @option{--delete-key}, but if a secret key exists, it will be
 removed first. In batch mode the key must be specified by fingerprint.
 The option @option{--yes} can be used to advise gpg-agent not to
 request a confirmation.
 
 @item --export
 @opindex export
 Either export all keys from all keyrings (default keyring and those
 registered via option @option{--keyring}), or if at least one name is given,
 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 @var{keyIDs}
 @opindex send-keys
 Similar to @option{--export} but sends the keys to a keyserver.
 Fingerprints may be used instead of key IDs.
 Don't send your complete keyring to a keyserver --- select
 only those keys which are new or changed by you.  If no @var{keyIDs}
 are given, @command{@gpgname} does nothing.
 
 Take care: Keyservers are by design write only systems and thus it is
 not possible to ever delete keys once they have been send to a
 keyserver.
 
 
 @item --export-secret-keys
 @itemx --export-secret-subkeys
 @opindex export-secret-keys
 @opindex export-secret-subkeys
 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 for easy printing of the key for paper backup;
 however the external tool @command{paperkey} does a better job of
 creating backups on paper.  Note that exporting a secret key can be a
 security risk if the exported keys are sent 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 in generating a full key with
 an additional signing subkey on a dedicated machine.  This command
 then exports 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 --export-ssh-key
 @opindex export-ssh-key
 This command is used to export a key in the OpenSSH public key format.
 It requires the specification of one key by the usual means and
 exports the latest valid subkey which has an authentication capability
 to STDOUT or to the file given with option @option{--output}.  That
 output can directly be added to ssh's @file{authorized_key} file.
 
 By specifying the key to export using a key ID or a fingerprint
 suffixed with an exclamation mark (!), a specific subkey or the
 primary key can be exported.  This does not even require that the key
 has the authentication capability flag set.
 
 @item --import
 @itemx --fast-import
 @opindex import
 Import/merge keys. This adds the given keys to the
 keyring. The fast version is currently just a synonym.
 
 There are a few other options which control how this command works.
 Most notable here is the @option{--import-options merge-only} option
 which does not insert new keys but does only the merging of new
 signatures, user-IDs and subkeys.
 
 @item --receive-keys @var{keyIDs}
 @opindex receive-keys
 @itemx --recv-keys @var{keyIDs}
 @opindex recv-keys
 Import the keys with the given @var{keyIDs} from a keyserver.
 
 @item --refresh-keys
 @opindex refresh-keys
 Request updates from a keyserver for keys that already exist on the
 local keyring. This is useful for updating a key with the latest
 signatures, user IDs, etc. Calling this with no arguments will refresh
 the entire keyring.
 
 @item --search-keys @var{names}
 @opindex search-keys
 Search the keyserver for the given @var{names}. Multiple names given
 here will be joined together to create the search string for the
 keyserver.  Note that keyservers search for @var{names} in a different
 and simpler way than gpg does.  The best choice is to use a mail
 address.  Due to data privacy reasons keyservers may even not even
 allow searching by user id or mail address and thus may only return
 results when being used with the @option{--recv-key} command to
 search by key fingerprint or keyid.
 
 @item --fetch-keys @var{URIs}
 @opindex fetch-keys
 Retrieve keys located at the specified @var{URIs}. Note that different
 installations of GnuPG may support different protocols (HTTP, FTP,
 LDAP, etc.).  When using HTTPS the system provided root certificates
 are used by this command.
 
 @item --update-trustdb
 @opindex update-trustdb
 Do trust database maintenance. This command iterates over all keys and
 builds the Web of Trust. This is an interactive command because it may
 have to ask for the "ownertrust" values for keys. The user has to give
 an estimation of how far she trusts the owner of the displayed key to
 correctly certify (sign) other keys. GnuPG only asks for the ownertrust
 value if it has not yet been assigned to a key. Using the
 @option{--edit-key} menu, the assigned value can be changed at any time.
 
 @item --check-trustdb
 @opindex check-trustdb
 Do trust database maintenance without user interaction. From time to
 time the trust database must be updated so that expired keys or
 signatures and the resulting changes in the Web of Trust can be
 tracked. Normally, GnuPG will calculate when this is required and do it
 automatically unless @option{--no-auto-check-trustdb} is set. This
 command can be used to force a trust database check at any time. The
 processing is identical to that of @option{--update-trustdb} but it
 skips keys with a not yet defined "ownertrust".
 
 For use with cron jobs, this command can be used together with
 @option{--batch} in which case the trust database check is done only if
 a check is needed. To force a run even in batch mode add the option
 @option{--yes}.
 
 @anchor{option --export-ownertrust}
 @item --export-ownertrust
 @opindex export-ownertrust
 Send the ownertrust values to STDOUT. This is useful for backup purposes
 as these values are the only ones which can't be re-created from a
 corrupted trustdb.  Example:
 @c man:.RS
 @example
   @gpgname{} --export-ownertrust > otrust.txt
 @end example
 @c man:.RE
 
 
 @item --import-ownertrust
 @opindex import-ownertrust
 Update the trustdb with the ownertrust values stored in @code{files} (or
 STDIN if not given); existing values will be overwritten.  In case of a
 severely damaged trustdb and if you have a recent backup of the
 ownertrust values (e.g., in the file @file{otrust.txt}), you may re-create
 the trustdb using these commands:
 @c man:.RS
 @example
   cd ~/.gnupg
   rm trustdb.gpg
   @gpgname{} --import-ownertrust < otrust.txt
 @end example
 @c man:.RE
 
 
 @item --rebuild-keydb-caches
 @opindex rebuild-keydb-caches
 When updating from version 1.0.6 to 1.0.7 this command should be used
 to create signature caches in the keyring. It might be handy in other
 situations too.
 
 @item --print-md @var{algo}
 @itemx --print-mds
 @opindex print-md
 Print message digest of algorithm @var{algo} for all given files or STDIN.
 With the second form (or a deprecated "*" for @var{algo}) digests for all
 available algorithms are printed.
 
 @item --gen-random @var{0|1|2|16|30} @var{count}
 @opindex gen-random
 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.  The special level 16 uses a quality level of 1 and
 outputs an endless stream of hex-encoded octets.  The special level
 30 outputs random as 30 zBase-32 characters.
 
 @item --gen-prime @var{mode}  @var{bits}
 @opindex gen-prime
 Use the source, Luke :-). The output format is subject to change
 with any release.
 
 
 @item --enarmor
 @itemx --dearmor
 @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.
 The @option{--dearmor} command can also be used to dearmor PEM armors.
 
 @item --unwrap
 @opindex unwrap
 This command is similar to @option{--decrypt} with the difference that the
 output is not the usual plaintext but the original message with the
 encryption layer removed.  Thus the output will be an OpenPGP data
 structure which often means a signed OpenPGP message.  Note that this
 option may or may not remove a compression layer which is often found
 beneath the encryption layer.
 
 @item --tofu-policy @{auto|good|unknown|bad|ask@}  @var{keys}
 @opindex tofu-policy
 Set the TOFU policy for all the bindings associated with the specified
 @var{keys}.  For more information about the meaning of the policies,
 @pxref{trust-model-tofu}.  The @var{keys} may be specified either by their
 fingerprint (preferred) or their keyid.
 
 @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
 
 
 @c ********************************************
 @c *******  KEY MANAGEMENT COMMANDS  **********
 @c ********************************************
 @node OpenPGP Key Management
 @subsection How to manage your keys
 
 This section explains the main commands for key management.
 
 @table @gnupgtabopt
 
 @item --quick-generate-key @var{user-id} [@var{algo} [@var{usage} [@var{expire}]]]
 @itemx --quick-gen-key
 @opindex quick-generate-key
 @opindex quick-gen-key
 This is a simple command to generate a standard key with one user id.
 In contrast to @option{--generate-key} the key is generated directly
 without the need to answer a bunch of prompts.  Unless the option
 @option{--yes} is given, the key creation will be canceled if the
 given user id already exists in the keyring.
 
 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 keyring a second prompt to
 force the creation of the key will show up.
 
 If @var{algo} or @var{usage} are given, only the primary key is
 created and no prompts are shown.  To specify an expiration date but
 still create a primary and subkey use ``default'' or
 ``future-default'' for @var{algo} and ``default'' for @var{usage}.
 For a description of these optional arguments see the command
 @code{--quick-add-key}.  The @var{usage} accepts also the value
 ``cert'' which can be used to create a certification only primary key;
 the default is to a create certification and signing key.
 
 The @var{expire} argument can be used to specify an expiration date
 for the key.  Several formats are supported; commonly the ISO formats
 ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss'' are used.  To make the key
 expire in N seconds, N days, N weeks, N months, or N years use
 ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively.  Not
 specifying a value, or using ``-'' results in a key expiring in a
 reasonable default interval.  The values ``never'', ``none'' can be
 used for no expiration date.
 
 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.
 
 To create an OpenPGP key from the keys available on the currently
 inserted smartcard, the special string ``card'' can be used for
 @var{algo}.  If the card features an encryption and a signing key, gpg
 will figure them out and creates an OpenPGP key consisting of the
 usual primary key and one subkey.  This works only with certain
 smartcards.  Note that the interactive @option{--full-gen-key} command
 allows to do the same but with greater flexibility in the selection of
 the smartcard keys.
 
 Note that it is possible to create a primary key and a subkey using
 non-default algorithms by using ``default'' and changing the default
 parameters using the option @option{--default-new-key-algo}.
 
 @item --quick-set-expire @var{fpr} @var{expire} [*|@var{subfprs}]
 @opindex quick-set-expire
 With two arguments given, directly set the expiration time of the
 primary key identified by @var{fpr} to @var{expire}.  To remove the
 expiration time @code{0} can be used.  With three arguments and the
 third given as an asterisk, the expiration time of all non-revoked and
 not yet expired subkeys are set to @var{expire}.  With more than two
 arguments and a list of fingerprints given for @var{subfprs}, all
 non-revoked subkeys matching these fingerprints are set to
 @var{expire}.
 
 
 @item --quick-add-key @var{fpr} [@var{algo} [@var{usage} [@var{expire}]]]
 @opindex quick-add-key
 Directly add a subkey to the key identified by the fingerprint
 @var{fpr}.  Without the optional arguments an encryption subkey is
 added.  If any of the arguments are given a more specific subkey is
 added.
 
 @var{algo} may be any of the supported algorithms or curve names
 given in the format as used by key listings.  To use the default
 algorithm the string ``default'' or ``-'' can be used.  Supported
 algorithms are ``rsa'', ``dsa'', ``elg'', ``ed25519'', ``cv25519'',
 and other ECC curves.  For example the string ``rsa'' adds an RSA key
 with the default key length; a string ``rsa4096'' requests that the
 key length is 4096 bits.  The string ``future-default'' is an alias
 for the algorithm which will likely be used as default algorithm in
 future versions of gpg.  To list the supported ECC curves the command
 @code{gpg --with-colons --list-config curve} can be used.
 
 Depending on the given @var{algo} the subkey may either be an
 encryption subkey or a signing subkey.  If an algorithm is capable of
 signing and encryption and such a subkey is desired, a @var{usage}
 string must be given.  This string is either ``default'' or ``-'' to
 keep the default or a comma delimited list (or space delimited list)
 of keywords: ``sign'' for a signing subkey, ``auth'' for an
 authentication subkey, and ``encr'' for an encryption subkey
 (``encrypt'' can be used as alias for ``encr'').  The valid
 combinations depend on the algorithm.
 
 The @var{expire} argument can be used to specify an expiration date
 for the key.  Several formats are supported; commonly the ISO formats
 ``YYYY-MM-DD'' or ``YYYYMMDDThhmmss'' are used.  To make the key
 expire in N seconds, N days, N weeks, N months, or N years use
 ``seconds=N'', ``Nd'', ``Nw'', ``Nm'', or ``Ny'' respectively.  Not
 specifying a value, or using ``-'' results in a key expiring in a
 reasonable default interval.  The values ``never'', ``none'' can be
 used for no expiration date.
 
 @item --quick-add-adsk @var{fpr} @var{adskfpr}
 @opindex quick-add-adsk
 Directly add an Additional Decryption Subkey to the key identified by
 the fingerprint @var{fpr}.  @var{adskfpr} is the fingerprint of
 another key's encryption subkey.  A subkey is commonly used here
 because by default a primary key has no encryption capability.  Use
 the option @option{--with-subkey-fingerprint} with a list command to
 display the subkey fingerprints.
 
 @item --generate-key
 @opindex generate-key
 @itemx --gen-key
 @opindex gen-key
 Generate a new key pair using the current default parameters.  This is
 the standard command to create a new key.  In addition to the key a
 revocation certificate is created and stored in the
 @file{openpgp-revocs.d} directory below the GnuPG home directory.
 
 @item --full-generate-key
 @opindex full-generate-key
 @itemx --full-gen-key
 @opindex full-gen-key
 Generate a new key pair with dialogs for all options.  This is an
 extended version of @option{--generate-key}.
 
 There is also a feature which allows you to create keys in batch
 mode. See the manual section ``Unattended key generation'' on how
 to use this.
 
 
 @item --generate-revocation @var{name}
 @opindex generate-revocation
 @itemx --gen-revoke @var{name}
 @opindex gen-revoke
 Generate a revocation certificate for the complete key.  To only revoke
 a subkey or a key signature, use the @option{--edit} command.
 
 This command merely creates the revocation certificate so that it can
 be used to revoke the key if that is ever needed.  To actually revoke
 a key the created revocation certificate needs to be merged with the
 key to revoke.  This is done by importing the revocation certificate
 using the @option{--import} command.  Then the revoked key needs to be
 published, which is best done by sending the key to a keyserver
 (command @option{--send-key}) and by exporting (@option{--export}) it
 to a file which is then send to frequent communication partners.
 
 
 @item --generate-designated-revocation @var{name}
 @opindex generate-designated-revocation
 @itemx --desig-revoke @var{name}
 @opindex desig-revoke
 Generate a designated revocation certificate for a key. This allows a
 user (with the permission of the keyholder) to revoke someone else's
 key.
 
 
 @item --edit-key
 @opindex edit-key
 Present a menu which enables you to do most of the key management
 related tasks.  It expects the specification of a key on the command
 line.
 
 @c ******** Begin Edit-key Options **********
 @table @asis
 
   @item uid @var{n}
   @opindex keyedit:uid
   Toggle selection of user ID or photographic user ID with index @var{n}.
   Use @code{*} to select all and @code{0} to deselect all.
 
   @item key @var{n}
   @opindex keyedit:key
   Toggle selection of subkey with index @var{n} or key ID @var{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 @option{-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
   @option{-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 useful in distinct communities
   or groups to implement the concept of a Trusted Introducer.  For
   more information please read the sections ``Trust Signature'' and
   ``Regular Expression'' in RFC-4880.
 @end table
 
 @c man:.RS
 Note that "l" (for local / non-exportable), "nr" (for non-revocable,
 and "t" (for trust) may be freely mixed and prefixed to "sign" to
 create a signature of any type desired.
 @c man:.RE
 
 If the option @option{--only-sign-text-ids} is specified, then any
 non-text based user ids (e.g., photo IDs) will not be selected for
 signing.
 
 @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.  With the extra
   option @code{selfsig} only self-signatures are shown.
 
   @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 @var{string}
   @opindex keyedit:setpref
   Set the list of user ID preferences to @var{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.  Note that an unattended version of this
   command is available as @option{--quick-update-pref}.
 
   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.
+  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 @var{file}
   @opindex keyedit:bkuptocard
   Restore the given @var{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 keytotpm
   @opindex keyedit:keytotpm
   Transfer the selected secret subkey (or the primary key if no subkey
   has been selected) to TPM form.  The secret key in the keyring will
   be replaced by the TPM representation of that key, which can only be
   read by the particular TPM that created it (so the keyfile now
   becomes locked to the laptop containing the TPM).  Only certain key
   types may be transferred to the TPM (all TPM 2.0 systems are
   mandated to have the rsa2048 and nistp256 algorithms but newer TPMs
   may have more). Note that the key itself is not transferred into the
   TPM, merely encrypted by the TPM in-place, so if the keyfile is
   deleted, the key will be lost.  Once transferred to TPM
   representation, the key file can never be converted back to non-TPM
   form and the key will die when the TPM does, so you should first
   have a backup on secure offline storage of the actual secret key
   file before conversion.  It is essential to use the physical system
   TPM that you have rw permission on the TPM resource manager device
   (/dev/tpmrm0).  Usually this means you must be a member of the tss
   group.
 
   @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}.  Also note that this only
   deletes the public part of a key.
 
   @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 addadsk
   @opindex keyedit:addadsk
   Add an Additional Decryption Subkey.  The user is asked to enter the
   fingerprint of another encryption subkey.  Note that the exact
   fingerprint of another key's encryption subkey needs to be entered.
   This is because commonly the primary key has no encryption
   capability.  Use the option @option{--with-subkey-fingerprint} with
   a list command to display the subkey fingerprints.
 
   @item passwd
   @opindex keyedit:passwd
   Change the passphrase of the secret key.
 
   @item toggle
   @opindex keyedit:toggle
   This is dummy command which exists only for backward compatibility.
 
   @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 change-usage
   @opindex keyedit:change-usage
   Change the usage flags (capabilities) of the primary key or of
   subkeys.  These usage flags (e.g., Certify, Sign, Authenticate,
   Encrypt) are set during key creation.  Sometimes it is useful to
   have the opportunity to change them (for example to add
   Authenticate) after they have been created.  Please take care when
   doing this; the allowed usage flags depend on the key algorithm.
 
   @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 command is only useful to bring
   older keys up to date.
 
   @item save
   @opindex keyedit:save
   Save all changes to the keyring and quit.
 
   @item quit
   @opindex keyedit:quit
   Quit the program without updating the
   keyring.
 @end table
 
 @c man:.RS
 The listing shows you the key with its secondary keys and all user
 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: "trust" is the assigned owner
 trust and "validity" is the calculated validity of the key.  Validity
 values are also displayed for all user IDs.
 For possible values of trust, @pxref{trust-values}.
 @c man:.RE
 @c ******** End Edit-key Options **********
 
 @item --sign-key @var{name}
 @opindex sign-key
 Signs a public key with your secret key. This is a shortcut version of
 the subcommand "sign" from @option{--edit-key}.
 
 @item --lsign-key @var{name}
 @opindex lsign-key
 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 @var{fpr} [@var{names}]
 @itemx --quick-lsign-key @var{fpr} [@var{names}]
 @opindex quick-sign-key
 @opindex quick-lsign-key
 Directly sign a key from the passphrase without any further user
 interaction.  The @var{fpr} must be the verified primary fingerprint
 of a key in the local keyring. If no @var{names} are given, all
 useful user ids are signed; with given [@var{names}] only useful user
 ids matching one of these names are signed.  By default, or if a name
 is prefixed with a '*', a case insensitive substring match is used.
 If a name is prefixed with a '=' a case sensitive exact match is done.
 
 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.  If
 you need to update an existing signature, for example to add or change
 notation data, you need to use the option @option{--force-sign-key}.
 
 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-add-uid  @var{user-id} @var{new-user-id}
 @opindex quick-add-uid
 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 --quick-revoke-uid  @var{user-id} @var{user-id-to-revoke}
 @opindex quick-revoke-uid
 This command revokes a user ID on an existing key.  It cannot be used
 to revoke the last user ID on key (some non-revoked user ID must
 remain), with revocation reason ``User ID is no longer valid''.  If
 you want to specify a different revocation reason, or to supply
 supplementary revocation text, you should use the interactive
 sub-command @code{revuid} of @option{--edit-key}.
 
 @item --quick-revoke-sig  @var{fpr} @var{signing-fpr} [@var{names}]
 @opindex quick-revoke-sig
 This command revokes the key signatures made by @var{signing-fpr} from
 the key specified by the fingerprint @var{fpr}.  With @var{names}
 given only the signatures on user ids of the key matching any of the
 given names are affected (see @option{--quick-sign-key}).  If a
 revocation already exists a notice is printed instead of creating a
 new revocation; no error is returned in this case.  Note that key
 signature revocations may be superseded by a newer key signature and
 in turn again revoked.
 
 @item --quick-set-primary-uid  @var{user-id} @var{primary-user-id}
 @opindex quick-set-primary-uid
 This command sets or updates the primary user ID flag on an existing
 key.  @var{user-id} specifies the key and @var{primary-user-id} the
 user ID which shall be flagged as the primary user ID.  The primary
 user ID flag is removed from all other user ids and the timestamp of
 all affected self-signatures is set one second ahead.
 
 @item --quick-update-pref  @var{user-id}
 @opindex quick-update-pref
 This command updates the preference list of the key to the current
 default value (either built-in or set via
 @option{--default-preference-list}).  This is the unattended version
 of of using "setpref" in the @option{--key-edit} menu without giving a
 list.  Note that you can show the preferences in a key listing by
 using @option{--list-options show-pref} or @option{--list-options
 show-pref-verbose}.  You should also re-distribute updated keys to
 your peers.
 
 @item --change-passphrase @var{user-id}
 @opindex change-passphrase
 @itemx --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 @option{--edit-key} menu.  When using together with the
 option @option{--dry-run} this will not actually change the passphrase
 but check that the current passphrase is correct.
 
 @end table
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  OPTIONS   ****************
 @c ***************            ****************
 @c *******************************************
 @mansect options
 @node GPG Options
 @section Option Summary
 
 @command{@gpgname} features a bunch of options to control the exact
 behaviour and to change the default configuration.
 
 @menu
 * GPG Configuration Options::   How to change the 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 doesn't want to do.
 * Deprecated Options::          Deprecated options.
 @end menu
 
 Long options can be put in an options file (default
-"~/.gnupg/gpg.conf"). Short option names will not work - for example,
-"armor" is a valid option for the options file, while "a" is not. Do not
-write the 2 dashes, but simply the name of the option and any required
-arguments. Lines with a hash ('#') as the first non-white-space
-character are ignored. Commands may be put in this file too, but that is
-not generally useful as the command will execute automatically with
-every execution of gpg.
+"~/.gnupg/gpg.conf"). Short option names will not work --- for
+example, "armor" is a valid option for the options file, while "a" is
+not. Do not write the 2 dashes, but simply the name of the option and
+any required arguments. Lines with a hash ('#') as the first
+non-white-space character are ignored. Commands may be put in this
+file too, but that is not generally useful as the command will execute
+automatically with every execution of gpg.
 
 Please remember that option parsing stops as soon as a non-option is
 encountered, you can explicitly stop parsing by using the special option
 @option{--}.
 
 @c *******************************************
 @c ********  CONFIGURATION OPTIONS  **********
 @c *******************************************
 @node GPG Configuration Options
 @subsection How to change the configuration
 
 These options are used to change the configuration and most of them
 are usually found in the option file.
 
 @table @gnupgtabopt
 
 @item --default-key @var{name}
 @opindex default-key
 Use @var{name} as the default key to sign with. If this option is not
 used, the default key is the first key found in the secret keyring.
 Note that @option{-u} or @option{--local-user} overrides this option.
 This option may be given multiple times.  In this case, the last key
 for which a secret key is available is used.  If there is no secret
 key available for any of the specified values, GnuPG will not emit an
 error message but continue as if this option wasn't given.
 
 @item --default-recipient @var{name}
 @opindex default-recipient
 Use @var{name} as default recipient if option @option{--recipient} is
 not used and don't ask if this is a valid one. @var{name} must be
 non-empty.
 
 @item --default-recipient-self
 @opindex default-recipient-self
 Use the default key as default recipient if option @option{--recipient} is not
 used and don't ask if this is a valid one. The default key is the first
 one from the secret keyring or the one set with @option{--default-key}.
 
 @item --no-default-recipient
 @opindex no-default-recipient
 Reset @option{--default-recipient} and @option{--default-recipient-self}.
 Should not be used in an option file.
 
 @item -v, --verbose
 @opindex verbose
 Give more information during processing. If used
 twice, the input data is listed in detail.
 
 @item --no-verbose
 @opindex no-verbose
 Reset verbose level to 0.  Should not be used in an option file.
 
 @item -q, --quiet
 @opindex quiet
 Try to be as quiet as possible.  Should not be used in an option file.
 
 @item --batch
 @itemx --no-batch
 @opindex batch
 @opindex no-batch
 Use batch mode.  Never ask, do not allow interactive commands.
 @option{--no-batch} disables this option.  Note that even with a
 filename given on the command line, gpg might still need to read from
 STDIN (in particular if gpg figures that the input is a
 detached signature and no data file has been specified).  Thus if you
 do not want to feed data via STDIN, you should connect STDIN to
 @file{/dev/null}.
 
 It is highly recommended to use this option along with the options
 @option{--status-fd} and @option{--with-colons} for any unattended use of
 @command{gpg}.  Should not be used in an option file.
 
 @item --no-tty
 @opindex no-tty
 Make sure that the TTY (terminal) is never used for any output.
 This option is needed in some cases because GnuPG sometimes prints
 warnings to the TTY even if @option{--batch} is used.
 
 @item --yes
 @opindex yes
 Assume "yes" on most questions.  Should not be used in an option file.
 
 @item --no
 @opindex no
 Assume "no" on most questions.  Should not be used in an option file.
 
 
 @item --list-filter @{select=@var{expr}@}
 @opindex list-filter
 A list filter can be used to output only certain keys during key
 listing commands. For the available property names, see the description
 of @option{--import-filter}.
 
 
 @item --list-options @var{parameters}
 @opindex list-options
 This is a space or comma delimited string that gives options used when
 listing keys and signatures (that is, @option{--list-keys},
 @option{--check-signatures}, @option{--list-public-keys},
 @option{--list-secret-keys}, and the @option{--edit-key} functions).
 Options can be prepended with a @option{no-} (after the two dashes) to
 give the opposite meaning.  The options are:
 
 @table @asis
 
   @item show-photos
   @opindex list-options:show-photos
   Causes @option{--list-keys}, @option{--check-signatures},
   @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 yes.
 
   @item show-policy-urls
   @opindex list-options:show-policy-urls
   Show policy URLs in the  @option{--check-signatures}
   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{--check-signatures} listings. Defaults to no.
 
   @item show-keyserver-urls
   @opindex list-options:show-keyserver-urls
   Show any preferred keyserver URL in the
   @option{--check-signatures} 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 yes.
 
   @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-unusable-sigs
   @opindex list-options:show-unusable-sigs
   Show key signature made using weak or unsupported algorithms.
 
   @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{--check-signatures} 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{--check-signatures}.
 
   @item show-only-fpr-mbox
   @opindex list-options:show-only-fpr-mbox
   For each user-id which has a valid mail address print
   only the fingerprint followed by the mail address.
 
   @item sort-sigs
   @opindex list-options:sort-sigs
   With @option{--list-sigs} and @option{--check-sigs} sort the
   signatures by keyID and creation time to make it easier to view the
   history of these signatures.  The self-signature is also listed
   before other signatures. Defaults to yes.
 
 @end table
 
 @item --verify-options @var{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
   @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 yes.
 
   @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 yes.
 
   @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 yes.
 
   @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.
 
 @end table
 
 @item --enable-large-rsa
 @itemx --disable-large-rsa
 @opindex enable-large-rsa
 @opindex disable-large-rsa
 With @option{--generate-key} and @option{--batch}, enable the creation
 of RSA secret keys as large as 8192 bit.  Note: 8192 bit is more than
 is generally recommended.  These large keys don't significantly
 improve security, but they are more expensive to use, and their
 signatures and certifications are larger.  This option is only
 available if the binary was build with large-secmem support.
 
 @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 @var{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.
 
 On Unix the default viewer is
 @code{xloadimage -fork -quiet -title 'KeyID 0x%k' STDIN}
 with a fallback to
 @code{display -title 'KeyID 0x%k' %i}
 and finally to
 @code{xdg-open %i}.
 On Windows
 @code{!ShellExecute 400 %i} is used; here the command is a meta
 command to use that API call followed by a wait time in milliseconds
 which is used to give the viewer time to read the temporary image file
 before gpg deletes it again.  Note that if your image viewer program
 is not secure, then executing it from gpg does not make it secure.
 
 @item --exec-path @var{string}
 @opindex exec-path
 @efindex PATH
 Sets a list of directories to search for photo viewers If not provided
 photo viewers use the @code{PATH} environment variable.
 
 @item --keyring @var{file}
 @opindex keyring
 Add @var{file} to the current list of keyrings. If @var{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 ("~/.gnupg" unless @option{--homedir} or $GNUPGHOME is
 used).
 
 Note that this adds a keyring to the current list. If the intent is to
 use the specified keyring alone, use @option{--keyring} along with
 @option{--no-default-keyring}.
 
 If the option @option{--no-keyring} has been used no keyrings will
 be used at all.
 
 Note that if the option @option{use-keyboxd} is enabled in
 @file{common.conf}, no keyrings are used at all and keys are all
 maintained by the keyboxd process in its own database.
 
 @item --primary-keyring @var{file}
 @opindex primary-keyring
 This is a varian of @option{--keyring} and designates @var{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 --secret-keyring @var{file}
 @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 --trustdb-name @var{file}
 @opindex trustdb-name
 Use @var{file} instead of the default trustdb. If @var{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).
 
 @include opt-homedir.texi
 
 
 @item --display-charset @var{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
 encrypted or signed; GnuPG does not recode user-supplied data. If this
 option is not used, the default character set is determined from the
 current locale. A verbosity level of 3 shows the chosen set.  This
 option should not be used on Windows.  Valid values for @var{name}
 are:
 
 @table @asis
 
   @item iso-8859-1
   @opindex display-charset:iso-8859-1
   This is the Latin 1 set.
 
   @item iso-8859-2
   @opindex display-charset:iso-8859-2
   The Latin 2 set.
 
   @item iso-8859-15
   @opindex display-charset:iso-8859-15
   This is currently an alias for
   the Latin 1 set.
 
   @item koi8-r
   @opindex display-charset:koi8-r
   The usual Russian set (RFC-1489).
 
   @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 UTF-8 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.
 This option should not be used in an option file.
 
 This option has no effect on Windows.  There the internal used UTF-8
 encoding is translated for console input and output.  The command line
 arguments are expected as Unicode and translated to UTF-8.  Thus when
 calling this program from another, make sure to use the Unicode
 version of CreateProcess.
 
 @anchor{gpg-option --options}
 @item --options @var{file}
 @opindex options
 Read options from @var{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 @var{n}
 @itemx --compress-level @var{n}
 @itemx --bzip2-compress-level @var{n}
 @itemx --no-compress
 @opindex compress-level
 @opindex bzip2-compress-level
 @opindex no-compress
 Set compression level to @var{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
 for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
 different option from @option{--compress-level} since BZIP2 uses a
 significant amount of memory for each additional compression level.
 
 Option @option{-z} sets both. A value of 0 for @var{n} disables
 compression.  A value of -1 forces compression using the default
 level.  Option @option{--no-compress} is identical to @option{-z0}.
 
 Except for the @option{--store} command compression is always used
 unless @command{gpg} detects that the input is already compressed.  To
 inhibit the use of compression use @option{-z0} or
 @option{--no-compress}; to force compression use @option{-z-1} or
 option @option{z} with another compression level than the default as
 indicated by -1.  Note that this overriding of the default deection
 works only with @option{z} and not with the long variant of this
 option.
 
 
 @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
 circumstances when the file was originally compressed at a high
 @option{--bzip2-compress-level}.
 
 
 @item --mangle-dos-filenames
 @itemx --no-mangle-dos-filenames
 @opindex mangle-dos-filenames
 @opindex no-mangle-dos-filenames
 Older version of Windows cannot handle filenames with more than one
 dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
 than add to) the extension of an output filename to avoid this
 problem. This option is off by default and has no effect on non-Windows
 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
 information on the specific levels and how they are
 used. @option{--no-ask-cert-level} disables this option. This option
 defaults to no.
 
 @item --default-cert-level @var{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
 the key.
 
 1 means you believe the key is owned by the person who claims to own
 it but you could not, or did not verify the key at all. This is
 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 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
 could mean that you verified the key fingerprint with the owner of the
 key in person, and that you checked, by means of a hard to forge
 document with a photo ID (such as a passport) that the name of the key
 owner matches the name in the user ID on the key, and finally that you
 verified (by exchange of email) that the email address on the key
 belongs to the key owner.
 
 Note that the examples given above for levels 2 and 3 are just that:
 examples. In the end, it is up to you to decide just what "casual"
 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 @var{long key ID or fingerprint}
 @opindex trusted-key
 Assume that the specified key (which should be given as fingerprint)
 is as trustworthy as one of your own secret keys. This option is
 useful if you don't want to keep your secret keys (or one of them)
 online but still want to be able to check the validity of a given
 recipient's or signator's key.  If the given key is not locally
 available but an LDAP keyserver is configured the missing key is
 imported from that server.
 
 @item --add-desig-revoker [sensitive:]@var{fingerprint}
 @opindex add-desig-revoker
 Add the key specified by @var{fingerprint} as a designated revoker to
 newly created keys.  If the fingerprint is prefixed with the keyword
 ``sensitive:'' that info is normally not exported wit the key.  This
 option may be given several time to add more than one designated
 revoker.  If the keyword ``clear'' is used instead of a fingerprint,
 all designated options previously encountered are discarded.
 Designated revokers are marked on the key as non-revocable.  Note that
 a designated revoker specified using a parameter file will also be
 added to the key.
 
 
 @item --trust-model @{pgp|classic|tofu|tofu+pgp|direct|always|auto@}
 @opindex trust-model
 Set what trust model GnuPG should follow. The models are:
 
 @table @asis
 
   @item pgp
   @opindex trust-model: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-model:classic
   This is the standard Web of Trust as introduced by PGP 2.
 
   @item tofu
   @opindex trust-model:tofu
   @anchor{trust-model-tofu}
   TOFU stands for Trust On First Use.  In this experimental trust
   model, the first
   time a key is seen, it is memorized.  If later another key with a
   user id with the same email address is seen, both keys are marked as
   suspect.  In that case, the next time either is used, a warning is
   displayed describing the conflict, why it might have occurred
   (either the user generated a new key and failed to cross sign the
   old and new keys, the key is forgery, or a man-in-the-middle attack
   is being attempted), and the user is prompted to manually confirm
   the validity of the key in question.
 
   Because a potential attacker is able to control the email address
   and thereby circumvent the conflict detection algorithm by using an
   email address that is similar in appearance to a trusted email
   address, whenever a message is verified, statistics about the number
   of messages signed with the key are shown.  In this way, a user can
   easily identify attacks using fake keys for regular correspondents.
 
   When compared with the Web of Trust, TOFU offers significantly
   weaker security guarantees.  In particular, TOFU only helps ensure
   consistency (that is, that the binding between a key and email
   address doesn't change).  A major advantage of TOFU is that it
   requires little maintenance to use correctly.  To use the web of
   trust properly, you need to actively sign keys and mark users as
   trusted introducers.  This is a time-consuming process and anecdotal
   evidence suggests that even security-conscious users rarely take the
   time to do this thoroughly and instead rely on an ad-hoc TOFU
   process.
 
   In the TOFU model, policies are associated with bindings between
   keys and email addresses (which are extracted from user ids and
   normalized).  There are five policies, which can be set manually
   using the @option{--tofu-policy} option.  The default policy can be
   set using the @option{--tofu-default-policy} option.
 
   The TOFU policies are: @code{auto}, @code{good}, @code{unknown},
   @code{bad} and @code{ask}.  The @code{auto} policy is used by
   default (unless overridden by @option{--tofu-default-policy}) and
   marks a binding as marginally trusted.  The @code{good},
   @code{unknown} and @code{bad} policies mark a binding as fully
   trusted, as having unknown trust or as having trust never,
   respectively.  The @code{unknown} policy is useful for just using
   TOFU to detect conflicts, but to never assign positive trust to a
   binding.  The final policy, @code{ask} prompts the user to indicate
   the binding's trust.  If batch mode is enabled (or input is
   inappropriate in the context), then the user is not prompted and the
   @code{undefined} trust level is returned.
 
   @item tofu+pgp
   @opindex trust-model:tofu+pgp
   This experimental trust model combines TOFU with the Web of Trust.
   This is done
   by computing the trust level for each model and then taking the
   maximum trust level where the trust levels are ordered as follows:
   @code{unknown < undefined < marginal < fully < ultimate < expired <
   never}.
 
   By setting @option{--tofu-default-policy=unknown}, this model can be
   used to implement the web of trust with TOFU's conflict detection
   algorithm, but without its assignment of positive trust values,
   which some security-conscious users don't like.
 
   @item direct
   @opindex trust-model:direct
   Key validity is set directly by the user and not calculated via the
   Web of Trust.  This model is solely based on the key and does
   not distinguish user IDs.  Note that when changing to another trust
   model the trust values assigned to a key are transformed into
   ownertrust values, which also indicate how you trust the owner of
   the key to sign other keys.
 
   @item always
   @opindex trust-model: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-model:auto
   Select the trust model depending on whatever the internal trust
   database says. This is the default model if such a database already
   exists.  Note that a tofu trust model is not considered here and
   must be enabled explicitly.
 @end table
 
 @item --always-trust
 @opindex always-trust
 Identical to @option{--trust-model always}.
 
 @item --assert-signer @var{fpr_or_file}
 @opindex assert-signer
 This option checks whether at least one valid signature on a file has
 been made with the specified key.  The key is either specified as a
 fingerprint or a file listing fingerprints.  The fingerprint must be
 given or listed in compact format (no colons or spaces in between).
 This option can be given multiple times and each fingerprint is
 checked against the signing key as well as the corresponding primary
 key.  If @var{fpr_or_file} specifies a file, empty lines are ignored
 as well as all lines starting with a hash sign.  With this option gpg
 is guaranteed to return with an exit code of 0 if and only if a
 signature has been encountered, is valid, and the key matches one of
 the fingerprints given by this option.
 
 
 @item --auto-key-locate @var{mechanisms}
 @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 the local keyring.  This option takes any number of the mechanisms
 listed below, in the order they are to be tried.  Instead of listing
 the mechanisms as comma delimited arguments, the option may also be
 given several times to add more mechanism.  The option
 @option{--no-auto-key-locate} or the mechanism "clear" resets the
 list.  The default is "local,wkd".
 
 @table @asis
 
   @item cert
   Locate a key using DNS CERT, as specified in RFC-4398.
 
   @item dane
   Locate a key using DANE, as specified
   in draft-ietf-dane-openpgpkey-05.txt.
 
   @item wkd
   Locate a key using the Web Key Directory protocol.
 
   @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 ntds
   Locate the key using the Active Directory (Windows only).  This
   method also allows to search by fingerprint using the command
   @option{--locate-external-key}.  Note that this mechanism is
   actually a shortcut for the mechanism @samp{keyserver} but using
   "ldap:///" as the keyserver.
 
   @item keyserver
   Locate a key using a keyserver.  This method also allows to search
   by fingerprint using the command @option{--locate-external-key} if
   any of the configured keyservers is an LDAP server.
 
   @item keyserver-URL
   In addition, a keyserver URL as used in the @command{dirmngr}
   configuration may be used here to query that particular keyserver.
   This method also allows to search by fingerprint using the command
   @option{--locate-external-key} if the URL specifies an LDAP server.
 
   @item local
   Locate the key using the local keyrings.  This mechanism allows the user 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 clear
   Clear all defined mechanisms.  This is useful to override
   mechanisms given in a config file.  Note that a @code{nodefault} in
   @var{mechanisms} will also be cleared unless it is given after the
   @code{clear}.
 
 @end table
 
 
 @item --auto-key-import
 @itemx --no-auto-key-import
 @opindex auto-key-import
 @opindex no-auto-key-import
 This is an offline mechanism to get a missing key for signature
 verification and for later encryption to this key.  If this option is
 enabled and a signature includes an embedded key, that key is
 used to verify the signature and on verification success the key is
 imported. The default is @option{--no-auto-key-import}.
 
 On the sender (signing) site the option @option{--include-key-block}
 needs to be used to put the public part of the signing key as “Key
 Block subpacket” into the signature.
 
 @item --auto-key-retrieve
 @itemx --no-auto-key-retrieve
 @opindex auto-key-retrieve
 @opindex no-auto-key-retrieve
 These options enable or disable the automatic retrieving of keys from
 a keyserver when verifying signatures made by keys that are not on the
 local keyring.  The default is @option{--no-auto-key-retrieve}.
 
 The order of methods tried to lookup the key is:
 
 1. If the option @option{--auto-key-import} is set and the signatures
 includes an embedded key, that key is used to verify the signature and
 on verification success that key is imported.
 
 2. If a preferred keyserver is specified in the signature and the
 option @option{honor-keyserver-url} is active (which is not the
 default), that keyserver is tried.  Note that the creator of the
 signature uses the option @option{--sig-keyserver-url} to specify the
 preferred keyserver for data signatures.
 
 3. If the signature has the Signer's UID set (e.g., using
 @option{--sender} while creating the signature) a Web Key Directory
 (WKD) lookup is done.  This is the default configuration but can be
 disabled by removing WKD from the auto-key-locate list or by using the
 option @option{--disable-signer-uid}.
 
 4. If any keyserver is configured and the Issuer Fingerprint is part
 of the signature (since GnuPG 2.1.16), the configured keyservers are
 tried.
 
 Note that this option makes a "web bug" like behavior possible.
 Keyserver or Web Key Directory 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 --keyid-format @{none|short|0xshort|long|0xlong@}
 @opindex keyid-format
 Select how to display key IDs.  "none" does not show the key ID at all
 but shows the fingerprint in a separate line.  "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.  Note that this
 option is ignored if the option @option{--with-colons} is used.
 
 @item --keyserver @var{name}
 @opindex keyserver
-This option is deprecated - please use the @option{--keyserver} in
+This option is deprecated --- please use the @option{--keyserver} in
 @file{dirmngr.conf} instead.
 
 Use @var{name} as your keyserver. This is the server that
 @option{--receive-keys}, @option{--send-keys}, and @option{--search-keys}
 will communicate with to receive keys from, send keys to, and search for
 keys on. The format of the @var{name} is a URI:
 `scheme:[//]keyservername[:port]' The scheme is the type of keyserver:
 "hkp"/"hkps" for the HTTP (or compatible) keyservers or "ldap"/"ldaps"
 for the LDAP keyservers.  Note that your particular installation of
 GnuPG may have other keyserver types available as well. Keyserver
 schemes are case-insensitive.
 
 Most keyservers synchronize with each other, so there is generally no
 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 @{@var{name}=@var{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
 well to apply to importing (@option{--recv-key}) or exporting
 (@option{--send-key}) a key from a keyserver. While not all options
 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 is an obsolete alias for the option @option{auto-key-retrieve}.
   Please do not use it; it will be removed in future versions..
 
   @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 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
   @itemx http-proxy=@var{value}
   @itemx verbose
   @itemx debug
   @itemx check-cert
   @item ca-cert-file
   These options have no more function since GnuPG 2.1.  Use the
   @code{dirmngr} configuration options instead.
 
 @end table
 
 The default list of options is: "self-sigs-only, import-clean,
 repair-keys, repair-pks-subkey-bug, export-attributes". However, if
 the actual used source is an LDAP server "no-self-sigs-only" is
 assumed unless "self-sigs-only" has been explicitly configured.
 
 
 @item --completes-needed @var{n}
 @opindex compliant-needed
 Number of completely trusted users to introduce a new
 key signer (defaults to 1).
 
 @item --marginals-needed @var{n}
 @opindex marginals-needed
 Number of marginally trusted users to introduce a new
 key signer (defaults to 3)
 
 @item --tofu-default-policy @{auto|good|unknown|bad|ask@}
 @opindex tofu-default-policy
 The default TOFU policy (defaults to @code{auto}).  For more
 information about the meaning of this option, @pxref{trust-model-tofu}.
 
 @item --max-cert-depth @var{n}
 @opindex max-cert-depth
 Maximum depth of a certification chain (default is 5).
 
 @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 safe against write
 modifications, you can use this option to disable the caching. It
 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 --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
 process. @option{--no-auto-check-trustdb} disables this option.
 
 @item --use-agent
 @itemx --no-use-agent
 @opindex use-agent
 This is dummy option. @command{@gpgname} always requires the agent.
 
 @item --gpg-agent-info
 @opindex gpg-agent-info
 This is dummy option. It has no effect when used with @command{@gpgname}.
 
 
 @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}.
 
 @item --disable-dirmngr
 Entirely disable the use of the Dirmngr.
 
 @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
 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
 change won't break applications which close their end of a status fd
 connected pipe too early. Using this option along with
 @option{--enable-progress-filter} may be used to cleanly cancel long
 running gpg operations.
 
 @item --limit-card-insert-tries @var{n}
 @opindex limit-card-insert-tries
 With @var{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
 option is useful in the configuration file in case an application does
 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
 certain common permission problems. Do not assume that the lack of a
 warning means that your system is secure.
 
 Note that the warning for unsafe @option{--homedir} permissions cannot be
 suppressed in the gpg.conf file, as this would allow an attacker to
 place an unsafe gpg.conf file in place, and use this file to suppress
 warnings about itself. The @option{--homedir} permissions warning may only be
 suppressed on the command line.
 
 @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.
 Defaults to @option{--require-cross-certification} for
 @command{@gpgname}.
 
 @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
 warning messages about potentially incompatible actions. As the name
 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
 
 
 @c *******************************************
 @c ********  KEY RELATED OPTIONS  ************
 @c *******************************************
 @node GPG Key related Options
 @subsection Key related options
 
 @table @gnupgtabopt
 
 @item --recipient @var{name}
 @itemx -r
 @opindex recipient
 Encrypt for user id @var{name}. If this option or
 @option{--hidden-recipient} is not specified, GnuPG asks for the user-id
 unless @option{--default-recipient} is given.
 
 @item --hidden-recipient @var{name}
 @itemx -R
 @opindex hidden-recipient
 Encrypt for user ID @var{name}, but hide the key ID of this user's
 key. This option helps to hide the receiver of the message and is a
 limited countermeasure against traffic analysis. If this option or
 @option{--recipient} is not specified, GnuPG asks for the user ID unless
 @option{--default-recipient} is given.
 
 @item --recipient-file @var{file}
 @itemx -f
 @opindex recipient-file
 This option is similar to @option{--recipient} except that it
 encrypts to a key stored in the given file.  @var{file} must be the
 name of a file containing exactly one key.  @command{@gpgname} assumes that
 the key in this file is fully valid.
 
 @item --hidden-recipient-file @var{file}
 @itemx -F
 @opindex hidden-recipient-file
 This option is similar to @option{--hidden-recipient} except that it
 encrypts to a key stored in the given file.  @var{file} must be the
 name of a file containing exactly one key.  @command{@gpgname} assumes that
 the key in this file is fully valid.
 
 @item --encrypt-to @var{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
 recipients given either by use of @option{--recipient} or by the asked
 user id.  No trust checking is performed for these user ids and even
 disabled keys can be used.
 
 @item --hidden-encrypt-to @var{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
 recipients given either by use of @option{--recipient} or by the asked user id.
 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 @{@var{name}=@var{value}@}
 @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
 specified. Multiple groups with the same name are automatically merged
 into a single group.
 
 The values are @code{key IDs} or fingerprints, but any key description
 is accepted. Note that a value with spaces in it will be treated as
 two different values. Note also there is only one level of expansion
 --- you cannot make an group that points to another group. When used
 from the command line, it may be necessary to quote the argument to
 this option to prevent the shell from treating it as multiple
 arguments.
 
 @item --ungroup @var{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}
 @itemx -u
 @opindex local-user
 Use @var{name} as the key to sign with. Note that this option overrides
 @option{--default-key}.
 
 @item --sender @var{mbox}
 @opindex sender
 This option has two purposes.  @var{mbox} must either be a complete
 user ID containing a proper mail address or just a plain mail address.
 The option can be given multiple times.
 
 When creating a signature this option tells gpg the signing key's user
 id used to make the signature and embeds that user ID into the created
 signature (using OpenPGP's ``Signer's User ID'' subpacket).  If the
 option is given multiple times a suitable user ID is picked.  However,
 if the signing key was specified directly by using a mail address
 (i.e., not by using a fingerprint or key ID) this option is used and
 the mail address is embedded in the created signature.
 
 When verifying a signature @var{mbox} is used to restrict the
 information printed by the TOFU code to matching user IDs.  If the
 option is used and the signature contains a ``Signer's User ID''
 subpacket that information is is also used to restrict the printed
 information.  Note that GnuPG considers only the mail address part of
 a User ID.
 
 If this option or the said subpacket is available the TRUST lines as
 printed by option @option{status-fd} correspond to the corresponding
 User ID; if no User ID is known the TRUST lines are computed directly
 on the key and do not give any information about the User ID.  In the
 latter case it his highly recommended to scripts and other frontends
 to evaluate the VALIDSIG line, retrieve the key and print all User IDs
 along with their validity (trust) information.
 
 
 @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 setting 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} 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
 @opindex skip-hidden-recipients
 @opindex no-skip-hidden-recipients
 During decryption skip all anonymous recipients.  This option helps in
 the case that people use the hidden recipients feature to hide their
 own encrypt-to key from others.  If one has many secret keys this
 may lead to a major annoyance because all keys are tried in turn to
 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.
 
 
 @end table
 
 @c *******************************************
 @c ********  INPUT AND OUTPUT  ***************
 @c *******************************************
 @node GPG Input and Output
 @subsection Input and Output
 
 @table @gnupgtabopt
 
 @item --armor
 @itemx -a
 @opindex armor
 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}
 @itemx -o @var{file}
 @opindex output
 Write output to @var{file}.  To write to stdout use @code{-} as the
 filename.
 
 @item --max-output @var{n}
 @opindex max-output
 This option sets a limit on the number of bytes that will be generated
 when processing a file. Since OpenPGP supports various levels of
 compression, it is possible that the plaintext of a given message may be
 significantly larger than the original OpenPGP message. While GnuPG
 works properly with such messages, there is often a desire to set a
 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 --chunk-size @var{n}
 @opindex chunk-size
 The AEAD encryption mode encrypts the data in chunks so that a
 receiving side can check for transmission errors or tampering at the
 end of each chunk and does not need to delay this until all data has
 been received.  The used chunk size is 2^@var{n} byte.  The lowest
 allowed value for @var{n} is 6 (64 byte) and the largest is the
 default of 22 which creates chunks not larger than 4 MiB.
 
 @item --input-size-hint @var{n}
 @opindex input-size-hint
 This option can be used to tell GPG the size of the input data in
 bytes.  @var{n} must be a positive base-10 number.  This option is
 only useful if the input is not taken from a file.  GPG may use this
 hint to optimize its buffer allocation strategy.  It is also used by
 the @option{--status-fd} line ``PROGRESS'' to provide a value for
 ``total'' if that is not available by other means.
 
 @item --key-origin @var{string}[,@var{url}]
 @opindex key-origin
 gpg can track the origin of a key. Certain origins are implicitly
 known (e.g., keyserver, web key directory) and set.  For a standard
 import the origin of the keys imported can be set with this option.
 To list the possible values use "help" for @var{string}.  Some origins
 can store an optional @var{url} argument.  That URL can appended to
 @var{string} after a comma.
 
 @item --import-options @var{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 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 achieved 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{--receive-keys}.
 
   @item import-show
   @itemx show-only
   Show a listing of the key as imported right before it is stored.
   This can be combined with the option @option{--dry-run} to only look
   at keys; the option @option{show-only} is a shortcut for this
   combination.  The command @option{--show-keys} is another shortcut
   for this.  Note that suffixes like '#' for "sec" and "sbb" lines
   may or may not be printed.
 
   @item import-export
   Run the entire import code but instead of storing the key to the
   local keyring write it to the output.  The export option
   @option{export-dane} affect the output.  This option can for example
   be used to remove all invalid parts from a key without the
   need to store it.
 
   @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 self-sigs-only
   Accept only self-signatures while importing a key.  All other key
   signatures are skipped at an early import stage.  This option can be
   used with @code{keyserver-options} to mitigate attempts to flood a
   key with bogus signatures from a keyserver.  The drawback is that
   all other valid key signatures, as required by the Web of Trust are
   also not imported.  Note that when using this option along with
   import-clean it suppresses the final clean step after merging the
   imported key into the existing key.
 
   @item repair-keys
   After import, fix various problems with the
   keys.  For example, this reorders signatures, and strips duplicate
   signatures.  Defaults to yes.
 
   @item bulk-import
   When used the keyboxd (option @option{use-keyboxd} in @file{common.conf})
   does the import within a single
   transaction.
 
   @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 restore
   @itemx import-restore
   Import in key restore mode.  This imports all data which is usually
   skipped during import; including all GnuPG specific data.  All other
   contradicting options are overridden.
 @end table
 
 @item --import-filter @{@var{name}=@var{expr}@}
 @itemx --export-filter @{@var{name}=@var{expr}@}
 @opindex import-filter
 @opindex export-filter
 These options define an import/export filter which are applied to the
 imported/exported keyblock right before it will be stored/written.
 @var{name} defines the type of filter to use, @var{expr} the
 expression to evaluate.  The option can be used several times which
 then appends more expression to the same @var{name}.
 
 @noindent
 The available filter types are:
 
 @table @asis
 
   @item keep-uid
   This filter will keep a user id packet and its dependent packets in
   the keyblock if the expression evaluates to true.
 
   @item drop-subkey
   This filter drops the selected subkeys.
   Currently only implemented for @option{--export-filter}.
 
   @item drop-sig
   This filter drops the selected key signatures on user ids.
   Self-signatures are not considered.
   Currently only implemented for @option{--import-filter}.
 
   @item select
   This filter is only implemented by @option{--list-filter}.  All
   property names may be used.
 
 @end table
 
 For the syntax of the expression see the chapter "FILTER EXPRESSIONS".
 The property names for the expressions depend on the actual filter
 type and are indicated in the following table.  Note that all property
 names may also be used by @option{--list-filter}.
 
 Property names may be prefix with a scope delimited by a slash.  Valid
 scopes are "pub" for public and secret primary keys, "sub" for public
 and secret subkeys, "uid" for for user-ID packets, and "sig" for
 signature packets.  Invalid scopes are currently ignored.
 
 The available properties are:
 
 @table @asis
 
   @item uid
   A string with the user id.  (keep-uid)
 
   @item mbox
   The addr-spec part of a user id with mailbox or the empty string.
   (keep-uid)
 
   @item algostr
   A string with the key algorithm description.  For example "rsa3072"
   or "ed25519".
 
   @item key_algo
   A number with the public key algorithm of a key or subkey packet.
   (drop-subkey)
 
   @item key_size
   A number with the effective key size of a key or subkey packet.
   (drop-subkey)
 
   @item key_created
   @itemx key_created_d
   The first is the timestamp a public key or subkey packet was
   created.  The second is the same but given as an ISO string,
   e.g., "2016-08-17". (drop-subkey)
 
   @item key_expires
   @itemx key_expires_d
   The expiration time of a public key or subkey or 0 if it does not
   expire.  The second is the same but given as an ISO date string or
   an empty string e.g., "2038-01-19".
 
   @item fpr
   The hexified fingerprint of the current subkey or primary key.
   (drop-subkey)
 
   @item primary
   Boolean indicating whether the user id is the primary one.  (keep-uid)
 
   @item expired
   Boolean indicating whether a user id (keep-uid), a key (drop-subkey), or a
   signature (drop-sig) expired.
 
   @item revoked
   Boolean indicating whether a user id (keep-uid) or a key (drop-subkey) has
   been revoked.
 
   @item disabled
   Boolean indicating whether a primary key is disabled.
 
   @item secret
   Boolean indicating whether a key or subkey is a secret one.
   (drop-subkey)
 
   @item usage
   A string indicating the usage flags for the subkey, from the
   sequence ``ecsa?''.  For example, a subkey capable of just signing
   and authentication would be an exact match for ``sa''. (drop-subkey)
 
   @item sig_created
   @itemx sig_created_d
   The first is the timestamp a signature packet was created.  The
   second is the same but given as an ISO date string,
   e.g., "2016-08-17". (drop-sig)
 
   @item sig_algo
   A number with the public key algorithm of a signature packet. (drop-sig)
 
   @item sig_digest_algo
   A number with the digest algorithm of a signature packet. (drop-sig)
 
   @item origin
   A string with the key origin or a question mark.  For example the
   string ``wkd'' is used if a key originated from a Web Key Directory
   lookup.
 
   @item lastupd
   The timestamp the key was last updated from a keyserver or the Web
   Key Directory.
 
   @item url
   A string with the the URL associated wit the last key lookup.
 
 @end table
 
 @item --export-options @var{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. Not
   including attribute user IDs is useful to export keys that 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 backup
   @itemx export-backup
   Export for use as a backup.  The exported data includes all data
   which is needed to restore the key or keys later with GnuPG.  The
   format is basically the OpenPGP format but enhanced with GnuPG
   specific data.  All other contradicting options are overridden.
 
   @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-revocs
   Export only standalone revocation certificates of the key.  This
   option does not export revocations of 3rd party certificate
   revocations.
 
   @item export-dane
   Instead of outputting the key material output OpenPGP DANE 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 mode1003
   Enable the use of a new secret key export format.  This format
   avoids the re-encryption as required with the current OpenPGP format
   and also improves the security of the secret key if it has been
   protected with a passphrase.  Note that an unprotected key is
   exported as-is and thus not secure; the general rule to convey
   secret keys in an OpenPGP encrypted file still applies with this
   mode.  Versions of GnuPG before 2.4.0 are not able to import such a
   secret file.
 
 @end table
 
 @item --with-colons
 @opindex with-colons
 Print key listings delimited by colons. Note that the output will be
 encoded in UTF-8 regardless of any @option{--display-charset} setting. This
 format is useful when GnuPG is called from scripts and other programs
 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 --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.
 Since GnuPG 2.0.10, this mode is always used and thus this option is
 obsolete; it does not harm to use it though.
 
 @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
 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-subkey-fingerprint
 @opindex with-subkey-fingerprint
 If a fingerprint is printed for the primary key, this option forces
 printing of the fingerprint for all subkeys.  This could also be
 achieved by using the @option{--with-fingerprint} twice but by using
 this option along with keyid-format "none" a compact fingerprint is
 printed.
 
 @item --with-v5-fingerprint
 @opindex with-v5-fingerprint
 In a colon mode listing emit "fp2" lines for version 4 OpenPGP keys
 having a v5 style fingerprint of the key.
 
 @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.  In @code{--with-colons} mode
 this is implicitly enable for secret keys.
 
 @item --with-key-origin
 @opindex with-key-origin
 Include the locally held information on the origin and last update of
 a key in a key listing.  In @code{--with-colons} mode this is always
 printed.  This data is currently experimental and shall not be
 considered part of the stable API.
 
 @item --with-wkd-hash
 @opindex with-wkd-hash
 Print a Web Key Directory identifier along with each user ID in key
 listings.  This is an experimental feature and semantics may change.
 
 @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
 
 @c *******************************************
 @c ********  OPENPGP OPTIONS  ****************
 @c *******************************************
 @node OpenPGP Options
 @subsection OpenPGP protocol specific options
 
 @table @gnupgtabopt
 
 @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
 and may need its line endings converted back to whatever the local
 system uses. This option is useful when communicating between two
 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.
 
 @item --force-v3-sigs
 @itemx --no-force-v3-sigs
 @item --force-v4-certs
 @itemx --no-force-v4-certs
 These options are obsolete and have no effect since GnuPG 2.1.
 
 @item --force-ocb
 @itemx --force-aead
 @opindex force-ocb
 @opindex force-aead
 Force the use of AEAD encryption over MDC encryption.  AEAD is a
 modern and faster way to do authenticated encryption than the old MDC
 method.  @option{--force-aead} is an alias and deprecated.  See also
 option @option{--chunk-size}.
 
 @item --force-mdc
 @itemx --disable-mdc
 @opindex force-mdc
 @opindex disable-mdc
 These options are obsolete and have no effect since GnuPG 2.2.8.  The
 MDC is always used unless the keys indicate that an AEAD algorithm can
 be used in which case AEAD is used.  But note: If the creation of a
 legacy non-MDC message is exceptionally required, the option
 @option{--rfc2440} allows for this.
 
 @item --disable-signer-uid
 @opindex disable-signer-uid
 By default the user ID of the signing key is embedded in the data signature.
 As of now this is only done if the signing key has been specified with
 @option{local-user} using a mail address, or with @option{sender}.  This
 information can be helpful for verifier to locate the key; see option
 @option{--auto-key-retrieve}.
 
 @item --include-key-block
 @itemx --no-include-key-block
 @opindex include-key-block
 @opindex no-include-key-block
 This option is used to embed the actual signing key into a data
 signature.  The embedded key is stripped down to a single user id and
 includes only the signing subkey used to create the signature as well
 as as valid encryption subkeys.  All other info is removed from the
 key to keep it and thus the signature small.  This option is the
 OpenPGP counterpart to the @command{gpgsm} option
 @option{--include-certs} and allows the recipient of a signed message
 to reply encrypted to the sender without using any online directories
 to lookup the key.  The default is @option{--no-include-key-block}.
 See also the option @option{--auto-key-import}.
 
 @item --personal-cipher-preferences @var{string}
 @opindex personal-cipher-preferences
 Set the list of personal cipher preferences to @var{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
 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 cipher in this list is also
 used for the @option{--symmetric} encryption command.
 
 @item --personal-digest-preferences @var{string}
 @opindex personal-digest-preferences
 Set the list of personal digest preferences to @var{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
 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{--clear-sign} or @option{--sign}).
 
 @item --personal-compress-preferences @var{string}
 @opindex personal-compress-preferences
 Set the list of personal compression preferences to @var{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 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 compression
 algorithm in this list is also used when there are no recipient keys
 to consider (e.g., @option{--symmetric}).
 
 @item --s2k-cipher-algo @var{name}
 @opindex s2k-cipher-algo
 Use @var{name} as the cipher algorithm for symmetric encryption with
 a passphrase if @option{--personal-cipher-preferences} and
 @option{--cipher-algo} are not given.  The default is @value{GPGSYMENCALGO}.
 
 @item --s2k-digest-algo @var{name}
 @opindex s2k-digest-algo
 Use @var{name} as the digest algorithm used to mangle the passphrases
 for symmetric encryption.  The default is SHA-1.
 
 @item --s2k-mode @var{n}
 @opindex s2k-mode
 Selects how passphrases for symmetric encryption are mangled. If
 @var{n} is 0 a plain passphrase (which is in general not recommended)
 will be used, a 1 adds a salt (which should not be used) to the
 passphrase and a 3 (the default) iterates the whole process a number
 of times (see @option{--s2k-count}).
 
 @item --s2k-count @var{n}
 @opindex s2k-count
 Specify how many times the passphrases mangling for symmetric
 encryption is repeated.  This 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 set
 to the default of 3.
 
 
 @end table
 
 @c ***************************
 @c ******* Compliance ********
 @c ***************************
 @node Compliance Options
 @subsection Compliance options
 
 These options control what GnuPG is compliant to. Only one of these
 options may be active at a time. Note that the default setting of
 this is nearly always the correct one. See the INTEROPERABILITY WITH
 OTHER OPENPGP PROGRAMS section below before using one of these
 options.
 
 @table @gnupgtabopt
 
 @item --gnupg
 @opindex gnupg
 Use standard GnuPG behavior. This is essentially OpenPGP behavior (see
 @option{--openpgp}), but with extension from the proposed update to
 OpenPGP and with some additional workarounds for common compatibility
 problems in different versions of PGP.  This is the default option, so
 it is not generally needed, but it may be useful to override a
 different compliance option in the gpg.conf file.
 
 @item --openpgp
 @opindex openpgp
 Reset all packet, cipher and digest options to strict OpenPGP
 behavior.  This option implies @option{--allow-old-cipher-algos}.  Use
 this option to reset all previous options like @option{--s2k-*},
 @option{--cipher-algo}, @option{--digest-algo} and
 @option{--compress-algo} to OpenPGP compliant values. All PGP
 workarounds are disabled.
 
 @item --rfc4880
 @opindex rfc4880
 Reset all packet, cipher and digest options to strict RFC-4880
 behavior.  This option implies @option{--allow-old-cipher-algos}.
 Note that this is currently the same thing as @option{--openpgp}.
 
 @item --rfc4880bis
 @opindex rfc4880bis
 Reset all packet, cipher and digest options to strict according to the
 proposed updates of RFC-4880.
 
 @item --rfc2440
 @opindex rfc2440
 Reset all packet, cipher and digest options to strict RFC-2440
 behavior.  Note that by using this option encryption packets are
 created in a legacy mode without MDC protection.  This is dangerous
 and should thus only be used for experiments.  This option implies
 @option{--allow-old-cipher-algos}.  See also option
 @option{--ignore-mdc-error}.
 
 @item --pgp6
 @opindex pgp6
 This option is obsolete; it is handled as an alias for @option{--pgp7}
 
 @item --pgp7
 @opindex pgp7
 Set up all options to be as PGP 7 compliant as possible. This allowed
 the ciphers IDEA, 3DES, CAST5,AES128, AES192, AES256, and TWOFISH.,
 the hashes MD5, SHA1 and RIPEMD160, and the compression algorithms
 none and ZIP.  This option implies @option{--escape-from-lines} and
 disables @option{--throw-keyids},
 
 @item --pgp8
 @opindex pgp8
 Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
 closer to the OpenPGP standard than previous versions of PGP, so all
 this does is disable @option{--throw-keyids} and set
 @option{--escape-from-lines}.  All algorithms are allowed except for the
 SHA224, SHA384, and SHA512 digests.
 
 @item --compliance @var{string}
 @opindex compliance
 This option can be used instead of one of the options above.  Valid
 values for @var{string} are the above option names (without the double
 dash) and possibly others as shown when using "help" for @var{string}.
 
 @item --min-rsa-length @var{n}
 @opindex min-rsa-length
 This option adjusts the compliance mode "de-vs" for stricter key size
 requirements.  For example, a value of 3000 turns rsa2048 and dsa2048
 keys into non-VS-NfD compliant keys.
 
 @item --require-compliance
 @opindex require-compliance
 To check that data has been encrypted according to the rules of the
 current compliance mode, a gpg user needs to evaluate the status
 lines.  This is allows frontends to handle compliance check in a more
 flexible way.  However, for scripted use the required evaluation of
 the status-line requires quite some effort; this option can be used
 instead to make sure that the gpg process exits with a failure if the
 compliance rules are not fulfilled.  Note that this option has
 currently an effect only in "de-vs" mode.
 
 @end table
 
 
 @c *******************************************
 @c ********  ESOTERIC OPTIONS  ***************
 @c *******************************************
 @node GPG Esoteric Options
 @subsection Doing things one usually doesn't want to do
 
 @table @gnupgtabopt
 
 @item -n
 @itemx --dry-run
 @opindex dry-run
 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 option may be extended in
 the future. Currently it only skips the actual decryption pass and
 therefore enables a fast listing of the encryption keys.
 
 @item -i
 @itemx --interactive
 @opindex interactive
 Prompt before overwriting any files.
 
 @item --compatibility-flags @var{flags}
 @opindex compatibility-flags
 Set compatibility flags to work around problems due to non-compliant
 keys or data.  The @var{flags} are given as a comma separated
 list of flag names and are OR-ed together.  The special flag "none"
 clears the list and allows to start over with an empty list.  To get a
 list of available flags the sole word "help" can be used.
 
 @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 debug 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. This option is only useful for debugging and the behavior may
 change at any time without notice.
 
 @item --debug-all
 @opindex debug-all
 Set all useful debugging flags.
 
 @item --debug-iolbf
 @opindex debug-iolbf
 Set stdout into line buffered mode.  This option is only honored when
 given on the command line.
 
 @item --debug-set-iobuf-size @var{n}
 @opindex debug-iolbf
 Change the buffer size of the IOBUFs to @var{n} kilobyte.  Using 0
 prints the current size.  Note well: This is a maintainer only option
 and may thus be changed or removed at any time without notice.
 
 @item --debug-allow-large-chunks
 @opindex debug-allow-large-chunks
 To facilitate software tests and experiments this option allows to
 specify a limit of up to 4 EiB (@code{--chunk-size 62}).
 
 @item --debug-ignore-expiration
 @opindex debug-ignore-expiration
 This option tries to override certain key expiration dates.  It is
 only useful for certain regression tests.
 
 @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").
 
 If you suffix @var{epoch} with an exclamation mark (!), the system time
 will appear to be frozen at the specified time.
 
 @item --full-timestrings
 @opindex full-timestrings
 Change the format of printed creation and expiration times from just
 the date to the date and time.  This is in general not useful and the
 same information is anyway available in @option{--with-colons} mode.
 These longer strings are also not well aligned with other printed
 data.
 
 @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 @var{n}
 @opindex status-fd
 Write special status strings to the file descriptor @var{n}.
 See the file DETAILS in the documentation for a listing of them.
 
 @item --status-file @var{file}
 @opindex status-file
 Same as @option{--status-fd}, except the status data is written to file
 @var{file}.
 
 @item --logger-fd @var{n}
 @opindex logger-fd
 Write log output to file descriptor @var{n} and not to STDERR.
 
 @item --log-file @var{file}
 @itemx --logger-file @var{file}
 @opindex log-file
 Same as @option{--logger-fd}, except the logger data is written to
 file @var{file}.  Use @file{socket://} to log to s socket.
 
 @item --log-time
 @opindex log-time
 Prefix all log output with a timestamp even if no log file is used.
 
 @item --attribute-fd @var{n}
 @opindex attribute-fd
 Write attribute subpackets to the file descriptor @var{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 @var{file}
 @opindex attribute-file
 Same as @option{--attribute-fd}, except the attribute data is written to
 file @var{file}.
 
 @item --comment @var{string}
 @itemx --no-comments
 @opindex comment
 Use @var{string} as a comment string in cleartext 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
 times to get multiple comment strings. @option{--no-comments} removes
 all comments.  It is a good idea to keep the length of a single comment
 below 60 characters to avoid problems with mail programs wrapping such
 lines.  Note that comment lines, like all other header lines, are not
 protected by the signature.
 
 @item --emit-version
 @itemx --no-emit-version
 @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, given twice the minor is also emitted, given thrice
 the micro is added, and given four times an operating system identification
 is also emitted.  @option{--no-emit-version} (default) disables the version
 line.
 
 @item --sig-notation @{@var{name}=@var{value}@}
 @itemx --cert-notation @{@var{name}=@var{value}@}
 @itemx -N, --set-notation @{@var{name}=@var{value}@}
 @opindex sig-notation
 @opindex cert-notation
 @opindex set-notation
 Put the name value pair into the signature as notation data.
 @var{name} must consist only of printable characters or spaces, and
 must contain a '@@' character in the form keyname@@domain.example.com
 (substituting the appropriate keyname and domain name, of course).  This
 is to help prevent pollution of the IETF reserved notation
 namespace. The @option{--expert} flag overrides the '@@'
 check. @var{value} may be any printable string; it will be encoded in
 UTF-8, so you should check that your @option{--display-charset} is set
 correctly. If you prefix @var{name} with an exclamation mark (!), the
 notation data will be flagged as critical
 (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.
 
 There are special codes that may be used in notation names. "%k" will
 be expanded into the key ID of the key being signed, "%K" into the
 long key ID of the key being signed, "%f" into the fingerprint of the
 key being signed, "%s" into the key ID of the key making the
 signature, "%S" into the long key ID of the key making the signature,
 "%g" into the fingerprint of the key making the signature (which might
 be a subkey), "%p" into the fingerprint of the primary key of the key
 making the signature, "%c" into the signature count from the OpenPGP
 smartcard, and "%%" results in a single "%". %k, %K, and %f are only
 meaningful when making a key signature (certification), and %c is only
 meaningful when using the OpenPGP smartcard.
 
 @item --known-notation @var{name}
 @opindex known-notation
 Adds @var{name} to a list of known critical signature notations.  The
 effect of this is that gpg will not mark a signature with a critical
 signature notation of that name as bad.  Note that gpg already knows
 by default about a few critical signatures notation names.
 
 @item --sig-policy-url @var{string}
 @itemx --cert-policy-url @var{string}
 @itemx --set-policy-url @var{string}
 @opindex sig-policy-url
 @opindex cert-policy-url
 @opindex set-policy-url
 Use @var{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
 signatures (certifications). @option{--set-policy-url} sets both.
 
 The same %-expandos used for notation data are available here as well.
 
 @item --sig-keyserver-url @var{string}
 @opindex sig-keyserver-url
 Use @var{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.
 
 The same %-expandos used for notation data are available here as well.
 
 @item --set-filename @var{string}
 @opindex set-filename
 Use @var{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.  Using the empty string for @var{string}
 effectively removes the filename from the output.
 
 @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
 to display the message. This option overrides @option{--set-filename}.
 @option{--no-for-your-eyes-only} disables this option.
 
 @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 enables overwriting files.  Defaults to no.
 Note that the option @option{--output} overrides this option.
 
 @item --cipher-algo @var{name}
 @opindex cipher-algo
 Use @var{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
 stored with the key. In general, you do not want to use this option as
 it allows you to violate the OpenPGP standard.  The option
 @option{--personal-cipher-preferences} is the safe way to accomplish the
 same thing.
 
 @item --digest-algo @var{name}
 @opindex digest-algo
 Use @var{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 violate the OpenPGP standard.  The option
 @option{--personal-digest-preferences} is the safe way to accomplish
 the same thing.
 
 @item --compress-algo @var{name}
 @opindex compress-algo
 Use compression algorithm @var{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
 things better than zip or zlib, but at the cost of more memory used
 during compression and decompression. "uncompressed" or "none"
 disables compression. If this option is not used, the default
 behavior is to examine the recipient key preferences to see which
 algorithms the recipient supports. If all else fails, ZIP is used for
 maximum compatibility.
 
 ZLIB may give better compression results than ZIP, as the compression
 window size is not limited to 8k. BZIP2 may give even better
 compression results than that, but will use a significantly larger
 amount of memory while compressing and decompressing. This may be
 significant in low memory situations. Note, however, that PGP (all
 versions) only supports ZIP compression. Using any algorithm other
 than ZIP or "none" will make the message unreadable with PGP. In
 general, you do not want to use this option as it allows you to
 violate the OpenPGP standard.  The option
 @option{--personal-compress-preferences} is the safe way to accomplish
 the same thing.
 
 @item --cert-digest-algo @var{name}
 @opindex cert-digest-algo
 Use @var{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 that GnuPG supports but other OpenPGP implementations do
 not, then some users will not be able to use the key signatures you
 make, or quite possibly your entire key.  Note also that a public key
 algorithm must be compatible with the specified digest algorithm; thus
 selecting an arbitrary digest algorithm may result in error messages
 from lower crypto layers or lead to security flaws.
 
 
 @item --disable-cipher-algo @var{name}
 @opindex disable-cipher-algo
 Never allow the use of @var{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 @var{name}
 @opindex disable-pubkey-algo
 Never allow the use of @var{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
 anyone who is able to decrypt the message can check whether one of the
 other recipients is the one he suspects.}  On the receiving side, it may
 slow down the decryption process because all available secret keys must
 be tried.  @option{--no-throw-keyids} disables this option. This option
 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
 and line endings are hashed too. You can not use this
 option for data which has 5 dashes at the beginning of a
 line, patch files don't have this. A special armor header
 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
 that all other PGP versions do it this way too.  Enabled by
 default. @option{--no-escape-from-lines} disables this option.
 
 @item --passphrase-repeat @var{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; can be set to 0 to disable any
 passphrase repetition.  Note that a @var{n} greater than 1 will pop up
 the pinentry window @var{n}+1 times even if a modern pinentry with
 two entry fields is used.
 
 @item --passphrase-fd @var{n}
 @opindex passphrase-fd
 Read the passphrase from file descriptor @var{n}. Only the first line
 will be read from file descriptor @var{n}. If you use 0 for @var{n},
 the passphrase will be read from STDIN. This can only be used if only
 one passphrase is supplied.
 
 Note that since Version 2.0 this passphrase is only used if the
 option @option{--batch} has also been given. Since Version 2.1
 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
 
 @item --passphrase-file @var{file}
 @opindex passphrase-file
 Read the passphrase from file @var{file}. Only the first line will
 be read from file @var{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.
 
 Note that since Version 2.0 this passphrase is only used if the
 option @option{--batch} has also been given. Since Version 2.1
 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
 
 @item --passphrase @var{string}
 @opindex passphrase
 Use @var{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.
 
 Note that since Version 2.0 this passphrase is only used if the
 option @option{--batch} has also been given. Since Version 2.1
 the @option{--pinentry-mode} also needs to be set to @code{loopback}.
 
 @item --pinentry-mode @var{mode}
 @opindex pinentry-mode
 Set the pinentry mode to @var{mode}.  Allowed values for @var{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 --no-symkey-cache
 @opindex no-symkey-cache
 Disable the passphrase cache used for symmetrical en- and decryption.
 This cache is based on the message specific salt value
 (cf.@: @option{--s2k-mode}).
 
 @item --request-origin @var{origin}
 @opindex request-origin
 Tell gpg to assume that the operation ultimately originated at
 @var{origin}.  Depending on the origin certain restrictions are applied
 and the Pinentry may include an extra note on the origin.  Supported
 values for @var{origin} are: @code{local} which is the default,
 @code{remote} to indicate a remote origin or @code{browser} for an
 operation requested by a web browser.
 
 @item --command-fd @var{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
 together with @option{--status-fd}. See the file doc/DETAILS in the source
 distribution for details on how to use it.
 
 @item --command-file @var{file}
 @opindex command-file
 Same as @option{--command-fd}, except the commands are read out of file
 @var{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
 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 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
 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.
 It is required to decrypt old messages which did not use an MDC.  It
 may also be useful if a message is partially garbled, but it is
 necessary to get as much data as possible out of that garbled message.
 Be aware that a missing or failed MDC can be an indication of an
 attack.  Use with great caution; see also option @option{--rfc2440}.
 
 @item --allow-old-cipher-algos
 @opindex allow-old-cipher-algos
 Old cipher algorithms like 3DES, IDEA, or CAST5 encrypt data using
 blocks of 64 bits; modern algorithms use blocks of 128 bit instead.
 To avoid certain attack on these old algorithms it is suggested not to
 encrypt more than 150 MiByte using the same key.  For this reason gpg
 does not allow the use of 64 bit block size algorithms for encryption
 unless this option is specified.
 
 @item --allow-weak-digest-algos
 @opindex allow-weak-digest-algos
 Signatures made with known-weak digest algorithms are normally
 rejected with an ``invalid digest algorithm'' message.  This option
 allows the verification of signatures made with such weak algorithms.
 MD5 is the only digest algorithm considered weak by default.  See also
 @option{--weak-digest} to reject other digest algorithms.
 
 @item --weak-digest @var{name}
 @opindex weak-digest
 Treat the specified digest algorithm as weak.  Signatures made over
 weak digests algorithms are normally rejected. This option can be
 supplied multiple times if multiple algorithms should be considered
 weak.  See also @option{--allow-weak-digest-algos} to disable
 rejection of weak digests.  MD5 is always considered weak, and does
 not need to be listed explicitly.
 
 @item --allow-weak-key-signatures
 @opindex allow-weak-key-signatures
 To avoid a minor risk of collision attacks on third-party key
 signatures made using SHA-1, those key signatures are considered
 invalid.  This options allows to override this restriction.
 
 @item --override-compliance-check
 This was a temporary introduced option and has no more effect.
 
 @item --no-default-keyring
 @opindex no-default-keyring
 Do not add the default keyring to the list of keyrings. Note that
 GnuPG needs for almost all operations a keyring. Thus if you use this
 option and do not provide alternate keyrings via @option{--keyring},
 then GnuPG will still use the default keyring.
 
 Note that if the option @option{use-keyboxd} is enabled in
 @file{common.conf}, no keyrings are used at all and keys are all
 maintained by the keyboxd process in its own database.
 
 @item --no-keyring
 @opindex no-keyring
 Do not use any keyring at all.  This overrides the default and all
 options which specify 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 --list-signatures
 @opindex list-signatures
 @itemx --list-sigs
 @opindex list-sigs
 Same as @option{--list-keys}, but the signatures are listed too.  This
 command has the same effect as using @option{--list-keys} with
 @option{--with-sig-list}.  Note that in contrast to
 @option{--check-signatures} the key signatures are not verified.  This
 command can be used to create a list of signing keys missing in the
 local keyring; for example:
 
 @example
       gpg --list-sigs --with-colons USERID | \
         awk -F: '$1=="sig" && $2=="?" @{if($13)@{print $13@}else@{print $5@}@}'
 @end example
 
 @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
 they can get a faster listing. The exact behaviour of this option may
 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.
 
 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 @var{string}
 @itemx --override-session-key-fd @var{fd}
 @opindex override-session-key
 Don't use the public key but the session key @var{string} respective
 the session key taken from the first line read from file descriptor
 @var{fd}.  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 handy in case someone forces you to reveal the content of an
 encrypted message; using this option you can do this without handing
 out the secret key.  Note that using @option{--override-session-key}
 may reveal the session key to all local users via the global process
 table.  Often it is useful to combine this option with
 @option{--no-keyring}.
 
 @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.
 
 @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
 example "2m" for two months, or "5y" for five years), or an absolute
 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)
 (for example "2m" for two months, or "5y" for five years), or an
 absolute date in the form YYYY-MM-DD. Defaults to "0".
 
 @item --default-new-key-algo @var{string}
 @opindex default-new-key-algo @var{string}
 This option can be used to change the default algorithms for key
 generation. The @var{string} is similar to the arguments required for
 the command @option{--quick-add-key} but slightly different.  For
 example the current default of @code{"rsa2048/cert,sign+rsa2048/encr"}
 (or @code{"rsa3072"}) can be changed to the value of what we currently
 call future default, which is @code{"ed25519/cert,sign+cv25519/encr"}.
 You need to consult the source code to learn the details.  Note that
 the advanced key generation commands can always be used to specify a
 key algorithm directly.
 
 @item --no-auto-trust-new-key
 @opindex no-auto-trust-new-key
 When creating a new key the ownertrust of the new key is set to
 ultimate.  This option disables this and the user needs to manually
 assign an ownertrust value.
 
 @item --force-sign-key
 @opindex force-sign-key
 This option modifies the behaviour of the commands
 @option{--quick-sign-key}, @option{--quick-lsign-key}, and the "sign"
 sub-commands of @option{--edit-key} by forcing the creation of a key
 signature, even if one already exists.
 
 @item --forbid-gen-key
 @opindex forbid-gen-key
 This option is intended for use in the global config file to disallow
 the use of generate key commands.  Those commands will then fail with
 the error code for Not Enabled.
 
 @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
 These are obsolete options; they have no more effect since GnuPG 2.2.8.
 
 @item --enable-special-filenames
 @opindex enable-special-filenames
 This option 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.
 
 @item --default-preference-list @var{string}
 @opindex default-preference-list
 Set the list of default preferences to @var{string}. This preference
 list is used for new keys and becomes the default for "setpref" in the
 @option{--edit-key} menu.
 
 @item --default-keyserver-url @var{name}
 @opindex default-keyserver-url
 Set the default keyserver URL to @var{name}. This keyserver will be
 used as the keyserver URL when writing a new self-signature on a key,
 which includes key generation and changing preferences.
 
 @item --list-config
 @opindex list-config
 Display various internal configuration parameters of GnuPG. This option
 is intended for external programs that call GnuPG to perform tasks, and
 is thus not generally useful. See the file @file{doc/DETAILS} in the
 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
 internally used by the @command{gpgconf} tool.
 
 @item --gpgconf-test
 @opindex gpgconf-test
 This is more or less dummy action.  However it parses the configuration
 file and returns with failure if the configuration file would prevent
 @command{@gpgname} from startup.  Thus it may be used to run a syntax check
 on the configuration file.
 
 @c @item --use-only-openpgp-card
 @c @opindex use-only-openpgp-card
 @c Only access OpenPGP card's and no other cards.  This is a hidden
 @c option which could be used in case an old use case required the
 @c OpenPGP card while several cards are available.  This option might be
 @c removed if it turns out that nobody requires it.
 
 @item --chuid @var{uid}
 @opindex chuid
 Change the current user to @var{uid} which may either be a number or a
 name.  This can be used from the root account to run gpg for
 another user.  If @var{uid} is not the current UID a standard PATH is
 set and the envvar GNUPGHOME is unset.  To override the latter the
 option @option{--homedir} can be used.  This option has only an effect
 when used on the command line.  This option has currently no effect at
 all on Windows.
 
 @end table
 
 @c *******************************
 @c ******* Deprecated ************
 @c *******************************
 @node Deprecated Options
 @subsection Deprecated options
 
 @table @gnupgtabopt
 
 @item --show-photos
 @itemx --no-show-photos
 @opindex show-photos
 Causes @option{--list-keys}, @option{--list-signatures},
 @option{--list-public-keys}, @option{--list-secret-keys}, and verifying
 a signature to also display the photo ID attached to the key, if
 any. See also @option{--photo-viewer}. These options are deprecated. Use
 @option{--list-options [no-]show-photos} and/or @option{--verify-options
 [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.
 
 @item --show-notation
 @itemx --no-show-notation
 @opindex show-notation
 Show signature notations in the @option{--list-signatures} or @option{--check-signatures} listings
 as well as when verifying a signature with a notation in it. These
 options are deprecated. Use @option{--list-options [no-]show-notation}
 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-signatures} or @option{--check-signatures}
 listings as well as when verifying a signature with a policy URL in
 it. These options are deprecated. Use @option{--list-options
 [no-]show-policy-url} and/or @option{--verify-options
 [no-]show-policy-url} instead.
 
 @item --personal-aead-preferences @var{string}
 @opindex personal-aead-preferences
 This option is deprecated and has no more effect since version 2.3.9.
 
 @item --aead-algo @var{name}
 This option is deprecated and has no more effect since version 2.3.9.
 
 
 @end table
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************   FILES    ****************
 @c ***************            ****************
 @c *******************************************
 @mansect files
 @node GPG Configuration
 @section Configuration files
 
 There are a few configuration files to control certain aspects of
 @command{@gpgname}'s operation. Unless noted, they are expected in the
 current home directory (@pxref{option --homedir}).
 
 @table @file
 
   @item gpg.conf
   @efindex 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.
 
   @item common.conf
   @efindex common.conf
   This is an optional configuration file read by @command{@gpgname} on
   startup.  It may contain options pertaining to all components of
   GnuPG.  Its current main use is for the "use-keyboxd" option.  If
   the default home directory @file{~/.gnupg} does not exist, GnuPG creates
   this directory and a @file{common.conf} file with "use_keyboxd".
 
 @end table
 
 Note that on larger installations, it is useful to put predefined files
 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}).
 
 For internal purposes @command{@gpgname} creates and maintains a few other
 files; They all live in the current home directory (@pxref{option
 --homedir}).  Only the @command{@gpgname} program may modify these files.
 
 
 @table @file
   @item ~/.gnupg
   @efindex ~/.gnupg
   This is the default home directory which is used if neither the
   environment variable @code{GNUPGHOME} nor the option
   @option{--homedir} is given.
 
   @item ~/.gnupg/pubring.gpg
   @efindex pubring.gpg
   The public keyring using a legacy format.  You should backup this file.
 
   If this file is not available, @command{gpg} defaults to the new
   keybox format and creates a file @file{pubring.kbx} unless that file
   already exists in which case that file will also be used for OpenPGP
   keys.
 
   Note that in the case that both files, @file{pubring.gpg} and
   @file{pubring.kbx} exists but the latter has no OpenPGP keys, the
   legacy file @file{pubring.gpg} will be used.  Take care: GnuPG
   versions before 2.1 will always use the file @file{pubring.gpg}
   because they do not know about the new keybox format. In the case
   that you have to use GnuPG 1.4 to decrypt archived data you should
   keep this file.
 
   @item ~/.gnupg/pubring.gpg.lock
   The lock file for the public keyring.
 
   @item ~/.gnupg/pubring.kbx
   @efindex pubring.kbx
   The public keyring using the new keybox format.  This file is shared
   with @command{gpgsm}.  You should backup this file.  See above for
   the relation between this file and it predecessor.
 
   To convert an existing @file{pubring.gpg} file to the keybox format, you
   first backup the ownertrust values, then rename @file{pubring.gpg} to
   @file{publickeys.backup}, so it won’t be recognized by any GnuPG version,
   run import, and finally restore the ownertrust values:
 
   @example
   $ cd ~/.gnupg
   $ gpg --export-ownertrust >otrust.lst
   $ mv pubring.gpg publickeys.backup
   $ gpg --import-options restore --import publickeys.backup
   $ gpg --import-ownertrust otrust.lst
   @end example
 
   @item ~/.gnupg/pubring.kbx.lock
   The lock file for @file{pubring.kbx}.
 
   @item ~/.gnupg/secring.gpg
   @efindex secring.gpg
   The legacy secret keyring as used by GnuPG versions before 2.1.  It is not
   used by GnuPG 2.1 and later.  You may want to keep it in case you
   have to use GnuPG 1.4 to decrypt archived data.
 
   @item ~/.gnupg/secring.gpg.lock
   The lock file for the legacy secret keyring.
 
   @item ~/.gnupg/.gpg-v21-migrated
   @efindex .gpg-v21-migrated
   File indicating that a migration to GnuPG 2.1 has been done.
 
   @item ~/.gnupg/trustdb.gpg
   @efindex 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/random_seed
   @efindex random_seed
   A file used to preserve the state of the internal random pool.
 
   @item ~/.gnupg/openpgp-revocs.d/
   @efindex 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 these 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.
 
 @end table
 
 Operation is further controlled by a few environment variables:
 
 @table @asis
 
   @item HOME
   @efindex HOME
   Used to locate the default home directory.
 
   @item GNUPGHOME
   @efindex GNUPGHOME
   If set directory used instead of "~/.gnupg".
 
   @item GPG_AGENT_INFO
   This variable is obsolete; it was used by GnuPG versions before 2.1.
 
   @item PINENTRY_USER_DATA
   @efindex 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
   @efindex COLUMNS
   @efindex LINES
   Used to size some displays to the full size of the screen.
 
   @item LANGUAGE
   @efindex 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 GNUPG_BUILD_ROOT
   @efindex GNUPG_BUILD_ROOT
   This variable is only used by the regression test suite as a helper
   under operating systems without proper support to figure out the
   name of a process' text file.
 
   @item GNUPG_EXEC_DEBUG_FLAGS
   @efindex GNUPG_EXEC_DEBUG_FLAGS
   This variable allows to enable diagnostics for process management.
   A numeric decimal value is expected.  Bit 0 enables general
   diagnostics, bit 1 enables certain warnings on Windows.
 
 @end table
 
 When calling the gpg-agent component @command{@gpgname} sends a set of
 environment variables to gpg-agent.  The names of these variables can
 be listed using the command:
 
 @example
   gpg-connect-agent 'getinfo std_env_names' /bye | awk '$1=="D" @{print $2@}'
 @end example
 
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  EXAMPLES  ****************
 @c ***************            ****************
 @c *******************************************
 @mansect examples
 @node GPG Examples
 @section Examples
 
 @table @asis
 
 @item gpg -se -r @code{Bob} @code{file}
 sign and encrypt for user Bob
 
 @item gpg --clear-sign @code{file}
 make a cleartext signature
 
 @item gpg -sb @code{file}
 make a detached signature
 
 @item gpg -u 0x12345678 -sb @code{file}
 make a detached signature with the key 0x12345678
 
 @item gpg --list-keys @code{user_ID}
 show keys
 
 @item gpg --fingerprint @code{user_ID}
 show fingerprint
 
 @item gpg --verify @code{pgpfile}
 @itemx gpg --verify @code{sigfile} [@code{datafile}]
 Verify the signature of the file but do not output the data unless
 requested.  The second form is used for detached signatures, where
 @code{sigfile} is the detached signature (either ASCII armored or
 binary) and @code{datafile} are the signed data; if this is not given, the name of the
 file holding the signed data is constructed by cutting off the
 extension (".asc" or ".sig") of @code{sigfile} or by asking the user
 for the filename.  If the option @option{--output} is also used the
 signed data is written to the file specified by that option; use
 @code{-} to write the signed data to stdout.
 @end table
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  USER ID   ****************
 @c ***************            ****************
 @c *******************************************
 @mansect how to specify a user id
 @ifset isman
 @include specify-user-id.texi
 @end ifset
 
 @mansect filter expressions
 @chapheading FILTER EXPRESSIONS
 
 The options @option{--import-filter} and @option{--export-filter} use
 expressions with this syntax (square brackets indicate an optional
 part and curly braces a repetition, white space between the elements
 are allowed):
 
 @c man:.RS
 @example
   [lc] @{[@{flag@}] PROPNAME op VALUE [lc]@}
 @end example
 @c man:.RE
 
 The name of a property (@var{PROPNAME}) may only consist of letters,
 digits and underscores.  The description for the filter type
 describes which properties are defined.  If an undefined property is
 used it evaluates to the empty string.  Unless otherwise noted, the
 @var{VALUE} must always be given and may not be the empty string.  No
 quoting is defined for the value, thus the value may not contain the
 strings @code{&&} or @code{||}, which are used as logical connection
 operators.  The flag @code{--} can be used to remove this restriction.
 
 Numerical values are computed as long int; standard C notation
 applies.  @var{lc} is the logical connection operator; either
 @code{&&} for a conjunction or @code{||} for a disjunction.  A
 conjunction is assumed at the begin of an expression.  Conjunctions
 have higher precedence than disjunctions.  If @var{VALUE} starts with
 one of the characters used in any @var{op} a space after the
 @var{op} is required.
 
 @noindent
 The supported operators (@var{op}) are:
 
 @table @asis
 
   @item =~
   Substring must match.
 
   @item  !~
   Substring must not match.
 
   @item  =
   The full string must match.
 
   @item  <>
   The full string must not match.
 
   @item  ==
   The numerical value must match.
 
   @item  !=
   The numerical value must not match.
 
   @item  <=
   The numerical value of the field must be LE than the value.
 
   @item  <
   The numerical value of the field must be LT than the value.
 
   @item  >
   The numerical value of the field must be GT than the value.
 
   @item  >=
   The numerical value of the field must be GE than the value.
 
   @item  -le
   The string value of the field must be less or equal than the value.
 
   @item  -lt
   The string value of the field must be less than the value.
 
   @item  -gt
   The string value of the field must be greater than the value.
 
   @item  -ge
   The string value of the field must be greater or equal than the value.
 
   @item  -n
   True if value is not empty (no value allowed).
 
   @item  -z
   True if value is empty (no value allowed).
 
   @item  -t
   Alias for "PROPNAME != 0" (no value allowed).
 
   @item  -f
   Alias for "PROPNAME == 0" (no value allowed).
 
 @end table
 
 @noindent
 Values for @var{flag} must be space separated.  The supported flags
 are:
 
 @table @asis
   @item --
   @var{VALUE} spans to the end of the expression.
   @item -c
   The string match in this part is done case-sensitive.
   @item -t
   Leading and trailing spaces are not removed from @var{VALUE}.
   The optional single space after @var{op} is here required.
 @end table
 
 The filter options concatenate several specifications for a filter of
 the same type.  For example the four options in this example:
 
 @c man:.RS
 @example
  --import-filter keep-uid="uid =~ Alfa"
  --import-filter keep-uid="&& uid !~ Test"
  --import-filter keep-uid="|| uid =~ Alpha"
  --import-filter keep-uid="uid !~ Test"
 @end example
 @c man:.RE
 
 @noindent
 which is equivalent to
 
 @c man:.RS
 @example
  --import-filter \
   keep-uid="uid =~ Alfa" && uid !~ Test" || uid =~ Alpha" && "uid !~ Test"
 @end example
 @c man:.RE
 
 imports only the user ids of a key containing the strings "Alfa"
 or "Alpha" but not the string "test".
 
 @mansect trust values
 @ifset isman
 @include trust-values.texi
 @end ifset
 
 @mansect return value
 @chapheading RETURN VALUE
 
 The program returns 0 if there are no severe errors, 1 if at least a
 signature was bad, and other error codes for fatal errors.
 
 Note that signature verification requires exact knowledge of what has
 been signed and by whom it has been signed.  Using only the return code
 is thus not an appropriate way to verify a signature by a script.
 Either make proper use or the status codes or use the @command{gpgv}
 tool which has been designed to make signature verification easy for
 scripts.
 
 @mansect warnings
 @chapheading WARNINGS
 
 Use a good password for your user account and make sure that all
 security issues are always fixed on your machine.  Also employ
 diligent physical protection to your machine.  Consider to use a good
 passphrase as a last resort protection to your secret key in the case
 your machine gets stolen.  It is important that your secret key is
 never leaked.  Using an easy to carry around token or smartcard with
 the secret key is often a advisable.
 
 If you are going to verify detached signatures, make sure that the
 program knows about it; either give both filenames on the command line
 or use @samp{-} to specify STDIN.
 
 For scripted or other unattended use of @command{gpg} make sure to use
 the machine-parseable interface and not the default interface which is
 intended for direct use by humans.  The machine-parseable interface
 provides a stable and well documented API independent of the locale or
 future changes of @command{gpg}.  To enable this interface use the
 options @option{--with-colons} and @option{--status-fd}.  For certain
 operations the option @option{--command-fd} may come handy too.  See
 this man page and the file @file{DETAILS} for the specification of the
 interface.  Note that the GnuPG ``info'' pages as well as the PDF
 version of the GnuPG manual features a chapter on unattended use of
 GnuPG.  As an alternative the library @command{GPGME} can be used as a
 high-level abstraction on top of that interface.
 
 @mansect interoperability
 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
 
 GnuPG tries to be a very flexible implementation of the OpenPGP
 standard. In particular, GnuPG implements many of the optional parts
 of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
 compression algorithms. It is important to be aware that not all
 OpenPGP programs implement these optional algorithms and that by
 forcing their use via the @option{--cipher-algo},
 @option{--digest-algo}, @option{--cert-digest-algo}, or
 @option{--compress-algo} options in GnuPG, it is possible to create a
 perfectly valid OpenPGP message, but one that cannot be read by the
 intended recipient.
 
 There are dozens of variations of OpenPGP programs available, and each
 supports a slightly different subset of these optional algorithms.
 For example, until recently, no (unhacked) version of PGP supported
 the BLOWFISH cipher algorithm. A message using BLOWFISH simply could
 not be read by a PGP user. By default, GnuPG uses the standard
 OpenPGP preferences system that will always do the right thing and
 create messages that are usable by all recipients, regardless of which
 OpenPGP program they use. Only override this safe default if you
 really know what you are doing.
 
 If you absolutely must override the safe default, or if the preferences
 on a given key are invalid for some reason, you are far better off using
 the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
 options are safe as they do not force any particular algorithms in
 violation of OpenPGP, but rather reduce the available algorithms to a
 "PGP-safe" list.
 
 @mansect bugs
 @chapheading BUGS
 
 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
 warning message about insecure memory your operating system supports
 locking without being root. The program drops root privileges as soon
 as locked memory is allocated.
 
 Note also that some systems (especially laptops) have the ability to
 ``suspend to disk'' (also known as ``safe sleep'' or ``hibernate'').
 This writes all memory to disk before going into a low power or even
 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 @url{https://bugs.gnupg.org}.
 
 @c *******************************************
 @c ***************              **************
 @c ***************  UNATTENDED  **************
 @c ***************              **************
 @c *******************************************
 @mansect notes
 @node Unattended Usage of GPG
 @section Unattended Usage
 
 @command{@gpgname} 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
 * Programmatic use of GnuPG:: Programmatic use of GnuPG
 * Ephemeral home directories:: Ephemeral home directories
 * The quick key manipulation interface:: The quick key manipulation interface
 * Unattended GPG key generation::  Unattended key generation
 @end menu
 
 
 @node Programmatic use of GnuPG
 @subsection Programmatic use of GnuPG
 
 Please consider using GPGME instead of calling @command{@gpgname}
 directly.  GPGME offers a stable, backend-independent interface for
 many cryptographic operations.  It supports OpenPGP and S/MIME, and
 also allows interaction with various GnuPG components.
 
 GPGME provides a C-API, and comes with bindings for C++, Qt, and
 Python.  Bindings for other languages are available.
 
 @node Ephemeral home directories
 @subsection Ephemeral home directories
 
 Sometimes you want to contain effects of some operation, for example
 you want to import a key to inspect it, but you do not want this key
 to be added to your keyring.  In earlier versions of GnuPG, it was
 possible to specify alternate keyring files for both public and secret
 keys.  In modern GnuPG versions, however, we changed how secret keys
 are stored in order to better protect secret key material, and it was
 not possible to preserve this interface.
 
 The preferred way to do this is to use ephemeral home directories.
 This technique works across all versions of GnuPG.
 
 Create a temporary directory, create (or copy) a configuration that
 meets your needs, make @command{@gpgname} use this directory either
 using the environment variable @var{GNUPGHOME}, or the option
 @option{--homedir}.  GPGME supports this too on a per-context basis,
 by modifying the engine info of contexts.  Now execute whatever
 operation you like, import and export key material as necessary.  Once
 finished, you can delete the directory.  All GnuPG backend services
 that were started will detect this and shut down.
 
 @node The quick key manipulation interface
 @subsection The quick key manipulation interface
 
 Recent versions of GnuPG have an interface to manipulate keys without
 using the interactive command @option{--edit-key}.  This interface was
 added mainly for the benefit of GPGME (please consider using GPGME,
 see the manual subsection ``Programmatic use of GnuPG'').  This
 interface is described in the subsection ``How to manage your keys''.
 
 @node Unattended GPG key generation
 @subsection Unattended key generation
 
 The command @option{--generate-key} may be used along with the option
 @option{--batch} for unattended key generation.  This is the most
 flexible way of generating keys, but it is also the most complex one.
 Consider using the quick key manipulation interface described in the
 previous subsection ``The quick key manipulation interface''.
 
 The parameters for the key are either read from stdin or given as a
 file on the command line.  The format of the parameter file is as
 follows: Text only, line length is limited to about 1000 characters.
 UTF-8 encoding must be used to specify non-ASCII characters.  Empty
 lines are ignored.  Leading and trailing white space is ignored.  A
 hash sign as the first non white space character indicates a comment
 line.  Control statements are indicated by a leading percent sign,
 their arguments are separated by white space from the keyword.
 Parameters are specified by a keyword, followed by a colon; arguments
 are separated by white space.  The first parameter must be
 @samp{Key-Type} but control statements may be placed anywhere.  The
 order of the parameters does not matter except for @samp{Key-Type}.
 The parameters are only used for the generated keyblock (primary and
 subkeys); parameters from previous sets are not used.  Some syntax
 checks may be performed.  Key commences when either the end of the
 parameter file is reached, the next @samp{Key-Type} parameter is
 encountered, or the control statement @samp{%commit} is encountered.
 
 @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}
 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).
 
 See the previous subsection ``Ephemeral home directories'' for a more
 robust way to contain side-effects.
 
 @item %secring @var{filename}
 This option is a no-op for GnuPG 2.1 and later.
 
 See the previous subsection ``Ephemeral home directories''.
 
 @item %ask-passphrase
 @itemx %no-ask-passphrase
 This option is a no-op since GnuPG version 2.1.
 
 @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{@gpgname --gpgconf-list}.
 For ECC keys this parameter is ignored.
 
 @item Key-Curve: @var{curve}
 The requested elliptic curve of the generated key.  This is a required
 parameter for ECC keys.  It is ignored for non-ECC keys.
 
 @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{@gpgname --gpgconf-list}.
 
 @item Subkey-Curve: @var{curve}
 Key curve for a subkey; similar to @samp{Key-Curve}.
 
 @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 in an ephemeral home directory:
 @smallexample
 $ export GNUPGHOME="$(mktemp -d)"
 $ 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
      # Do a commit here, so that we can later print "done" :-)
      %commit
      %echo done
 EOF
 $ @gpgname --batch --generate-key foo
  [...]
 $ @gpgname --list-secret-keys
 /tmp/tmp.0NQxB74PEf/pubring.kbx
 -------------------------------
 sec   dsa1024 2016-12-16 [SCA]
       768E895903FC1C44045C8CB95EEBDB71E9E849D0
 uid           [ultimate] Joe Tester (with stupid passphrase) <joe@@foo.bar>
 ssb   elg1024 2016-12-16 [E]
 @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
      # Do a commit here, so that we can later print "done" :-)
      %commit
      %echo done
 @end smallexample
 
 
 
 
 @mansect see also
 @ifset isman
 @command{gpgv}(1),
 @command{gpgsm}(1),
 @command{gpg-agent}(1)
 @end ifset
 @include see-also-note.texi
diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi
index 91760abc3..602a39f50 100644
--- a/doc/gpgsm.texi
+++ b/doc/gpgsm.texi
@@ -1,1740 +1,1740 @@
 @c Copyright (C) 2002 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 GPGSM
 @chapter Invoking GPGSM
 @cindex GPGSM command options
 @cindex command options
 @cindex options, GPGSM command
 
 @manpage gpgsm.1
 @ifset manverb
 .B gpgsm
 \- CMS encryption and signing tool
 @end ifset
 
 @mansect synopsis
 @ifset manverb
 .B  gpgsm
 .RB [ \-\-homedir
 .IR dir ]
 .RB [ \-\-options
 .IR file ]
 .RI [ options ]
 .I command
 .RI [ args ]
 @end ifset
 
 
 @mansect description
 @command{gpgsm} is a tool similar to @command{gpg} to provide digital
 encryption and signing services on X.509 certificates and the CMS
 protocol.  It is mainly used as a backend for S/MIME mail processing.
 @command{gpgsm} includes a full featured certificate management and
 complies with all rules defined for the German Sphinx project.
 
 @manpause
 @xref{Option Index}, for an index to @command{GPGSM}'s commands and options.
 @mancont
 
 @menu
 * GPGSM Commands::        List of all commands.
 * GPGSM Options::         List of all options.
 * GPGSM Configuration::   Configuration files.
 * GPGSM Examples::        Some usage examples.
 
 Developer information:
 * Unattended Usage::      Using @command{gpgsm} from other programs.
 * GPGSM Protocol::        The protocol the server mode uses.
 @end menu
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  COMMANDS  ****************
 @c ***************            ****************
 @c *******************************************
 @mansect commands
 @node GPGSM Commands
 @section Commands
 
 Commands are not distinguished from options except for the fact that
 only one command is allowed.
 
 @menu
 * General GPGSM Commands::        Commands not specific to the functionality.
 * Operational GPGSM Commands::    Commands to select the type of operation.
 * Certificate Management::        How to manage certificates.
 @end menu
 
 
 @c *******************************************
 @c **********  GENERAL COMMANDS  *************
 @c *******************************************
 @node General GPGSM Commands
 @subsection Commands not specific to the function
 
 @table @gnupgtabopt
 @item --version
 @opindex version
 Print the program version and licensing information.  Note that you
 cannot abbreviate this command.
 
 @item --help, -h
 @opindex help
 Print a usage message summarizing the most useful command-line options.
 Note that you cannot abbreviate this command.
 
 @item --warranty
 @opindex warranty
 Print warranty information.  Note that you cannot abbreviate this
 command.
 
 @item --dump-options
 @opindex dump-options
 Print a list of all available options and commands.  Note that you cannot
 abbreviate this command.
 @end table
 
 
 @c *******************************************
 @c ********  OPERATIONAL COMMANDS  ***********
 @c *******************************************
 @node Operational GPGSM Commands
 @subsection Commands to select the type of operation
 
 @table @gnupgtabopt
 @item --encrypt
 @opindex encrypt
 Perform an encryption.  The keys the data is encrypted to must be set
 using the option @option{--recipient}.
 
 @item --decrypt
 @opindex decrypt
 Perform a decryption; the type of input is automatically determined.  It
 may either be in binary form or PEM encoded; automatic determination of
 base-64 encoding is not done.
 
 @item --sign
 @opindex sign
 Create a digital signature.  The key used is either the fist one found
 in the keybox or those set with the @option{--local-user} option.
 
 @item --verify
 @opindex verify
 Check a signature file for validity.  Depending on the arguments a
 detached signature may also be checked.
 
 @item --server
 @opindex server
 Run in server mode and wait for commands on the @code{stdin}.
 
 @item --call-dirmngr @var{command} [@var{args}]
 @opindex call-dirmngr
 Behave as a Dirmngr client issuing the request @var{command} with the
 optional list of @var{args}.  The output of the Dirmngr is printed
 stdout.  Please note that file names given as arguments should have an
 absolute file name (i.e., commencing with @code{/}) because they are
 passed verbatim to the Dirmngr and the working directory of the
 Dirmngr might not be the same as the one of this client.  Currently it
 is not possible to pass data via stdin to the Dirmngr.  @var{command}
 should not contain spaces.
 
 This is command is required for certain maintaining tasks of the dirmngr
 where a dirmngr must be able to call back to @command{gpgsm}.  See the Dirmngr
 manual for details.
 
 @item --call-protect-tool @var{arguments}
 @opindex call-protect-tool
 Certain maintenance operations are done by an external program call
 @command{gpg-protect-tool}; this is usually not installed in a directory
 listed in the PATH variable.  This command provides a simple wrapper to
 access this tool.  @var{arguments} are passed verbatim to this command;
 use @samp{--help} to get a list of supported operations.
 
 
 @end table
 
 
 @c *******************************************
 @c *******  CERTIFICATE MANAGEMENT  **********
 @c *******************************************
 @node Certificate Management
 @subsection How to manage the certificates and keys
 
 @table @gnupgtabopt
 @item --generate-key
 @opindex generate-key
 @itemx --gen-key
 @opindex gen-key
 This command allows the creation of a certificate signing request or a
 self-signed certificate.  It is commonly used along with the
 @option{--output} option to save the created CSR or certificate into a
 file.  If used with the @option{--batch} a parameter file is used to
 create the CSR or certificate and it is further possible to create
 non-self-signed certificates.
 
 @item --list-keys
 @itemx -k
 @opindex list-keys
 List all available certificates stored in the local key database.
 Note that the displayed data might be reformatted for better human
 readability and illegal characters are replaced by safe substitutes.
 
 @item --list-secret-keys
 @itemx -K
 @opindex list-secret-keys
 List all available certificates for which a corresponding a secret key
 is available.
 
 @item --list-external-keys @var{pattern}
 @opindex list-keys
 List certificates matching @var{pattern} using an external server.  This
 utilizes the @code{dirmngr} service.
 
 @item --list-chain
 @opindex list-chain
 Same as @option{--list-keys} but also prints all keys making up the chain.
 
 
 @item --dump-cert
 @itemx --dump-keys
 @opindex dump-cert
 @opindex dump-keys
 List all available certificates stored in the local key database using a
 format useful mainly for debugging.
 
 @item --dump-chain
 @opindex dump-chain
 Same as @option{--dump-keys} but also prints all keys making up the chain.
 
 @item --dump-secret-keys
 @opindex dump-secret-keys
 List all available certificates for which a corresponding a secret key
 is available using a format useful mainly for debugging.
 
 @item --dump-external-keys @var{pattern}
 @opindex dump-external-keys
 List certificates matching @var{pattern} using an external server.
 This utilizes the @code{dirmngr} service.  It uses a format useful
 mainly for debugging.
 
 @item --show-certs [@var{files}]
 @opindex show-certs
 This command takes certificate files as input and prints information
 about them in the same format as @option{--dump-cert} does.  Each file
 may either contain a single binary certificate or several PEM encoded
 certificates.  If no files are given, the input is taken from stdin.
 
 Please note that the listing format may be changed in future releases
 and that the option @option{--with-colons} has currently no effect.
 
 
 @item --keydb-clear-some-cert-flags
 @opindex keydb-clear-some-cert-flags
 This is a debugging aid to reset certain flags in the key database
 which are used to cache certain certificate statuses.  It is especially
 useful if a bad CRL or a weird running OCSP responder did accidentally
 revoke certificate.  There is no security issue with this command
 because @command{gpgsm} always make sure that the validity of a certificate is
 checked right before it is used.
 
 @item --delete-keys @var{pattern}
 @opindex delete-keys
 Delete the keys matching @var{pattern}.  Note that there is no command
 to delete the secret part of the key directly.  In case you need to do
 this, you should run the command @code{gpgsm --dump-secret-keys KEYID}
 before you delete the key, copy the string of hex-digits in the
 ``keygrip'' line and delete the file consisting of these hex-digits
 and the suffix @code{.key} from the @file{private-keys-v1.d} directory
 below our GnuPG home directory (usually @file{~/.gnupg}).
 
 @item --export [@var{pattern}]
 @opindex export
 Export all certificates stored in the Keybox or those specified by the
 optional @var{pattern}. Those pattern consist of a list of user ids
 (@pxref{how-to-specify-a-user-id}).  When used along with the
 @option{--armor} option a few informational lines are prepended before
 each block.  There is one limitation: As there is no commonly agreed
 upon way to pack more than one certificate into an ASN.1 structure,
 the binary export (i.e., without using @option{armor}) works only for
 the export of one certificate.  Thus it is required to specify a
 @var{pattern} which yields exactly one certificate.  Ephemeral
 certificate are only exported if all @var{pattern} are given as
 fingerprints or keygrips.
 
 @item --export-secret-key-p12 @var{key-id}
 @opindex export-secret-key-p12
 Export the private key and the certificate identified by @var{key-id}
 using the PKCS#12 format.  When used with the @code{--armor} option a few
 informational lines are prepended to the output.  Note, that the PKCS#12
 format is not very secure and proper transport security should be used
 to convey the exported key.  (@xref{option --p12-charset}.)
 
 @item --export-secret-key-p8 @var{key-id}
 @itemx --export-secret-key-raw @var{key-id}
 @opindex export-secret-key-p8
 @opindex export-secret-key-raw
 Export the private key of the certificate identified by @var{key-id}
 with any encryption stripped.  The @code{...-raw} command exports in
 PKCS#1 format; the @code{...-p8} command exports in PKCS#8 format.
 When used with the @code{--armor} option a few informational lines are
 prepended to the output.  These commands are useful to prepare a key
 for use on a TLS server.
 
 @item --import [@var{files}]
 @opindex import
 Import the certificates from the PEM or binary encoded files as well as
 from signed-only messages.  This command may also be used to import a
 secret key from a PKCS#12 file.
 
 @item --learn-card
 @opindex learn-card
 Read information about the private keys from the smartcard and import
 the certificates from there.  This command utilizes the @command{gpg-agent}
 and in turn the @command{scdaemon}.
 
 @item --change-passphrase @var{user_id}
 @opindex change-passphrase
 @itemx --passwd @var{user_id}
 @opindex passwd
 Change the passphrase of the private key belonging to the certificate
 specified as @var{user_id}.  Note, that changing the passphrase/PIN of a
 smartcard is not yet supported.
 
 @end table
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  OPTIONS   ****************
 @c ***************            ****************
 @c *******************************************
 @mansect options
 @node GPGSM Options
 @section Option Summary
 
 @command{GPGSM} features a bunch of options to control the exact behaviour
 and to change the default configuration.
 
 @menu
 * Configuration Options::   How to change the configuration.
 * Certificate Options::     Certificate related options.
 * Input and Output::        Input and Output.
 * CMS Options::             How to change how the CMS is created.
 * Esoteric Options::        Doing things one usually do not want to do.
 @end menu
 
 
 @c *******************************************
 @c ********  CONFIGURATION OPTIONS  **********
 @c *******************************************
 @node Configuration Options
 @subsection How to change the configuration
 
 These options are used to change the configuration and are usually found
 in the option file.
 
 @table @gnupgtabopt
 
 @anchor{gpgsm-option --options}
 @item --options @var{file}
 @opindex options
 Reads configuration from @var{file} instead of from the default
 per-user configuration file.  The default configuration file is named
 @file{gpgsm.conf} and expected in the @file{.gnupg} directory directly
 below the home directory of the user.
 
 @include opt-homedir.texi
 
 
 @item -v
 @item --verbose
 @opindex v
 @opindex verbose
 Outputs additional information while running.
 You can increase the verbosity by giving several
 verbose commands to @command{gpgsm}, such as @samp{-vv}.
 
 @item --keyserver @var{string}
 @opindex keyserver
 This is a deprecated option.  It was used to add an LDAP server to use
 for X.509 certificate and CRL lookup.  The alias @option{--ldapserver}
 existed from version 2.2.28 to 2.2.33 and 2.3.2 to 2.3.4 but is now
 entirely ignored.
 
 LDAP servers must be given in the configuration for @command{dirmngr}.
 
 @item --policy-file @var{filename}
 @opindex policy-file
 Change the default name of the policy file to @var{filename}.  The
 default name is @file{policies.txt}.
 
 @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 the command @command{gpgconf}.
 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 @acronym{CRL} checks.  The
 default value is @file{@value{BINDIR}/dirmngr}.
 
 @item --prefer-system-dirmngr
 @opindex prefer-system-dirmngr
 This option is obsolete and ignored.
 
 @item --disable-dirmngr
 Entirely disable the use of the Dirmngr.
 
 @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 --no-secmem-warning
 @opindex no-secmem-warning
 Do not print a warning when the so called "secure memory" cannot be used.
 
 @item --log-file @var{file}
 @opindex log-file
 When running in server mode, append all logging output to @var{file}.
 Use @file{socket://} to log to socket.
 
 @item --log-time
 @opindex log-time
 Prefix all log output with a timestamp even if no log file is used.
 
 @end table
 
 
 @c *******************************************
 @c ********  CERTIFICATE OPTIONS  ************
 @c *******************************************
 @node Certificate Options
 @subsection Certificate related options
 
 @table @gnupgtabopt
 
 @item  --enable-policy-checks
 @itemx --disable-policy-checks
 @opindex enable-policy-checks
 @opindex disable-policy-checks
 By default policy checks are enabled.  These options may be used to
 change it.
 
 @item  --enable-crl-checks
 @itemx --disable-crl-checks
 @opindex enable-crl-checks
 @opindex disable-crl-checks
 By default the @acronym{CRL} checks are enabled and the DirMngr is
 used to check for revoked certificates.  The disable option is most
 useful with an off-line network connection to suppress this check and
 also to avoid that new certificates introduce a web bug by including a
 certificate specific CRL DP.  The disable option also disables an
 issuer certificate lookup via the authorityInfoAccess property of the
 certificate; the @option{--enable-issuer-key-retrieve} can be used
 to make use of that property anyway.
 
 @item  --enable-trusted-cert-crl-check
 @itemx --disable-trusted-cert-crl-check
 @opindex enable-trusted-cert-crl-check
 @opindex disable-trusted-cert-crl-check
 By default the @acronym{CRL} for trusted root certificates are checked
 like for any other certificates.  This allows a CA to revoke its own
 certificates voluntary without the need of putting all ever issued
 certificates into a CRL.  The disable option may be used to switch this
 extra check off.  Due to the caching done by the Dirmngr, there will not be
 any noticeable performance gain.  Note, that this also disables possible
 OCSP checks for trusted root certificates.  A more specific way of
 disabling this check is by adding the ``relax'' keyword to the root CA
 line of the @file{trustlist.txt}
 
 
 @item --force-crl-refresh
 @opindex force-crl-refresh
 Tell the dirmngr to reload the CRL for each request.  For better
 performance, the dirmngr will actually optimize this by suppressing
 the loading for short time intervals (e.g., 30 minutes). This option
 is useful to make sure that a fresh CRL is available for certificates
 hold in the keybox.  The suggested way of doing this is by using it
 along with the option @option{--with-validation} for a key listing
 command.  This option should not be used in a configuration file.
 
 @item --enable-issuer-based-crl-check
 @opindex enable-issuer-based-crl-check
 Run a CRL check even for certificates which do not have any CRL
 distribution point.  This requires that a suitable LDAP server has
 been configured in Dirmngr and that the CRL can be found using the
 issuer.  This option reverts to what GnuPG did up to version 2.2.20.
 This option is in general not useful.
 
 @item  --enable-ocsp
 @itemx --disable-ocsp
 @opindex enable-ocsp
 @opindex disable-ocsp
 By default @acronym{OCSP} checks are disabled.  The enable option may
 be used to enable OCSP checks via Dirmngr.  If @acronym{CRL} checks
 are also enabled, CRLs will be used as a fallback if for some reason an
 OCSP request will not succeed.  Note, that you have to allow OCSP
 requests in Dirmngr's configuration too (option
 @option{--allow-ocsp}) and configure Dirmngr properly.  If you do not do
 so you will get the error code @samp{Not supported}.
 
 @item --auto-issuer-key-retrieve
 @opindex auto-issuer-key-retrieve
 If a required certificate is missing while validating the chain of
 certificates, try to load that certificate from an external location.
 This usually means that Dirmngr is employed to search for the
 certificate.  Note that this option makes a "web bug" like behavior
 possible.  LDAP server 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 keybox), the operator can tell both your
 IP address and the time when you verified the signature.  Note that if
 CRL checking is not disabled issuer certificates are retrieved in any
 case using the caIssuers authorityInfoAccess method.
 
 
 @anchor{gpgsm-option --validation-model}
 @item --validation-model @var{name}
 @opindex validation-model
 This option changes the default validation model.  The only possible
 values are "shell" (which is the default), "chain" which forces the
 use of the chain model and "steed" for a new simplified model.  The
 chain model is also used if an option in the @file{trustlist.txt} or
 an attribute of the certificate requests it.  However the standard
 model (shell) is in that case always tried first.
 
 @item --ignore-cert-extension @var{oid}
 @opindex ignore-cert-extension
 Add @var{oid} to the list of ignored certificate extensions.  The
 @var{oid} is expected to be in dotted decimal form, like
 @code{2.5.29.3}.  This option may be used more than once.  Critical
 flagged certificate extensions matching one of the OIDs in the list
 are treated as if they are actually handled and thus the certificate
 will not be rejected due to an unknown critical extension.  Use this
 option with care because extensions are usually flagged as critical
 for a reason.
 
 @end table
 
 @c *******************************************
 @c ***********  INPUT AND OUTPUT  ************
 @c *******************************************
 @node Input and Output
 @subsection Input and Output
 
 @table @gnupgtabopt
 @item --armor
 @itemx -a
 @opindex armor
 Create PEM encoded output.  Default is binary output.
 
 @item --base64
 @opindex base64
 Create Base-64 encoded output; i.e., PEM without the header lines.
 
 @item --assume-armor
 @opindex assume-armor
 Assume the input data is PEM encoded.  Default is to autodetect the
 encoding but this is may fail.
 
 @item --assume-base64
 @opindex assume-base64
 Assume the input data is plain base-64 encoded.
 
 @item --assume-binary
 @opindex assume-binary
 Assume the input data is binary encoded.
 
 @item --input-size-hint @var{n}
 @opindex input-size-hint
 This option can be used to tell GPGSM the size of the input data in
 bytes.  @var{n} must be a positive base-10 number.  It is used by the
 @option{--status-fd} line ``PROGRESS'' to provide a value for
 ``total'' if that is not available by other means.
 
 @anchor{option --p12-charset}
 @item --p12-charset @var{name}
 @opindex p12-charset
 @command{gpgsm} uses the UTF-8 encoding when encoding passphrases for
 PKCS#12 files.  This option may be used to force the passphrase to be
 encoded in the specified encoding @var{name}.  This is useful if the
 application used to import the key uses a different encoding and thus
 will not be able to import a file generated by @command{gpgsm}.  Commonly
 used values for @var{name} are @code{Latin1} and @code{CP850}.  Note
 that @command{gpgsm} itself automagically imports any file with a
 passphrase encoded to the most commonly used encodings.
 
 
 @item --default-key @var{user_id}
 @opindex default-key
 Use @var{user_id} as the standard key for signing.  This key is used if
 no other key has been defined as a signing key.  Note, that the first
 @option{--local-users} option also sets this key if it has not yet been
 set; however @option{--default-key} always overrides this.
 
 
 @item --local-user @var{user_id}
 @item -u @var{user_id}
 @opindex local-user
 Set the user(s) to be used for signing.  The default is the first
 secret key found in the database.
 
 
 @item --recipient @var{name}
 @itemx -r
 @opindex recipient
 Encrypt to the user id @var{name}.  There are several ways a user id
 may be given (@pxref{how-to-specify-a-user-id}).
 
 
 @item --output @var{file}
 @itemx -o @var{file}
 @opindex output
 Write output to @var{file}.  The default is to write it to stdout.
 
 
 @anchor{gpgsm-option --with-key-data}
 @item --with-key-data
 @opindex with-key-data
 Displays extra information with the @code{--list-keys} commands.  Especially
 a line tagged @code{grp} is printed which tells you the keygrip of a
 key.  This string is for example used as the file name of the
 secret key.  Implies @code{--with-colons}.
 
 @anchor{gpgsm-option --with-validation}
 @item --with-validation
 @opindex with-validation
 When doing a key listing, do a full validation check for each key and
 print the result.  This is usually a slow operation because it
 requires a CRL lookup and other operations.
 
 When used along with @option{--import}, a validation of the certificate to
 import is done and only imported if it succeeds the test.  Note that
 this does not affect an already available certificate in the DB.
 This option is therefore useful to simply verify a certificate.
 
 
 @item --with-md5-fingerprint
 For standard key listings, also print the MD5 fingerprint of the
 certificate.
 
 @item --with-keygrip
 Include the keygrip in standard key listings.  Note that the keygrip is
 always listed in @option{--with-colons} mode.
 
 @item --with-secret
 @opindex with-secret
 Include info about the presence of a secret key in public key listings
 done with @code{--with-colons}.
 
 @item --no-pretty-dn
 @opindex no-pretty-dn
 By default gpgsm prints distinguished names (DNs) like the Issuer or
 Subject in a more readable format (e.g., using a well defined order of
 the parts).  However, this format can't be used as input strings.
 This option reverts printing to standard RFC-2253 format and thus
 avoids the need to use @option{--dump-cert} or @option{--with-colons}
 to get the ``real'' name.
 
 @end table
 
 @c *******************************************
 @c *************  CMS OPTIONS  ***************
 @c *******************************************
 @node CMS Options
 @subsection How to change how the CMS is created
 
 @table @gnupgtabopt
 @item --include-certs @var{n}
 @opindex include-certs
 Using @var{n} of -2 includes all certificate except for the root cert,
 -1 includes all certs, 0 does not include any certs, 1 includes only the
 signers cert and all other positive values include up to @var{n}
 certificates starting with the signer cert.  The default is -2.
 
 @item --cipher-algo @var{oid}
 @opindex cipher-algo
 Use the cipher algorithm with the ASN.1 object identifier @var{oid} for
 encryption.  For convenience the strings @code{3DES}, @code{AES} and
 @code{AES256} may be used instead of their OIDs.  The default is
 @code{AES} (2.16.840.1.101.3.4.1.2).
 
 @item --digest-algo @code{name}
 Use @code{name} as the message digest algorithm.  Usually this
 algorithm is deduced from the respective signing certificate.  This
 option forces the use of the given algorithm and may lead to severe
 interoperability problems.
 
 @end table
 
 
 
 @c *******************************************
 @c ********  ESOTERIC OPTIONS  ***************
 @c *******************************************
 @node Esoteric Options
 @subsection Doing things one usually do not want to do
 
 
 @table @gnupgtabopt
 
 @item --chuid @var{uid}
 @opindex chuid
 Change the current user to @var{uid} which may either be a number or a
 name.  This can be used from the root account to run gpgsm for
 another user.  If @var{uid} is not the current UID a standard PATH is
 set and the envvar GNUPGHOME is unset.  To override the latter the
 option @option{--homedir} can be used.  This option has only an effect
 when used on the command line.  This option has currently no effect at
 all on Windows.
 
 
 @item --extra-digest-algo @var{name}
 @opindex extra-digest-algo
 Sometimes signatures are broken in that they announce a different digest
 algorithm than actually used.  @command{gpgsm} uses a one-pass data
 processing model and thus needs to rely on the announced digest
 algorithms to properly hash the data.  As a workaround this option may
 be used to tell @command{gpgsm} to also hash the data using the algorithm
 @var{name}; this slows processing down a little bit but allows verification of
 such broken signatures.  If @command{gpgsm} prints an error like
 ``digest algo 8 has not been enabled'' you may want to try this option,
 with @samp{SHA256} for @var{name}.
 
 @item --compliance @var{string}
 @opindex compliance
 Set the compliance mode.  Valid values are shown when using "help" for
 @var{string}.
 
 @item --min-rsa-length @var{n}
 @opindex min-rsa-length
 This option adjusts the compliance mode "de-vs" for stricter key size
 requirements.  For example, a value of 3000 turns rsa2048 and dsa2048
 keys into non-VS-NfD compliant keys.
 
 @item --require-compliance
 @opindex require-compliance
 To check that data has been encrypted according to the rules of the
 current compliance mode, a gpgsm user needs to evaluate the status
 lines.  This is allows frontends to handle compliance check in a more
 flexible way.  However, for scripted use the required evaluation of
 the status-line requires quite some effort; this option can be used
 instead to make sure that the gpgsm process exits with a failure if
 the compliance rules are not fulfilled.  Note that this option has
 currently an effect only in "de-vs" mode.
 
 @item --ignore-cert-with-oid @var{oid}
 @opindex ignore-cert-with-oid
 Add @var{oid} to the list of OIDs to be checked while reading
 certificates from smartcards. The @var{oid} is expected to be in
 dotted decimal form, like @code{2.5.29.3}.  This option may be used
 more than once.  As of now certificates with an extended key usage
 matching one of those OIDs are ignored during a @option{--learn-card}
 operation and not imported.  This option can help to keep the local
 key database clear of unneeded certificates stored on smartcards.
 
 @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 --with-ephemeral-keys
 @opindex with-ephemeral-keys
 Include ephemeral flagged keys in the output of key listings.  Note
 that they are included anyway if the key specification for a listing
 is given as fingerprint or keygrip.
 
 @item --compatibility-flags @var{flags}
 @opindex compatibility-flags
 Set compatibility flags to work around problems due to non-compliant
 certificates or data.  The @var{flags} are given as a comma separated
 list of flag names and are OR-ed together.  The special flag "none"
 clears the list and allows to start over with an empty list.  To get a
 list of available flags the sole word "help" can be used.
 
 @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 debug 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. This option is only useful for debugging and the behavior may
 change at any time without notice.
 
 Note, that all flags set using this option may get overridden by
 @code{--debug-level}.
 
 @item --debug-all
 @opindex debug-all
 Same as @code{--debug=0xffffffff}
 
 @item --debug-allow-core-dump
 @opindex debug-allow-core-dump
 Usually @command{gpgsm} tries to avoid dumping core by well written code and by
 disabling core dumps for security reasons.  However, bugs are pretty
 durable beasts and to squash them it is sometimes useful to have a core
 dump.  This option enables core dumps unless the Bad Thing happened
 before the option parsing.
 
 @item --debug-no-chain-validation
 @opindex debug-no-chain-validation
 This is actually not a debugging option but only useful as such.  It
 lets @command{gpgsm} bypass all certificate chain validation checks.
 
 @item --debug-ignore-expiration
 @opindex debug-ignore-expiration
 This is actually not a debugging option but only useful as such.  It
 lets @command{gpgsm} ignore all notAfter dates, this is used by the regression
 tests.
 
 @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.
 
 Note that this passphrase is only used if the option @option{--batch}
 has also been given.
 
 @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 --request-origin @var{origin}
 @opindex request-origin
 Tell gpgsm to assume that the operation ultimately originated at
 @var{origin}.  Depending on the origin certain restrictions are applied
 and the Pinentry may include an extra note on the origin.  Supported
 values for @var{origin} are: @code{local} which is the default,
 @code{remote} to indicate a remote origin or @code{browser} for an
 operation requested by a web browser.
 
 @item --no-common-certs-import
 @opindex no-common-certs-import
 Suppress the import of common certificates on keybox creation.
 
 @end table
 
 All the long options may also be given in the configuration file after
 stripping off the two leading dashes.
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  USER ID   ****************
 @c ***************            ****************
 @c *******************************************
 @mansect how to specify a user id
 @ifset isman
 @include specify-user-id.texi
 @end ifset
 
 @c *******************************************
 @c ***************            ****************
 @c ***************   FILES    ****************
 @c ***************            ****************
 @c *******************************************
 @mansect files
 @node GPGSM Configuration
 @section Configuration files
 
 There are a few configuration files to control certain aspects of
 @command{gpgsm}'s operation. Unless noted, they are expected in the
 current home directory (@pxref{option --homedir}).
 
 @table @file
 
 @item gpgsm.conf
 @efindex gpgsm.conf
 This is the standard configuration file read by @command{gpgsm} 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{gpgsm-option --options}).
 You should backup this file.
 
 @item common.conf
 @efindex common.conf
 This is an optional configuration file read by @command{gpgsm} on
 startup.  It may contain options pertaining to all components of
 GnuPG.  Its current main use is for the "use-keyboxd" option.
 
 @item policies.txt
 @efindex policies.txt
 This is a list of allowed CA policies.  This file should list the
 object identifiers of the policies line by line.  Empty lines and
 lines starting with a hash mark are ignored.  Policies missing in this
 file and not marked as critical in the certificate will print only a
 warning; certificates with policies marked as critical and not listed
 in this file will fail the signature verification.  You should backup
 this file.
 
 For example, to allow only the policy 2.289.9.9, the file should look
 like this:
 
 @c man:.RS
 @example
 # Allowed policies
 2.289.9.9
 @end example
 @c man:.RE
 
 @item qualified.txt
 @efindex qualified.txt
 This is the list of root certificates used for qualified certificates.
 They are defined as certificates capable of creating legally binding
 signatures in the same way as handwritten signatures are.  Comments
 start with a hash mark and empty lines are ignored.  Lines do have a
 length limit but this is not a serious limitation as the format of the
 entries is fixed and checked by @command{gpgsm}: A non-comment line starts with
 optional whitespace, followed by exactly 40 hex characters, white space
 and a lowercased 2 letter country code.  Additional data delimited with
 by a white space is current ignored but might late be used for other
 purposes.
 
 Note that even if a certificate is listed in this file, this does not
 mean that the certificate is trusted; in general the certificates listed
 in this file need to be listed also in @file{trustlist.txt}. This is a global
 file an installed in the sysconf directory (e.g.
 @file{@value{SYSCONFDIR}/qualified.txt}).
 
 Every time @command{gpgsm} uses a certificate for signing or verification
 this file will be consulted to check whether the certificate under
 question has ultimately been issued by one of these CAs.  If this is the
 case the user will be informed that the verified signature represents a
 legally binding (``qualified'') signature.  When creating a signature
 using such a certificate an extra prompt will be issued to let the user
 confirm that such a legally binding signature shall really be created.
 
 Because this software has not yet been approved for use with such
 certificates, appropriate notices will be shown to indicate this fact.
 
 @item help.txt
 @efindex help.txt
 This is plain text file with a few help entries used with
 @command{pinentry} as well as a large list of help items for
 @command{gpg} and @command{gpgsm}.  The standard file has English help
 texts; to install localized versions use filenames like @file{help.LL.txt}
 with LL denoting the locale.  GnuPG comes with a set of predefined help
 files in the data directory (e.g., @file{@value{DATADIR}/gnupg/help.de.txt})
 and allows overriding of any help item by help files stored in the
 system configuration directory (e.g., @file{@value{SYSCONFDIR}/help.de.txt}).
 For a reference of the help file's syntax, please see the installed
 @file{help.txt} file.
 
 
 @item com-certs.pem
 @efindex com-certs.pem
 This file is a collection of common certificates used to populated a
 newly created @file{pubring.kbx}.  An administrator may replace this
 file with a custom one.  The format is a concatenation of PEM encoded
 X.509 certificates.  This global file is installed in the data directory
 (e.g., @file{@value{DATADIR}/com-certs.pem}).
 
 @end table
 
 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.  For existing users a small
 helper script is provided to create these files (@pxref{addgnupghome}).
 
 For internal purposes @command{gpgsm} creates and maintains a few other files;
 they all live in the current home directory (@pxref{option
 --homedir}).  Only @command{gpgsm} may modify these files.
 
 
 @table @file
 @item pubring.kbx
 @efindex pubring.kbx
 This a database file storing the certificates as well as meta
 information.  For debugging purposes the tool @command{kbxutil} may be
 used to show the internal structure of this file.  You should backup
 this file.
 
 @item random_seed
 @efindex random_seed
 This content of this file is used to maintain the internal state of the
 random number generator across invocations.  The same file is used by
 other programs of this software too.
 
 @item S.gpg-agent
 @efindex S.gpg-agent
 If this file exists
 @command{gpgsm} will first try to connect to this socket for
 accessing @command{gpg-agent} before starting a new @command{gpg-agent}
 instance.  Under Windows this socket (which in reality be a plain file
 describing a regular TCP listening port) is the standard way of
 connecting the @command{gpg-agent}.
 
 @end table
 
 
 @c *******************************************
 @c ***************            ****************
 @c ***************  EXAMPLES  ****************
 @c ***************            ****************
 @c *******************************************
 @mansect examples
 @node GPGSM Examples
 @section Examples
 
 @example
 $ gpgsm -er goo@@bar.net <plaintext >ciphertext
 @end example
 
 
 @c *******************************************
 @c ***************              **************
 @c ***************  UNATTENDED  **************
 @c ***************              **************
 @c *******************************************
 @manpause
 @node Unattended Usage
 @section Unattended Usage
 
 @command{gpgsm} 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.  This is most likely used with the @code{--server} command
 but may also be used in the standard operation mode by using the
 @code{--status-fd} option.
 
 @menu
 * Automated signature checking::  Automated signature checking.
 * CSR and certificate creation::  CSR and certificate creation.
 @end menu
 
 @node Automated signature checking
 @subsection Automated signature checking
 
 It is very important to understand the semantics used with signature
 verification.  Checking a signature is not as simple as it may sound and
 so the operation is a bit complicated.  In most cases it is required
 to look at several status lines.  Here is a table of all cases a signed
 message may have:
 
 @table @asis
 @item The signature is valid
 This does mean that the signature has been successfully verified, the
 certificates are all sane.  However there are two subcases with
 important information:  One of the certificates may have expired or a
 signature of a message itself as expired.  It is a sound practise to
 consider such a signature still as valid but additional information
 should be displayed.  Depending on the subcase @command{gpgsm} will issue
 these status codes:
   @table @asis
   @item signature valid and nothing did expire
   @code{GOODSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
   @item signature valid but at least one certificate has expired
   @code{EXPKEYSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
   @item signature valid but expired
   @code{EXPSIG}, @code{VALIDSIG}, @code{TRUST_FULLY}
   Note, that this case is currently not implemented.
   @end table
 
 @item The signature is invalid
 This means that the signature verification failed (this is an indication
 of a transfer error, a program error or tampering with the message).
 @command{gpgsm} issues one of these status codes sequences:
   @table @code
   @item  @code{BADSIG}
   @item  @code{GOODSIG}, @code{VALIDSIG} @code{TRUST_NEVER}
   @end table
 
 @item Error verifying a signature
 For some reason the signature could not be verified, i.e., it cannot be
 decided whether the signature is valid or invalid.  A common reason for
 this is a missing certificate.
 
 @end table
 
 @node CSR and certificate creation
 @subsection CSR and certificate creation
 
 The command @option{--generate-key} may be used along with the option
 @option{--batch} to either create a certificate signing request (CSR)
 or an X.509 certificate.  This is controlled by a parameter file; the
 format of this file is as follows:
 
 @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 CSR/certificate; 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.
 
 @c  %certfile <filename>
 @c      [Not yet implemented!]
 @c	Do not write the certificate to the keyDB but to <filename>.
 @c      This must be given before the first
 @c	commit to take place, duplicate specification of the same filename
 @c	is ignored, the last filename before a commit is used.
 @c	The filename is used until a new filename is used (at commit points)
 @c	and all keys are written to that file.	If a new filename is given,
 @c	this file is created (and overwrites an existing one).
 @c	Both control statements must be given.
 @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.  The supported values for @var{algo} are @samp{rsa},
 @samp{ecdsa}, and @samp{eddsa}.
 
 @item Key-Length: @var{nbits}
 The requested length of a generated key in bits.  Defaults to
 3072. The value is ignored for ECC algorithms.
 
 @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 usage, allowed values are
 @samp{encrypt}, @samp{sign} and @samp{cert}.  This is used to generate
 the keyUsage extension.  Please make sure that the algorithm is
 capable of this usage.  Default is to allow encrypt and sign.
 
 @item Name-DN: @var{subject-name}
 This is the Distinguished Name (DN) of the subject in RFC-2253 format.
 
 @item Name-Email: @var{string}
 This is an email address for the altSubjectName.  This parameter is
 optional but may occur several times to add several email addresses to
 a certificate.
 
 @item Name-DNS: @var{string}
 The is an DNS name for the altSubjectName.  This parameter is optional
 but may occur several times to add several DNS names to a certificate.
 
 @item Name-URI: @var{string}
 This is an URI for the altSubjectName.  This parameter is optional but
 may occur several times to add several URIs to a certificate.
 @end table
 
 @noindent
 Additional parameters used to create a certificate (in contrast to a
 certificate signing request):
 
 @table @asis
 
 @item Serial: @var{sn}
 If this parameter is given an X.509 certificate will be generated.
 @var{sn} is expected to be a hex string representing an unsigned
 integer of arbitrary length.  The special value @samp{random} can be
 used to create a 64 bit random serial number.
 
 @item Issuer-DN: @var{issuer-name}
 This is the DN name of the issuer in RFC-2253 format.  If it is not set
 it will default to the subject DN and a special GnuPG extension will
 be included in the certificate to mark it as a standalone certificate.
 
 @item Creation-Date: @var{iso-date}
 @itemx Not-Before: @var{iso-date}
 Set the notBefore date of the certificate.  Either a date like
 @samp{1986-04-26} or @samp{1986-04-26 12:00} or a standard ISO
 timestamp like @samp{19860426T042640} may be used.  The time is
 considered to be UTC.  If it is not given the current date is used.
 
 @item Expire-Date: @var{iso-date}
 @itemx Not-After: @var{iso-date}
 Set the notAfter date of the certificate.  Either a date like
 @samp{2063-04-05} or @samp{2063-04-05 17:00} or a standard ISO
 timestamp like @samp{20630405T170000} may be used.  The time is
 considered to be UTC.  If it is not given a default value in the not
 too far future is used.
 
 @item Signing-Key: @var{keygrip}
 This gives the keygrip of the key used to sign the certificate.  If it
 is not given a self-signed certificate will be created.  For
 compatibility with future versions, it is suggested to prefix the
 keygrip with a @samp{&}.
 
 @item Hash-Algo: @var{hash-algo}
 Use @var{hash-algo} for this CSR or certificate.  The supported hash
 algorithms are: @samp{sha1}, @samp{sha256}, @samp{sha384} and
 @samp{sha512}; they may also be specified with uppercase letters.  The
 default is @samp{sha256}.
 
 @item Authority-Key-Id: @var{hexstring}
 Insert the decoded value of @var{hexstring} as authorityKeyIdentifier.
 If this is not given and an ECC algorithm is used the public part of
 the certified public key is used as authorityKeyIdentifier.  To
 inhibit any authorityKeyIdentifier use the special value @code{none}
 for @var{hexstring}.
 
 @item Subject-Key-Id: @var{hexstring}
 Insert the decoded value of @var{hexstring} as subjectKeyIdentifier.
 If this is not given and an ECC algorithm is used the public part of
 the signing key is used as authorityKeyIdentifier.  To inhibit any
 subjectKeyIdentifier use the special value @code{none} for
 @var{hexstring}.
 
 @end table
 
 @c *******************************************
 @c ***************           *****************
 @c ***************  ASSSUAN  *****************
 @c ***************           *****************
 @c *******************************************
 @node GPGSM Protocol
 @section The Protocol the Server Mode Uses
 
 Description of the protocol used to access @command{GPGSM}.
 @command{GPGSM} does implement the Assuan protocol and in addition
 provides a regular command line interface which exhibits a full client
 to this protocol (but uses internal linking).  To start
 @command{gpgsm} as a server the command line the option
 @code{--server} must be used.  Additional options are provided to
 select the communication method (i.e., the name of the socket).
 
 We assume that the connection has already been established; see the
 Assuan manual for details.
 
 @menu
 * GPGSM ENCRYPT::         Encrypting a message.
 * GPGSM DECRYPT::         Decrypting a message.
 * GPGSM SIGN::            Signing a message.
 * GPGSM VERIFY::          Verifying a message.
 * GPGSM GENKEY::          Generating a key.
 * GPGSM LISTKEYS::        List available keys.
 * GPGSM EXPORT::          Export certificates.
 * GPGSM IMPORT::          Import certificates.
 * GPGSM DELETE::          Delete certificates.
 * GPGSM GETAUDITLOG::     Retrieve an audit log.
 * GPGSM GETINFO::         Information about the process
 * GPGSM OPTION::          Session options.
 @end menu
 
 
 @node GPGSM ENCRYPT
 @subsection Encrypting a Message
 
 Before encryption can be done the recipient must be set using the
 command:
 
 @example
   RECIPIENT @var{userID}
 @end example
 
 Set the recipient for the encryption.  @var{userID} should be the
 internal representation of the key; the server may accept any other way
 of specification.  If this is a valid and trusted recipient the server
 does respond with OK, otherwise the return is an ERR with the reason why
 the recipient cannot be used, the encryption will then not be done for
 this recipient.  If the policy is not to encrypt at all if not all
 recipients are valid, the client has to take care of this.  All
 @code{RECIPIENT} commands are cumulative until a @code{RESET} or an
 successful @code{ENCRYPT} command.
 
 @example
   INPUT FD[=@var{n}] [--armor|--base64|--binary]
 @end example
 
 Set the file descriptor for the message to be encrypted to @var{n}.
 Obviously the pipe must be open at that point, the server establishes
 its own end.  If the server returns an error the client should consider
 this session failed.  If @var{n} is not given, this commands uses the
 last file descriptor passed to the application.
 @xref{fun-assuan_sendfd, ,the assuan_sendfd function,assuan,the Libassuan
 manual}, on how to do descriptor passing.
 
 The @code{--armor} option may be used to advise the server that the
 input data is in @acronym{PEM} format, @code{--base64} advises that a
 raw base-64 encoding is used, @code{--binary} advises of raw binary
 input (@acronym{BER}).  If none of these options is used, the server
 tries to figure out the used encoding, but this may not always be
 correct.
 
 @example
   OUTPUT FD[=@var{n}] [--armor|--base64]
 @end example
 
 Set the file descriptor to be used for the output (i.e., the encrypted
 message). Obviously the pipe must be open at that point, the server
 establishes its own end.  If the server returns an error the client
 should consider this session failed.
 
 The option @option{--armor} encodes the output in @acronym{PEM} format, the
 @option{--base64} option applies just a base-64 encoding.  No option
 creates binary output (@acronym{BER}).
 
 The actual encryption is done using the command
 
 @example
   ENCRYPT
 @end example
 
 It takes the plaintext from the @code{INPUT} command, writes to the
 ciphertext to the file descriptor set with the @code{OUTPUT} command,
 take the recipients from all the recipients set so far.  If this command
 fails the clients should try to delete all output currently done or
 otherwise mark it as invalid.  @command{GPGSM} does ensure that there
 will not be any
 security problem with leftover data on the output in this case.
 
 This command should in general not fail, as all necessary checks have
 been done while setting the recipients.  The input and output pipes are
 closed.
 
 
 @node GPGSM DECRYPT
 @subsection Decrypting a message
 
 Input and output FDs are set the same way as in encryption, but
 @code{INPUT} refers to the ciphertext and @code{OUTPUT} to the plaintext. There
 is no need to set recipients.  @command{GPGSM} automatically strips any
 @acronym{S/MIME} headers from the input, so it is valid to pass an
 entire MIME part to the INPUT pipe.
 
 The decryption is done by using the command
 
 @example
   DECRYPT
 @end example
 
-It performs the decrypt operation after doing some check on the internal
-state (e.g., that all needed data has been set).  Because it utilizes
-the GPG-Agent for the session key decryption, there is no need to ask
-the client for a protecting passphrase - GpgAgent takes care of this by
-requesting this from the user.
+It performs the decrypt operation after doing some check on the
+internal state (e.g., that all needed data has been set).  Because it
+utilizes the GPG-Agent for the session key decryption, there is no
+need to ask the client for a protecting passphrase --- GpgAgent takes
+care of this by requesting this from the user.
 
 
 @node GPGSM SIGN
 @subsection Signing a Message
 
 Signing is usually done with these commands:
 
 @example
   INPUT FD[=@var{n}] [--armor|--base64|--binary]
 @end example
 
 This tells @command{GPGSM} to read the data to sign from file descriptor @var{n}.
 
 @example
   OUTPUT FD[=@var{m}] [--armor|--base64]
 @end example
 
 Write the output to file descriptor @var{m}.  If a detached signature is
 requested, only the signature is written.
 
 @example
   SIGN [--detached]
 @end example
 
 Sign the data set with the @code{INPUT} command and write it to the sink set by
 @code{OUTPUT}.  With @code{--detached}, a detached signature is created
 (surprise).
 
 The key used for signing is the default one or the one specified in
 the configuration file.  To get finer control over the keys, it is
 possible to use the command
 
 @example
   SIGNER @var{userID}
 @end example
 
 to set the signer's key.  @var{userID} should be the
 internal representation of the key; the server may accept any other way
 of specification.  If this is a valid and trusted recipient the server
 does respond with OK, otherwise the return is an ERR with the reason why
 the key cannot be used, the signature will then not be created using
 this key.  If the policy is not to sign at all if not all
 keys are valid, the client has to take care of this.  All
 @code{SIGNER} commands are cumulative until a @code{RESET} is done.
 Note that a @code{SIGN} does not reset this list of signers which is in
 contrast to the @code{RECIPIENT} command.
 
 
 @node GPGSM VERIFY
 @subsection Verifying a Message
 
 To verify a message the command:
 
 @example
   VERIFY
 @end example
 
 is used. It does a verify operation on the message send to the input FD.
 The result is written out using status lines.  If an output FD was
 given, the signed text will be written to that.  If the signature is a
 detached one, the server will inquire about the signed material and the
 client must provide it.
 
 @node GPGSM GENKEY
 @subsection Generating a Key
 
 This is used to generate a new keypair, store the secret part in the
 @acronym{PSE} and the public key in the key database.  We will probably
 add optional commands to allow the client to select whether a hardware
 token is used to store the key.  Configuration options to
 @command{GPGSM} can be used to restrict the use of this command.
 
 @example
   GENKEY
 @end example
 
 @command{GPGSM} checks whether this command is allowed and then does an
 INQUIRY to get the key parameters, the client should then send the
 key parameters in the native format:
 
 @example
     S: INQUIRE KEY_PARAM native
     C: D foo:fgfgfg
     C: D bar
     C: END
 @end example
 
 Please note that the server may send Status info lines while reading the
 data lines from the client.  After this the key generation takes place
 and the server eventually does send an ERR or OK response.  Status lines
 may be issued as a progress indicator.
 
 
 @node GPGSM LISTKEYS
 @subsection List available keys
 @anchor{gpgsm-cmd listkeys}
 
 To list the keys in the internal database or using an external key
 provider, the command:
 
 @example
   LISTKEYS  @var{pattern}
 @end example
 
 is used.  To allow multiple patterns (which are ORed during the search)
 quoting is required: Spaces are to be translated into "+" or into "%20";
 in turn this requires that the usual escape quoting rules are done.
 
 @example
   LISTSECRETKEYS @var{pattern}
 @end example
 
 Lists only the keys where a secret key is available.
 
 The list commands are affected by the option
 
 @example
   OPTION list-mode=@var{mode}
 @end example
 
 where mode may be:
 @table @code
 @item 0
 Use default (which is usually the same as 1).
 @item 1
 List only the internal keys.
 @item 2
 List only the external keys.
 @item 3
 List internal and external keys.
 @end table
 
 Note that options are valid for the entire session.
 
 
 @node GPGSM EXPORT
 @subsection Export certificates
 
 To export certificate from the internal key database the command:
 
 @example
   EXPORT [--data [--armor] [--base64]] [--] @var{pattern}
 @end example
 
 is used.  To allow multiple patterns (which are ORed) quoting is
 required: Spaces are to be translated into "+" or into "%20"; in turn
 this requires that the usual escape quoting rules are done.
 
 If the @option{--data} option has not been given, the format of the
 output depends on what was set with the @code{OUTPUT} command.  When using
 @acronym{PEM} encoding a few informational lines are prepended.
 
 If the @option{--data} has been given, a target set via @code{OUTPUT} is
 ignored and the data is returned inline using standard
 @code{D}-lines. This avoids the need for an extra file descriptor.  In
 this case the options @option{--armor} and @option{--base64} may be used
 in the same way as with the @code{OUTPUT} command.
 
 
 @node GPGSM IMPORT
 @subsection Import certificates
 
 To import certificates into the internal key database, the command
 
 @example
   IMPORT [--re-import]
 @end example
 
 is used.  The data is expected on the file descriptor set with the
 @code{INPUT} command.  Certain checks are performed on the
 certificate.  Note that the code will also handle PKCS#12 files and
 import private keys; a helper program is used for that.
 
 With the option @option{--re-import} the input data is expected to a be
 a linefeed separated list of fingerprints.  The command will re-import
 the corresponding certificates; that is they are made permanent by
 removing their ephemeral flag.
 
 
 @node GPGSM DELETE
 @subsection Delete certificates
 
 To delete a certificate the command
 
 @example
   DELKEYS @var{pattern}
 @end example
 
 is used.  To allow multiple patterns (which are ORed) quoting is
 required: Spaces are to be translated into "+" or into "%20"; in turn
 this requires that the usual escape quoting rules are done.
 
 The certificates must be specified unambiguously otherwise an error is
 returned.
 
 @node GPGSM GETAUDITLOG
 @subsection Retrieve an audit log
 @anchor{gpgsm-cmd getauditlog}
 
 This command is used to retrieve an audit log.
 
 @example
 GETAUDITLOG [--data] [--html]
 @end example
 
 If @option{--data} is used, the audit log is send using D-lines
 instead of being sent to the file descriptor given by an @code{OUTPUT}
 command.  If @option{--html} is used, the output is formatted as an
 XHTML block. This is designed to be incorporated into a HTML
 document.
 
 
 @node GPGSM GETINFO
 @subsection  Return information about the process
 
 This is a multipurpose function to return a variety of information.
 
 @example
 GETINFO @var{what}
 @end example
 
 The value of @var{what} specifies the kind of information returned:
 @table @code
 @item version
 Return the version of the program.
 @item pid
 Return the process id of the process.
 @item agent-check
 Return OK if the agent is running.
 @item cmd_has_option @var{cmd} @var{opt}
 Return OK if the command @var{cmd} implements the option @var{opt}.
 The leading two dashes usually used with @var{opt} shall not be given.
 @item offline
 Return OK if the connection is in offline mode.  This may be either
 due to a @code{OPTION offline=1} or due to @command{gpgsm} being
 started with option @option{--disable-dirmngr}.
 @end table
 
 @node GPGSM OPTION
 @subsection  Session options
 
 The standard Assuan option handler supports these options.
 
 @example
 OPTION @var{name}[=@var{value}]
 @end example
 
 These @var{name}s are recognized:
 
 @table @code
 
 @item putenv
 Change the session's environment to be passed via gpg-agent to
 Pinentry.  @var{value} is a string of the form
 @code{<KEY>[=[<STRING>]]}.  If only @code{<KEY>} is given the
 environment variable @code{<KEY>} is removed from the session
 environment, if @code{<KEY>=} is given that environment variable is
 set to the empty string, and if @code{<STRING>} is given it is set to
 that string.
 
 @item display
 @efindex DISPLAY
 Set the session environment variable @code{DISPLAY} is set to @var{value}.
 @item ttyname
 @efindex GPG_TTY
 Set the session environment variable @code{GPG_TTY} is set to @var{value}.
 @item ttytype
 @efindex TERM
 Set the session environment variable @code{TERM} is set to @var{value}.
 @item lc-ctype
 @efindex LC_CTYPE
 Set the session environment variable @code{LC_CTYPE} is set to @var{value}.
 @item lc-messages
 @efindex LC_MESSAGES
 Set the session environment variable @code{LC_MESSAGES} is set to @var{value}.
 @item xauthority
 @efindex XAUTHORITY
 Set the session environment variable @code{XAUTHORITY} is set to @var{value}.
 @item pinentry-user-data
 @efindex PINENTRY_USER_DATA
 Set the session environment variable @code{PINENTRY_USER_DATA} is set
 to @var{value}.
 
 @item include-certs
 This option overrides the command line option
 @option{--include-certs}.  A @var{value} of -2 includes all
 certificates except for the root certificate, -1 includes all
 certificates, 0 does not include any certificates, 1 includes only the
 signers certificate and all other positive values include up to
 @var{value} certificates starting with the signer cert.
 
 @item list-mode
 @xref{gpgsm-cmd listkeys}.
 
 @item list-to-output
 If @var{value} is true the output of the list commands
 (@pxref{gpgsm-cmd listkeys}) is written to the file descriptor set
 with the last @code{OUTPUT} command.  If @var{value} is false the output is
 written via data lines; this is the default.
 
 @item with-validation
 If @var{value} is true for each listed certificate the validation
 status is printed.  This may result in the download of a CRL or the
 user being asked about the trustworthiness of a root certificate.  The
 default is given by a command line option (@pxref{gpgsm-option
 --with-validation}).
 
 
 @item with-secret
 If @var{value} is true certificates with a corresponding private key
 are marked by the list commands.
 
 @item validation-model
 This option overrides the command line option
 @option{validation-model} for the session.
 (@xref{gpgsm-option --validation-model}.)
 
 @item with-key-data
 This option globally enables the command line option
 @option{--with-key-data}.  (@xref{gpgsm-option --with-key-data}.)
 
 @item enable-audit-log
 If @var{value} is true data to write an audit log is gathered.
 (@xref{gpgsm-cmd getauditlog}.)
 
 @item allow-pinentry-notify
 If this option is used notifications about the launch of a Pinentry
 are passed back to the client.
 
 @item with-ephemeral-keys
 If @var{value} is true ephemeral certificates are included in the
 output of the list commands.
 
 @item no-encrypt-to
 If this option is used all keys set by the command line option
 @option{--encrypt-to} are ignored.
 
 @item offline
 If @var{value} is true or @var{value} is not given all network access
 is disabled for this session.  This is the same as the command line
 option @option{--disable-dirmngr}.
 
 @item input-size-hint
 This is the same as the @option{--input-size-hint} command line option.
 
 @end table
 
 @mansect see also
 @ifset isman
 @command{gpg}(1),
 @command{gpg-agent}(1)
 @end ifset
 @include see-also-note.texi