include support and texi fixes
[gnupg.git] / doc / gpg.texi
index 5dccd70..49d332f 100644 (file)
-\input texinfo
-@setfilename gpg.info
-@dircategory GnuPG
-@direntry
-* gpg: (gpg).                         GnuPG encryption and signing tool.
-@end direntry
-
-@node Top, , , (dir)
-@top gpg
-@chapheading Name
-
-gpg --- encryption and signing tool
-@chapheading Synopsis
-
-@example
-gpg
- --homedir name
- --options file
- options
- command
- args
-  
-@end example
-@chapheading DESCRIPTION
-
-@code{gpg} is the main program for the GnuPG system.
-
-This man page only lists the commands and options available. For more
-verbose documentation get the GNU Privacy Handbook (GPH) or one of the
-other documents at http://www.gnupg.org/documentation/ .
-
-Please remember that option parsing stops as soon as a non option is
-encountered, you can explicitly stop option parsing by using the
-special option "--".
-@chapheading COMMANDS
-
-@code{gpg} may be run with no commands, in which case it will
+@c Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
+@c               2006 Free Software Foundation, Inc.
+@c This is part of the GnuPG manual.
+@c For copying conditions, see the file gnupg.texi.
+
+@node Invoking GPG
+@chapter Invoking GPG
+@cindex GPG command options
+@cindex command options
+@cindex options, GPG command
+
+
+@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
+
+@mansect description
+@command{gpg2} is the OpenPGP part of the GNU Privacy Guard (GnuPG). It
+is a tool to provide digitla encryption and signing services using the
+OpenPGP standard. @command{gpg2} features complete key management and
+all bells and whistles you can expect from a decent OpenPGP
+implementation.
+
+In contrast to the standalone version @command{gpg}, which is more
+suited for server and embedded platforms, this version is installed
+under the name @command{gpg2} and more targeted to the desktop as it
+requires several other modules to be installed.  The standalone version
+will be kept maintained and it is possible to install both versions on
+the same system.  If you need to use different configuration files, you
+should make use of something like @file{gpg.conf-2} instead of just
+@file{gpg.conf}.
+
+@manpause
+Documentation for the old standard @command{gpg} is available as man page
+man page and at @inforef{Top,GnuPG 1,gpg}.
+
+@xref{Option Index}, for an index to @command{GPG}'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:
+@c * Unattended Usage::      Using @command{gpg} from other programs.
+@c * GPG Protocol::        The protocol the server mode uses.
+@end menu
+
+
+
+@c *******************************************
+@c ***************            ****************
+@c ***************  COMMANDS  ****************
+@c ***************            ****************
+@c *******************************************
+@mansect commands
+@node GPG Commands
+@section Commands
+
+Commands are not distinguished from options execpt for the fact that
+only one command is allowed.
+
+@code{gpg2} may be run with no commands, in which case it will
 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).
 
-@code{gpg} recognizes these commands:
+Please remember that option as well as command parsing stops as soon as
+a non-option is encountered, you can explicitly stop parsing by
+using the special option "--".
 
-@table @asis
 
-@item -s, --sign
+@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.
+Not that you cannot abbreviate this command.
+
+@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
 Make a signature. This command may be combined with --encrypt (for a
 signed and encrypted message), --symmetric (for a signed and
 symmetrically encrypted message), or --encrypt and --symmetric
@@ -51,19 +141,30 @@ together (for a signed message that may be decrypted via a secret key
 or a passphrase).
 
 @item --clearsign
-Make a clear text signature.
-
-@item -b, --detach-sign
+@opindex clearsign
+Make a clear text signature. The content in a clear text signature is
+readable without any special software. OpenPGP software is only
+needed to verify the signature. Clear text signatures may modify
+end-of-line whitespace for platform independence and are not intended
+to be reversible.
+
+@item --detach-sign
+@itemx -b
+@opindex detach-sign
 Make a detached signature.
 
-@item -e, --encrypt
+@item --encrypt
+@itemx -e
+@opindex encrypt
 Encrypt data. This option may be combined with --sign (for a signed
 and encrypted message), --symmetric (for a message that may be
 decrypted via a secret key or a passphrase), or --sign and --symmetric
 together (for a signed message that may be decrypted via a secret key
 or a passphrase).
 
-@item -c, --symmetric
+@item --symmetric
+@itemx -c
+@opindex symmetric
 Encrypt with a symmetric cipher using a passphrase. The default
 symmetric cipher used is CAST5, but may be chosen with the
 --cipher-algo option. This option may be combined with --sign (for a
@@ -73,52 +174,57 @@ that may be decrypted via a secret key or a passphrase), or --sign and
 secret key or a passphrase).
 
 @item --store
-Store only (make a simple RFC1991 packet).
-
-@item --decrypt 
-Decrypt @code{file} (or stdin if no file is specified) and
-write it to stdout (or the file specified with
---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 which don't begin with an encrypted
-message.
-
-@item --verify 
-Assume that @code{sigfile} is a signature and verify it
-without generating any output. With no arguments,
-the signature packet is read from stdin. If
-only a sigfile is given, it may be a complete
-signature or a detached signature, in which case
-the signed stuff is expected in a file without the
-".sig" or ".asc" extension. 
-With more than
-1 argument, the first should be a detached signature
-and the remaining files are the signed stuff. To read the signed
-stuff from stdin, use @samp{-} as the second filename.
-For security reasons a detached signature cannot read the signed
-material from stdin without denoting it in the above way.
+@opindex store
+Store only (make a simple RFC1991 literal data packet).
+
+@item --decrypt
+@itemx -d
+@opindex decrypt
+Decrypt the file given on the command line (or @code{stdin} if no file
+is specified) and write it to stdout (or the file specified with
+--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 which don't begin with an encrypted message.
+
+@item --verify
+@opindex verify
+Assume that the first argument is a signed file or a detached signature
+and verify it without generating any output. With no arguments, the
+signature packet is read from stdin. If only a sigfile is given, it may
+be a complete signature or a detached signature, in which case the
+signed stuff is expected in a file without the ".sig" or ".asc"
+extension.  With more than 1 argument, the first should be a detached
+signature and the remaining files are the signed stuff. To read the
+signed stuff from stdin, use @samp{-} as the second filename.  For
+security reasons a detached signature cannot read the signed material
+from stdin without denoting it in the above way.
 
 @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. --multifile may currently be used along with --verify,
---encrypt, and --decrypt. Note that `--multifile --verify' may not be
-used with detached signatures.
-
-@item --verify-files 
+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. --multifile may currently be used along with --verify, --encrypt,
+and --decrypt. Note that `--multifile --verify' may not be used with
+detached signatures.
+
+@item --verify-files
+@opindex verify-files
 Identical to `--multifile --verify'.
 
-@item --encrypt-files 
+@item --encrypt-files
+@opindex encrypt-files
 Identical to `--multifile --encrypt'.
 
-@item --decrypt-files 
+@item --decrypt-files
+@opindex decrypt-files
 Identical to `--multifile --decrypt'.
 
-@item --list-keys 
-@itemx --list-public-keys 
+@item --list-keys
+@itemx -k
+@itemx --list-public-keys
+@opindex list-keys
 List all keys from the public keyrings, or just the ones given on the
 command line.
 
@@ -127,57 +233,253 @@ it is likely to change as GnuPG changes. See --with-colons for a
 machine-parseable key listing command that is appropriate for use in
 scripts and other programs.
 
-@item -K, --list-secret-keys 
+@item --list-secret-keys
+@itemx -K
+@opindex list-secret-keys
 List all keys from the secret keyrings, or just the ones given on the
-command line. A '#' after the letters 'sec' means that the secret key
-is not usable (for example, if it was created via
+command line. A @code{#} after the letters @code{sec} means that the
+secret key is not usable (for example, if it was created via
 --export-secret-subkeys).
 
-@item --list-sigs 
+@item --list-sigs
+@opindex list-sigs
 Same as --list-keys, but the signatures are listed too.
 
-For each signature listed, there are several flags in between the
-"sig" tag and keyid. These flags give additional information about
-each signature. From left to right, they are the numbers 1-3 for
-certificate check level (see --ask-cert-level), "L" for a local or
-non-exportable signature (see --lsign-key), "R" for a nonRevocable
-signature (see the --edit-key command "nrsign"), "P" for a signature
-that contains a policy URL (see --cert-policy-url), "N" for a
-signature that contains a notation (see --cert-notation), "X" for an
-eXpired signature (see --ask-cert-expire), and the numbers 1-9 or "T"
-for 10 and above to indicate trust signature levels (see the
---edit-key command "tsign").
-
-@item --check-sigs 
+For each signature listed, there are several flags in between the "sig"
+tag and keyid. These flags give additional information about each
+signature. From left to right, they are the numbers 1-3 for certificate
+check level (see --ask-cert-level), "L" for a local or non-exportable
+signature (see --lsign-key), "R" for a nonRevocable signature (see the
+--edit-key command "nrsign"), "P" for a signature that contains a policy
+URL (see --cert-policy-url), "N" for a signature that contains a
+notation (see --cert-notation), "X" for an eXpired signature (see
+--ask-cert-expire), and the numbers 1-9 or "T" for 10 and above to
+indicate trust signature levels (see the --edit-key command "tsign").
+
+@item --check-sigs
+@opindex check-sigs
 Same as --list-sigs, but the signatures are verified.
 
-@item --fingerprint 
-List all keys with their fingerprints. This is the
-same output as --list-keys but with the additional output
-of a line with the fingerprint. May also be combined
-with --list-sigs or --check-sigs.
-If this command is given twice, the fingerprints of all
-secondary keys are listed too.
+@item --fingerprint
+@opindex fingerprint
+List all keys (or the specified ones) along with their
+fingerprints. This is the same output as --list-keys but with the
+additional output of a line with the fingerprint. May also be combined
+with --list-sigs or --check-sigs.  If this command is given twice, the
+fingerprints of all secondary keys are listed too.
 
 @item --list-packets
+@opindex list-packets
 List only the sequence of packets. This is mainly
 useful for debugging.
 
+
+@item --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
+http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
+
+@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
+--card-edit command.
+
+@item --delete-key @code{name}
+@opindex delete-key
+Remove key from the public keyring. In batch mode either --yes is
+required or the key must be specified by fingerprint. This is a
+safeguard against accidental deletion of multiple keys.
+
+@item --delete-secret-key @code{name}
+@opindex delete-secret-key
+Remove key from the secret and public keyring. In batch mode the key
+must be specified by fingerprint.
+
+@item --delete-secret-and-public-key @code{name}
+@opindex delete-secret-and-public-key
+Same as --delete-key, but if a secret key exists, it will be removed
+first. In batch mode the key must be specified by fingerprint.
+
+@item --export
+@opindex export
+Either export all keys from all keyrings (default keyrings and those
+registered via option --keyring), or if at least one name is given,
+those of the given name. The new keyring is written to stdout or to the
+file given with option "output". Use together with --armor to mail those
+keys.
+
+@item --send-keys
+@opindex send-keys
+Same as --export but sends the keys to a keyserver.  Option --keyserver
+must be used to give the name of this keyserver. Don't send your
+complete keyring to a keyserver - select only those keys which are new
+or changed by you.
+
+@item --export-secret-keys
+@itemx --export-secret-subkeys
+@opindex export-secret-keys
+@opindex export-secret-subkeys
+Same as --export, but exports the secret keys instead.  This is normally
+not very useful and a security risk.  The second form of the command has
+the special property to render the secret part of the primary key
+useless; this is a GNU extension to OpenPGP and other implementations
+can not be expected to successfully import such a key.  See the option
+--simple-sk-checksum if you want to import such an exported key with an
+older OpenPGP implementation.
+
+@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 --keyserver-options merge-only option which
+does not insert new keys but does only the merging of new signatures,
+user-IDs and subkeys.
+
+@item --recv-keys @code{key IDs}
+@opindex recv-keys
+Import the keys with the given key IDs from a keyserver. Option
+--keyserver must be used to give the name of this 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. Option --keyserver must be used to give
+the name of the keyserver for all keys that do not have preferred
+keyservers set (see --keyserver-options honor-keyserver-url).
+
+@item --search-keys @code{names}
+@opindex search-keys
+Search the keyserver for the given names. Multiple names given here
+will be joined together to create the search string for the keyserver.
+Option --keyserver must be used to give the name of this keyserver.
+Keyservers that support different search methods allow using the
+syntax specified in "How to specify a user ID" below. Note that
+different keyserver types support different search methods. Currently
+only LDAP supports them all.
+
+@item --fetch-keys @code{URIs}
+@opindex fetch-keys
+Retrieve keys located at the specified URIs. Note that different
+installations of GnuPG may support different protocols (HTTP, FTP,
+LDAP, etc.)
+
+@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 --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 --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 --update-trustdb but it skips keys with a not yet
+defined "ownertrust".
+
+For use with cron jobs, this command can be used together with --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 --yes.
+
+@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 trust DB.
+
+@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.
+
+@item --rebuild-keydb-caches
+@opindex rebuild-keydb-caches
+ThisWhen 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 @code{algo}
+@itemx --print-mds
+@opindex print-md
+Print message digest of algorithm ALGO for all given files or stdin.
+With the second form (or a deprecated "*" as algo) digests for all
+available algorithms are printed.
+
+@item --gen-random @code{0|1|2}
+@opindex gen-random
+Emit @var{count} random bytes of the given quality level. If count is
+not given or zero, an endless sequence of random bytes will be emitted.
+PLEASE, don't use this command unless you know what you are doing; it
+may remove precious entropy from the system!
+
+@item --gen-prime @code{mode}  @code{bits}
+@opindex gen-prime
+Use the source, Luke :-). The output format is still subject to change.
+
+@end table
+
+
+@c *******************************************
+@c *******  KEY MANGEMENT COMMANDS  **********
+@c *******************************************
+@node OpenPGP Key Management
+@subsection How to manage your keys
+
+This section explains the main commands for key management
+
+@table @gnupgtabopt
+
 @item --gen-key
+@opindex gen-key
 Generate a new key pair. This command is normally only used
 interactively.
 
-There is an experimental feature which allows you to create keys
-in batch mode. See the file @file{doc/DETAILS}
-in the source distribution on how to use this.
+There is an experimental feature which allows you to create keys in
+batch mode. See the file @file{doc/DETAILS} in the source distribution
+on how to use this.
 
-@item --edit-key @code{name}
-Present a menu which enables you to do all key
-related tasks:
+@item --gen-revoke @code{name}
+@opindex gen-revoke
+Generate a revocation certificate for the complete key. To revoke
+a subkey or a signature, use the --edit command.
 
+@item --desig-revoke @code{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 sign
+@opindex keyedit:sign
 Make a signature on key of user @code{name} If the key is not yet
 signed by the default user (or the users given with -u), the program
 displays the information of the key again, together with its
@@ -186,109 +488,135 @@ repeated for all users specified with
 -u.
 
 @item lsign
+@opindex keyedit:lsign
 Same as "sign" but the signature is marked as non-exportable and will
 therefore never be used by others. This may be used to make keys
 valid only in the local environment.
 
 @item nrsign
+@opindex keyedit:nrsign
 Same as "sign" but the signature is marked as non-revocable and can
 therefore never be revoked.
 
 @item tsign
+@opindex keyedit:tsign
 Make a trust signature. This is a signature that combines the notions
 of certification (like a regular signature), and trust (like the
 "trust" command). It is generally only useful in distinct communities
 or groups.
 @end table
 
+@c man:.RS
 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
 
 @table @asis
 
 @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 trust
+@opindex keyedit:trust
 Change the owner trust value. 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 adduid
+@opindex keyedit:adduid
 Create an alternate 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
-dialog box (PGP).
+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 deluid
-Delete a user id.
+@opindex keyedit:deluid
+Delete a 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 delsig
-Delete a signature.
+@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 revuid
+@opindex keyedit:revuid
 Revoke a user id.
 
 @item addkey
+@opindex keyedit:addkey
 Add a subkey to this key.
 
 @item addcardkey
-Generate a key on a card and add it 
-to this key.
+@opindex keyedit:addcardkey
+Generate a key on a card and add it to this key.
 
 @item keytocard
-Transfer the selected secret key (or the primary key if no key 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.
+@opindex keyedit:keytocard
+Transfer the selected secret key (or the primary key if no key has been
+selected) to a smartcard. The secret key in the keyring will be replaced
+by a stub if the key could be stored successfully on the card and you
+use the save command later. Only certain key types may be transferred to
+the card. A sub menu allows you to select on what card to store the
+key. Note that it is not possible to get that key back from the card -
+if the card gets broken your secret key will be lost unless you have a
+backup somewhere.
 
 @item bkuptocard @code{file}
-Restore the given file to a card. This command
-may be used to restore a backup key (as generated during card
-initialization) to a new card. In almost all cases this will be the
-encryption key. You should use this command only
-with the corresponding public key and make sure that the file
-given as argument is indeed the backup to restore. You should
-then select 2 to restore as encryption key.
-You will first be asked to enter the passphrase of the backup key and
-then for the Admin PIN of the card.
+@opindex keyedit:bkuptocard
+Restore the given file to a card. This command may be used to restore a
+backup key (as generated during card initialization) to a new card. In
+almost all cases this will be the encryption key. You should use this
+command only with the corresponding public key and make sure that the
+file given as argument is indeed the backup to restore. You should then
+select 2 to restore as encryption key.  You will first be asked to enter
+the passphrase of the backup key and then for the Admin PIN of the card.
 
 @item delkey
-Remove a subkey.
+@opindex keyedit:delkey
+Remove a subkey (secondart key). Note that it is not possible to retract
+a subkey, once it has been send to the public (i.e. to a keyserver).  In
+that case you better use @code{revkey}.
 
-@item addrevoker 
+@item addrevoker
+@opindex keyedit:addrevoker
 Add a designated revoker. This takes one optional argument:
-"sensitive". If a designated revoker is marked as sensitive, it will
-not be exported by default (see
-export-options).
+"sensitive". If a designated revoker is marked as sensitive, it will not
+be exported by default (see export-options).
 
 @item revkey
+@opindex keyedit:revkey
 Revoke a subkey.
 
 @item expire
+@opindex keyedit:expire
 Change the key 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 passwd
+@opindex keyedit:passwd
 Change the passphrase of the secret key.
 
 @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
@@ -297,31 +625,39 @@ regular user ID as primary makes it primary over other regular user
 IDs.
 
 @item uid @code{n}
+@opindex keyedit:uid
 Toggle selection of user id with index @code{n}.
 Use 0 to deselect all.
 
 @item key @code{n}
+@opindex keyedit:key
 Toggle selection of subkey with index @code{n}.
 Use 0 to deselect all.
 
 @item check
+@opindex keyedit:check
 Check all selected user ids.
 
 @item showphoto
+@opindex keyedit:showphoto
 Display the selected photographic user
 id.
 
 @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.
+the preferences in effect by including the implied preferences of 3DES
+(cipher), SHA-1 (digest), and Uncompressed (compression) if they are
+not already included in the preference list. In addition, the
+preferred keyserver and signature notations (if any) are shown.
 
 @item setpref @code{string}
+@opindex keyedit:setpref
 Set the list of user ID preferences to @code{string} for all (or just
 the selected) user IDs. Calling setpref with no arguments sets the
 preference list to the default (either built-in or set via
@@ -333,50 +669,64 @@ select keys via attribute user IDs so these preferences will not be
 used by GnuPG.
 
 @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
---keyserver-option honor-keyserver-url for more on how this works.
-Note that some versions of PGP interpret the presence of a keyserver
-URL as an instruction to enable PGP/MIME mail encoding. Setting a
-value of "none" removes a existing preferred keyserver.
+--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
+--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 toggle
+@opindex keyedit:toggle
 Toggle between public and secret key listing.
 
 @item clean
-Cleans keys by removing unusable pieces. This command can be used to
-keep keys neat and clean, and it has no effect aside from that.
-
-@table @asis
-
-@item sigs
-Remove any signatures that are not usable by the trust calculations.
-For example, this removes any signature that does not validate. It
-also removes any signature that is superceded by a later signature, or
-signatures that were revoked.
-
-@item uids
+@opindex keyedit:clean
 Compact (by removing all signatures except the selfsig) any user ID
-that is no longer usable (e.g. revoked, or expired).
-@end table
-
-@noindent
-If invoked with no arguments, both `sigs' and `uids' are cleaned.
+that is no longer usable (e.g. revoked, or expired). Then, remove any
+signatures that are not usable by the trust calculations.
+Specifically, this removes any signature that does not validate, any
+signature that is superseded by a later signature, revoked signatures,
+and signatures issued by keys that are not present on the keyring.
+
+@item minimize
+@opindex keyedit:minimize
+Make the key as small as possible. This removes all signatures from
+each user ID except for the most recent self-signature.
+
+@item cross-certify
+@opindex keyedit:cross-certify
+Add cross-certification signatures to signing subkeys that may not
+currently have them. Cross-certification signatures protect against a
+subtle attack against signing subkeys. See
+--require-cross-certification.
 
 @item save
+@opindex keyedit:save
 Save all changes to the key rings and quit.
 
 @item quit
+@opindex keyedit:quit
 Quit the program without updating the
 key rings.
+
 @end table
 
-The listing shows you the key with its secondary
-keys and all user ids. Selected keys or user ids
-are indicated by an asterisk. The trust value is
-displayed with the primary key: the first is the
-assigned owner trust and the second is the calculated
-trust value. Letters are used for the values:
+@c man:.RS
+The listing shows you the key with its secondary keys and all user
+ids. Selected keys or user ids are indicated by an asterisk. The trust
+value is displayed with the primary key: the first is the assigned owner
+trust and the second is the calculated trust value. Letters are used for
+the values:
+@c man:.RE
 
 @table @asis
 
@@ -402,242 +752,195 @@ Fully trusted.
 @item u
 Ultimately trusted.
 @end table
-
-@item --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 
-http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
-
-@item --card-status
-Show the content of the smart card.
-
-@item --change-pin
-Present a menu to allow changing the PIN of a smartcard. This
-functionality is also available as the subcommand "passwd" with the
---card-edit command.
+@c ******** End Edit-key Options **********
 
 @item --sign-key @code{name}
+@opindex sign-key
 Signs a public key with your secret key. This is a shortcut version of
-the subcommand "sign" from --edit. 
+the subcommand "sign" from --edit.
 
 @item --lsign-key @code{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 --edit.
 
-@item --delete-key @code{name}
-Remove key from the public keyring. In batch mode either --yes is
-required or the key must be specified by fingerprint. This is a
-safeguard against accidental deletion of multiple keys.
 
-@item --delete-secret-key @code{name}
-Remove key from the secret and public keyring. In batch mode the key
-must be specified by fingerprint.
+@end table
 
-@item --delete-secret-and-public-key @code{name}
-Same as --delete-key, but if a secret key exists, it will be removed 
-first. In batch mode the key must be specified by fingerprint.
 
-@item --gen-revoke @code{name}
-Generate a revocation certificate for the complete key. To revoke
-a subkey or a signature, use the --edit command.
+@c *******************************************
+@c ***************            ****************
+@c ***************  OPTIONS   ****************
+@c ***************            ****************
+@c *******************************************
+@mansect options
+@node GPG Options
+@section Option Summary
 
-@item --desig-revoke @code{name}
-Generate a designated revocation certificate for a key. This allows a
-user (with the permission of the keyholder) to revoke someone else's
-key.
+@command{GPG} comes features a bunch of options to control the exact
+behaviour and to change the default configuration.
 
-@item --export 
-Either export all keys from all keyrings (default
-keyrings and those registered via option --keyring),
-or if at least one name is given, those of the given
-name. The new keyring is written to stdout or to
-the file given with option "output". Use together
-with --armor to mail those keys.
-
-@item --send-keys 
-Same as --export but sends the keys to a keyserver.
-Option --keyserver must be used to give the name
-of this keyserver. Don't send your complete keyring
-to a keyserver - select only those keys which are new
-or changed by you.
+@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.
+* GPG Esoteric Options::        Doing things one usually don't want to do.
+@end menu
 
-@item --export-secret-keys 
-@itemx --export-secret-subkeys 
-Same as --export, but exports the secret keys instead.
-This is normally not very useful and a security risk.
-The second form of the command has the special property to
-render the secret part of the primary key useless; this is
-a GNU extension to OpenPGP and other implementations can
-not be expected to successfully import such a key.
-See the option --simple-sk-checksum if you want to import such an
-exported key with an older OpenPGP implementation.
-
-@item --import 
-@itemx --fast-import 
-Import/merge keys. This adds the given keys to the
-keyring. The fast version is currently just a synonym.
+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.
 
-There are a few other options which control how this command works.
-Most notable here is the --keyserver-option merge-only option which
-does not insert new keys but does only the merging of new signatures,
-user-IDs and subkeys.
+Please remember that option parsing stops as soon as a non-option is
+encountered, you can explicitly stop parsing by using the special option
+"--".
 
-@item --recv-keys @code{key IDs}
-Import the keys with the given key IDs from a keyserver. Option
---keyserver must be used to give the name of this keyserver.
+@c *******************************************
+@c ********  CONFIGURATION OPTIONS  **********
+@c *******************************************
+@node GPG Configuration Options
+@subsection How to change the configuration
 
-@item --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. Option --keyserver must be used to give
-the name of the keyserver for all keys that do not have preferred
-keyservers set (see --keyserver-option honor-keyserver-url).
+These options are used to change the configuraton and are usually found
+in the option file.
 
-@item --search-keys 
-Search the keyserver for the given names. Multiple names given here
-will be joined together to create the search string for the keyserver.
-Option --keyserver must be used to give the name of this keyserver.
-Keyservers that support different search methods allow using the
-syntax specified in "How to specify a user ID" below. Note that
-different keyserver types support different search methods. Currently
-only LDAP supports them all.
+@table @gnupgtabopt
 
-@item --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
---edit-key menu, the assigned value can be changed at any time.
+@item XXX
+foo
 
-@item --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 --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 --update-trustdb but it skips keys
-with a not yet defined "ownertrust".
+@end table
 
-For use with cron jobs, this command can be used together with --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 --yes.
 
-@item --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 trust DB.
+@c *******************************************
+@c ********  KEY RELATED OPTIONS  ************
+@c *******************************************
+@node GPG Key related Options
+@subsection Key related options
 
-@item --import-ownertrust 
-Update the trustdb with the ownertrust values stored
-in @code{files} (or stdin if not given); existing
-values will be overwritten.
+@table @gnupgtabopt
 
-@item --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 XXX
+foo
 
-@item --print-md @code{algo} 
-@itemx --print-mds 
-Print message digest of algorithm ALGO for all given files or stdin.
-With the second form (or a deprecated "*" as algo) digests for all
-available algorithms are printed.
+@end table
 
-@item --gen-random @code{0|1|2}  
-Emit COUNT random bytes of the given quality level. If count is not given
-or zero, an endless sequence of random bytes will be emitted.
-PLEASE, don't use this command unless you know what you are doing; it may
-remove precious entropy from the system!
+@c *******************************************
+@c ********  INPUT AND OUTPUT  ***************
+@c *******************************************
+@node GPG Input and Output
+@subsection Input and Output
 
-@item --gen-prime @code{mode}  @code{bits}  
-Use the source, Luke :-). The output format is still subject to change.
+@table @gnupgtabopt
 
-@item --version
-Print version information along with a list
-of supported algorithms.
+@item XXX
+foo
 
-@item --warranty
-Print warranty information.
+@end table
+
+@c *******************************************
+@c ********  OPENPGP OPTIONS  ****************
+@c *******************************************
+@node OpenPGP Options
+@subsection OpenPGP protocol specific options.
+
+@table @gnupgtabopt
+
+@item XXX
+foo
 
-@item -h, --help
-Print usage information. This is a really long list even though it
-doesn't list all options. For every option, consult this manual.
 @end table
-@chapheading OPTIONS
 
-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.
+@c *******************************************
+@c ********  ESOTERIC OPTIONS  ***************
+@c *******************************************
+@node GPG Esoteric Options
+@subsection Doing things one usually don't want to do.
 
-@code{gpg} recognizes these options:
+@table @gnupgtabopt
 
-@table @asis
+@item XXX
+foo
 
-@item -a, --armor
-Create ASCII armored output.
 
-@item -o, --output @code{file}
-Write output to @code{file}.
+@item --armor
+@itemx -a
+@opindex armor
+Create ASCII armored output.  The default is to create the binary
+OpenPGP format.
+
+@item --output @var{file}
+@itemx -o @var{file}
+@opindex output
+Write output to @var{file}.
 
 @item --max-output @code{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".
+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 --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. --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 -u, --local-user @code{name}
-Use @code{name} as the key to sign with. Note that this option
-overrides --default-key.
-
-@item --default-key @code{name}
-Use @code{name} as the default key to sign with. If this option is not
+dot. --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 --local-user @var{name}
+@itemx -u
+@opindex local-user
+Use @var{name} as the key to sign with. Note that this option overrides
+--default-key.
+
+@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 -u or --local-user overrides this option.
 
-@item -r, --recipient @code{name}
-Encrypt for user id @code{name}. If this option or --hidden-recipient
-is not specified, GnuPG asks for the user-id unless
---default-recipient is given.
-
-@item -R, --hidden-recipient @code{name}
-Encrypt for user ID @code{name}, but hide the key ID of this user's
+@item --recipient @var{name}
+@itemx -r
+@opindex recipient
+Encrypt for user id @var{name}. If this option or --hidden-recipient is
+not specified, GnuPG asks for the user-id unless --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
 --recipient is not specified, GnuPG asks for the user ID unless
 --default-recipient is given.
 
-@item --default-recipient @code{name}
-Use @code{name} as default recipient if option --recipient is not used and
-don't ask if this is a valid one. @code{name} must be non-empty.
+@item --default-recipient @var{name}
+@opindex default-recipient
+Use @var{name} as default recipient if 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
-Use the default key as default recipient if 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 --default-key.
+@opindex default-recipient-self
+Use the default key as default recipient if 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 --default-key.
 
 @item --no-default-recipient
+@opindex no-default-recipient
 Reset --default-recipient and --default-recipient-self.
 
 @item --encrypt-to @code{name}
@@ -773,16 +1076,17 @@ as a full 8 byte key ID) 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. 
+recipient's or signator's key.
 
-@item --trust-model @code{pgp|classic|always}
+@item --trust-model @code{pgp|classic|direct|always|auto}
 Set what trust model GnuPG should follow. The models are:
 
 @table @asis
 
 @item pgp
 This is the Web of Trust combined with trust signatures as used in PGP
-5.x and later. This is the default trust model.
+5.x and later. This is the default trust model when creating a new
+trust database.
 
 @item classic
 This is the standard Web of Trust as used in PGP 2.x and earlier.
@@ -793,15 +1097,50 @@ Web of Trust.
 
 @item always
 Skip key validation and assume that used keys are always fully
-trusted. You won't use this unless you have installed 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.
+trusted. You generally won't use this unless you are using some
+external validation scheme. This option also suppresses the
+"[uncertain]" tag printed with signature checks when there is no
+evidence that the user ID is bound to the key.
+
+@item auto
+Select the trust model depending on whatever the internal trust
+database says. This is the default model if such a database already
+exists.
 @end table
 
 @item --always-trust
 Identical to `--trust-model always'. This option is deprecated.
 
+@item --auto-key-locate @code{parameters}
+@itemx --no-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 following
+arguments, in the order they are to be tried:
+
+@table @asis
+
+@item cert
+locate a key using DNS CERT, as specified in 2538bis (currently in
+draft): http://www.josefsson.org/rfc2538bis/
+
+@item pka
+locate a key using DNS PKA.
+
+@item ldap
+locate a key using the PGP Universal method of checking
+"ldap://keys.(thedomain)".
+
+@item keyserver
+locate a key using whatever keyserver is defined using the --keyserver
+option.
+
+@item (keyserver URL)
+In addition, a keyserver URL as used in the --keyserver option may be
+used here to query that particular keyserver.
+@end table
+
 @item --keyid-format @code{short|0xshort|long|0xlong}
 Select how to display key IDs. "short" is the traditional 8-character
 key ID. "long" is the more accurate (but less convenient)
@@ -814,17 +1153,20 @@ Use @code{name} as your keyserver. This is the server that
 receive keys from, send keys to, and search for keys on. The format
 of the @code{name} is a URI: `scheme:[//]keyservername[:port]' The
 scheme is the type of keyserver: "hkp" for the HTTP (or compatible)
-keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the
-Graff email keyserver. Note that your particular installation of
-GnuPG may have other keyserver types available as well. Keyserver
-schemes are case-insensitive.
+keyservers, "ldap" for the LDAP keyservers, or "mailto" for the Graff
+email keyserver. 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
+global --keyserver-options from below, but apply only to this
+particular keyserver.
 
 Most keyservers synchronize with each other, so there is generally no
 need to send keys to more than one server. The keyserver
 "hkp://subkeys.pgp.net" uses round robin DNS to give a different
 keyserver each time you use it.
 
-@item --keyserver-options @code{parameters}
+@item --keyserver-options @code{name=value1 }
 This is a space or comma delimited string that gives options for the
 keyserver. Options can be prepended with a `no-' to give the opposite
 meaning. Valid import-options or export-options may be used here as
@@ -841,17 +1183,35 @@ 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. Defaults to on.
+incorrectly marked as revoked.
 
 @item include-disabled
 When searching for a key with --search-keys, include keys that are
 marked on the keyserver as disabled. Note that this option is not
 used with HKP keyservers.
 
+@item auto-key-retrieve
+This option enables the automatic retrieving of keys from a keyserver
+when verifying signatures made by keys that are not on the local
+keyring.
+
+Note that this option makes a "web bug" like behavior possible.
+Keyserver operators can see which keys you request, so by sending you
+a message signed by a brand new key (which you naturally will not have
+on your local keyring), the operator can tell both your IP address and
+the time when you verified the signature.
+
 @item honor-keyserver-url
 When using --refresh-keys, if the key in question has a preferred
-keyserver set, then use that preferred keyserver to refresh the key
-from. Defaults to yes.
+keyserver URL, then use that preferred keyserver to refresh the key
+from. In addition, if auto-key-retrieve is set, and the signature
+being verified has a preferred keyserver URL, then use that preferred
+keyserver to fetch the key from. Defaults to yes.
+
+@item honor-pka-record
+If auto-key-retrieve is set, and the signature being verified has a
+PKA record, then use the PKA information to fetch the key. Defaults
+to yes.
 
 @item include-subkeys
 When receiving a key, include subkeys as potential targets. Note that
@@ -885,19 +1245,12 @@ timeout applies separately to each key retrieval, and not to the
 For HTTP-like keyserver schemes that (such as HKP and HTTP itself),
 try to access the keyserver over a proxy. If a @code{value} is
 specified, use this as the HTTP proxy. If no @code{value} is
-specified, try to use the value of the environment variable
-"http_proxy".
-
-@item auto-key-retrieve
-This option enables the automatic retrieving of keys from a keyserver
-when verifying signatures made by keys that are not on the local
-keyring.
+specified, the value of the environment variable "http_proxy", if any,
+will be used.
 
-Note that this option makes a "web bug" like behavior possible.
-Keyserver operators can see which keys you request, so by sending you
-a message signed by a brand new key (which you naturally will not have
-on your local keyring), the operator can tell both your IP address and
-the time when you verified the signature.
+@item max-cert-size
+When retrieving a key via DNS CERT, only accept keys up to this size.
+Defaults to 16384 bytes.
 @end table
 
 @item --import-options @code{parameters}
@@ -924,18 +1277,19 @@ yes for keyserver --recv-keys.
 During import, allow key updates to existing keys, but do not allow
 any new keys to be imported. Defaults to no.
 
-@item import-clean-sigs
-After import, remove any signatures from the new key that are not
-usable. This is the same as running the --edit-key command "clean
-sigs" after import. Defaults to no.
-
-@item import-clean-uids
-After import, compact (remove all signatures from) any user IDs from
-the new key that are not usable. This is the same as running the
---edit-key command "clean uids" after import. Defaults to no.
-
 @item import-clean
-Identical to "import-clean-sigs import-clean-uids".
+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 --edit-key
+command "clean" after import. Defaults to no.
+
+@item import-minimal
+Import the smallest key possible. This removes all signatures except
+the most recent self-signature on each user ID. This option is the
+same as running the --edit-key command "minimize" after import.
+Defaults to no.
 @end table
 
 @item --export-options @code{parameters}
@@ -959,25 +1313,26 @@ program that does not accept attribute user IDs. Defaults to yes.
 Include designated revoker information that was marked as
 "sensitive". Defaults to no.
 
-@item export-minimal
-Export the smallest key possible. Currently this is done by leaving
-out any signatures that are not self-signatures. Defaults to no.
-
-@item export-clean-sigs
-Do not export any signatures that are not usable. This is the same as
-running the --edit-key command "clean sigs" before export. Defaults
-to no.
-
-@item export-clean-uids
-Compact (remove all signatures from) user IDs on the key being
-exported if the user IDs are not usable. This is the same as running
-the --edit-key command "clean uids" before export. Defaults to no.
-
 @item export-reset-subkey-passwd
 When using the "--export-secret-subkeys" command, this option resets
 the passphrases for all exported subkeys to empty. This is useful
 when the exported subkey is to be used on an unattended machine where
 a passphrase doesn't necessarily make sense. Defaults to no.
+
+@item export-clean
+Compact (remove all signatures from) user IDs on the key being
+exported if the user IDs are not usable. Also, do not export any
+signatures that are not usable. This includes signatures that were
+issued by keys that are not present on the keyring. This option is
+the same as running the --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 --edit-key command "minimize" before export except
+that the local copy of the key is not modified. Defaults to no.
 @end table
 
 @item --list-options @code{parameters}
@@ -1065,8 +1420,26 @@ the signature. Defaults to no.
 @item show-unusable-uids
 Show revoked and expired user IDs during signature verification.
 Defaults to no.
+
+@item pka-lookups
+Enable PKA lookups to verify sender addresses. Note that PKA is based
+on DNS, and so enabling this option may disclose information on when
+and what signatures are verified or to whom data is encrypted. This
+is similar to the "web bug" described for the auto-key-retrieve
+feature.
+
+@item pka-trust-increase
+Raise the trust in a signature to full if the signature passes PKA
+validation. This option is only meaningful if pka-lookups is set.
 @end table
 
+@item --enable-dsa2
+@itemx --disable-dsa2
+Enables new-style DSA keys which (unlike the old style) may be larger
+than 1024 bit and use hashes other than SHA-1 and RIPEMD/160. Note
+that very few programs currently support these keys and signatures
+from them.
+
 @item --show-photos
 @itemx --no-show-photos
 Causes --list-keys, --list-sigs, --list-public-keys,
@@ -1135,10 +1508,10 @@ a options file. This also overrides the environment variable
 $GNUPGHOME.
 
 @item --pcsc-driver @code{file}
-Use @code{file} to access the smartcard reader. The current default
-is `libpcsclite.so'. Instead of using this option you might also
-want to install a symbolic link to the default file name
-(e.g. from `libpcsclite.so.1').
+Use @code{file} to access the smartcard reader. The current default is
+`libpcsclite.so.1' for GLIBC based systems,
+`/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
+`winscard.dll' for Windows and `libpcsclite.so' for other systems.
 
 @item --ctapi-driver @code{file}
 Use @code{file} to access the smartcard reader. The current default
@@ -1205,7 +1578,7 @@ in an options file.
 @item --no-options
 Shortcut for "--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 
+Using this option will also prevent the creation of a
 "~./gnupg" homedir.
 
 @item --load-extension @code{name}
@@ -1327,7 +1700,7 @@ are deprecated. Use `--list-options [no-]show-policy-url' and/or
 @item --sig-keyserver-url @code{string}
 Use @code{string} as a preferred keyserver URL for data signatures. If
 you prefix it with an exclamation mark, the keyserver URL packet will
-be flagged as critical. 
+be flagged as critical.
 
 The same %-expandos used for notation data are available here as well.
 
@@ -1361,14 +1734,20 @@ key signer (defaults to 3)
 Maximum depth of a certification chain (default is 5).
 
 @item --cipher-algo @code{name}
-Use @code{name} as cipher algorithm. Running the program
-with the command --version yields a list of supported
-algorithms. If this is not used the cipher algorithm is
-selected from the preferences stored with the key.
+Use @code{name} as cipher algorithm. Running the program with the
+command --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.
+--personal-cipher-preferences is the safe way to accomplish the same
+thing.
 
 @item --digest-algo @code{name}
 Use @code{name} as the message digest algorithm. Running the program
-with the command --version yields a list of supported algorithms.
+with the command --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. --personal-digest-preferences is the
+safe way to accomplish the same thing.
 
 @item --compress-algo @code{name}
 Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB
@@ -1387,7 +1766,10 @@ 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.
+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. --personal-compress-preferences is the
+safe way to accomplish the same thing.
 
 @item --cert-digest-algo @code{name}
 Use @code{name} as the message digest algorithm used when signing a
@@ -1485,21 +1867,23 @@ signature. Note that all other PGP versions do it this way too.
 Enabled by default. --no-escape-from-lines disables this option.
 
 @item --passphrase-fd @code{n}
-Read the passphrase 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.
-Don't use this option if you can avoid it.
+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.
 
 @item --passphrase-file @code{file}
-Read the passphrase from file @code{file}. This can only be used if
-only one passphrase is supplied. Obviously, a passphrase stored in a
-file is of questionable security. Don't use this option if you can
-avoid it.
+Read the passphrase from file @code{file}. Only the first line will
+be read from file @code{file}. This can only be used if only one
+passphrase is supplied. Obviously, a passphrase stored in a file is
+of questionable security if other users can read this file. Don't use
+this option if you can avoid it.
 
 @item --passphrase @code{string}
 Use @code{string} as the passphrase. This can only be used if only one
 passphrase is supplied. Obviously, this is of very questionable
-security. Don't use this option if you can avoid it.
+security on a multi-user system. Don't use this option if you can
+avoid it.
 
 @item --command-fd @code{n}
 This is a replacement for the deprecated shared-memory IPC mode.
@@ -1587,7 +1971,8 @@ TWOFISH.
 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 --throw-keyids and set --escape-from-lines.
-All algorithms are allowed except for the SHA384 and SHA512 digests.
+All algorithms are allowed except for the SHA224, SHA384, and SHA512
+digests.
 @end table
 
 @item --force-v3-sigs
@@ -1712,10 +2097,10 @@ 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 --homedir permissions cannot be
-supressed 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 supress
+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 --homedir permissions warning may only be
-supressed on the command line.
+suppressed on the command line.
 
 @item --no-mdc-warning
 Suppress the warning about missing MDC integrity protection.
@@ -1788,19 +2173,29 @@ of one specific message without compromising all messages ever
 encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
 FORCED TO DO SO.
 
-@item --override-session-key @code{string} 
+@item --override-session-key @code{string}
 Don't use the public key but the session key @code{string}. The format of this
 string is the same as the one printed by --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.
 
+@item --require-cross-certification
+@itemx --no-require-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.
+Currently defaults to --no-require-cross-certification, but will be
+changed to --require-cross-certification in the future.
+
 @item --ask-sig-expire
 @itemx --no-ask-sig-expire
 When making a data signature, prompt for an expiration time. If this
 option is not specified, the expiration time set via
 --default-sig-expire is used. --no-ask-sig-expire disables this
-option.
+option. Note that by default, --force-v3-sigs is set which also
+disables this option. If you want signature expiration, you must set
+--no-force-v3-sigs as well as turning --ask-sig-expire on.
 
 @item --default-sig-expire
 The default expiration time to use for signature expiration. Valid
@@ -1843,6 +2238,12 @@ behaviour as used by anonymous recipients (created by using
 --throw-keyids) and might come handy in case where an encrypted
 message contains a bogus key ID.
 
+@item --allow-multisig-verification
+Allow verification of concatenated signed messages. This will run a
+signature verification for each data+signature block. There are some
+security issues with this option and thus it is off by default. Note
+that versions of GPG prior to version 1.4.3 implicitly allowed this.
+
 @item --enable-special-filenames
 This options enables a mode in which filenames of the form
 @file{-&n}, where n is a non-negative decimal number,
@@ -1901,75 +2302,132 @@ preferences. The most highly ranked algorithm in this list is also
 used when there are no recipient keys to consider (e.g. --symmetric).
 
 @item --default-preference-list @code{string}
+@opindex default-preference-list
 Set the list of default preferences to @code{string}. This preference
 list is used for new keys and becomes the default for "setpref" in the
 edit menu.
 
-@item --list-config 
+@item --default-keyserver-url @code{name}
+@opindex default-keyserver-url
+Set the default keyserver URL to @code{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. --list-config is
 only usable with --with-colons set.
+
 @end table
-@chapheading How to specify a user ID
 
-There are different ways to specify a user ID to GnuPG; here are some
-examples:
 
-@table @asis
 
-@item 
 
-@item 234567C4
-@itemx 0F34E556E
-@itemx 01347A56A
-@itemx 0xAB123456
-Here the key ID is given in the usual short form.
+@c *******************************************
+@c ***************            ****************
+@c ***************   FILES    ****************
+@c ***************            ****************
+@c *******************************************
+@mansect files
+@node GPG Configuration
+@section Configuration files
 
-@item 234AABBCC34567C4
-@itemx 0F323456784E56EAB
-@itemx 01AB3FED1347A5612
-@itemx 0x234AABBCC34567C4
-Here the key ID is given in the long form as used by OpenPGP
-(you can get the long key ID using the option --with-colons).
+There are a few configuration files to control certain aspects of
+@command{gpg2}'s operation. Unless noted, they are expected in the
+current home directory (@pxref{option --homedir}).
 
-@item 1234343434343434C434343434343434
-@itemx 123434343434343C3434343434343734349A3434
-@itemx 0E12343434343434343434EAB3484343434343434
-@itemx 0xE12343434343434343434EAB3484343434343434
-The best way to specify a key ID is by using the fingerprint of
-the key. This avoids any ambiguities in case that there are duplicated
-key IDs (which are really rare for the long key IDs).
+@table @file
 
-@item =Heinrich Heine <heinrichh@@uni-duesseldorf.de>
-Using an exact to match string. The equal sign indicates this.
+@item gpg.conf
+@cindex gpgsm.conf
+This is the standard configuration file read by @command{gpg2} on
+startup.  It may contain any valid long option; the leading two dashes
+may not be entered and the option may not be abbreviated.  This default
+name may be changed on the command line (@pxref{option
+  --options}).
 
-@item <heinrichh@@uni-duesseldorf.de>
-Using the email address part which must match exactly. The left angle bracket
-indicates this email address mode.
+@end table
 
-@item @@heinrichh
-Match within the <email.address> part of a user ID. The at sign
-indicates this email address mode.
+@c man:.RE
+Note that on larger installations, it is useful to put predefined files
+into the directory @file{/etc/skel/.gnupg/} so that newly created users
+start up with a working configuration.  For existing users the a small
+helper script is provided to create these files (@pxref{addgnupghome}).
+
+For internal purposes @command{gpg2} creates and maintaines a few other
+files; They all live in in the current home directory (@pxref{option
+--homedir}).  Only the @command{gpg2} may modify these files.
+
+
+@table @file
+@item ~/.gnupg/secring.gpg
+The secret keyring.
+
+@item ~/.gnupg/secring.gpg.lock
+and the lock file
+
+@item ~/.gnupg/pubring.gpg
+The public keyring
+
+@item ~/.gnupg/pubring.gpg.lock
+and the lock file
+
+@item ~/.gnupg/trustdb.gpg
+The trust database
+
+@item ~/.gnupg/trustdb.gpg.lock
+and the lock file
+
+@item ~/.gnupg/random_seed
+used to preserve the internal random pool
+
+@item /usr[/local]/share/gnupg/options.skel
+Skeleton options file
+
+@item /usr[/local]/lib/gnupg/
+Default location for extensions
 
-@item Heine
-@itemx *Heine
-By case insensitive substring matching. This is the default mode but
-applications may want to explicitly indicate this by putting the asterisk
-in front.
 @end table
 
-Note that you can append an exclamation mark (!) to key IDs or
-fingerprints. This flag tells GnuPG to use the specified primary or
-secondary key and not to try and calculate which primary or secondary
-key to use.
-@chapheading RETURN VALUE
+@c man:.RE
+Operation is further controlled by a few environment variables:
 
-The program returns 0 if everything was fine, 1 if at least
-a signature was bad, and other error codes for fatal errors.
-@chapheading EXAMPLES
+@table @asis
+
+@item HOME
+Used to locate the default home directory.
+
+@item GNUPGHOME
+If set directory used instead of "~/.gnupg".
+
+@item GPG_AGENT_INFO
+Used to locate the gpg-agent; only honored when
+--use-agent is set. The value consists of 3 colon delimited fields:
+The first is the path to the Unix Domain Socket, the second the PID of
+the gpg-agent and the protocol version which should be set to 1. When
+starting the gpg-agent as described in its documentation, this
+variable is set to the correct value. The option --gpg-agent-info can
+be used to override it.
+
+@item COLUMNS
+@itemx LINES
+Used to size some displays to the full size of the screen.
+
+@end table
+
+
+@c *******************************************
+@c ***************            ****************
+@c ***************  EXAMPLES  ****************
+@c ***************            ****************
+@c *******************************************
+@mansect examples
+@node GPG Examples
+@section Examples
 
 @table @asis
 
@@ -1989,7 +2447,7 @@ show keys
 show fingerprint
 
 @item gpg --verify @code{pgpfile}
-@itemx gpg --verify @code{sigfile} 
+@itemx gpg --verify @code{sigfile}
 Verify the signature of the file but do not output the data. The
 second form is used for detached signatures, where @code{sigfile}
 is the detached signature (either ASCII armored or binary) and
@@ -1998,71 +2456,69 @@ 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.
 @end table
-@chapheading ENVIRONMENT
 
-@table @asis
 
-@item HOME
-Used to locate the default home directory.
-
-@item GNUPGHOME
-If set directory used instead of "~/.gnupg".
-
-@item GPG_AGENT_INFO
-Used to locate the gpg-agent; only honored when
---use-agent is set. The value consists of 3 colon delimited fields: 
-The first is the path to the Unix Domain Socket, the second the PID of
-the gpg-agent and the protocol version which should be set to 1. When
-starting the gpg-agent as described in its documentation, this
-variable is set to the correct value. The option --gpg-agent-info can
-be used to override it.
-
-@item http_proxy
-Only honored when the keyserver-option
-honor-http-proxy is set.
+@mansect how to specify a user id
+@chapheading How to specify a user ID
 
-@item COLUMNS
-@itemx LINES
-Used to size some displays to the full size of the screen.
-@end table
-@chapheading FILES
+There are different ways to specify a user ID to GnuPG; here are some
+examples:
 
 @table @asis
 
-@item ~/.gnupg/secring.gpg
-The secret keyring
+@item
 
-@item ~/.gnupg/secring.gpg.lock
-and the lock file
+@item 234567C4
+@itemx 0F34E556E
+@itemx 01347A56A
+@itemx 0xAB123456
+Here the key ID is given in the usual short form.
 
-@item ~/.gnupg/pubring.gpg
-The public keyring
+@item 234AABBCC34567C4
+@itemx 0F323456784E56EAB
+@itemx 01AB3FED1347A5612
+@itemx 0x234AABBCC34567C4
+Here the key ID is given in the long form as used by OpenPGP
+(you can get the long key ID using the option --with-colons).
 
-@item ~/.gnupg/pubring.gpg.lock
-and the lock file
+@item 1234343434343434C434343434343434
+@itemx 123434343434343C3434343434343734349A3434
+@itemx 0E12343434343434343434EAB3484343434343434
+@itemx 0xE12343434343434343434EAB3484343434343434
+The best way to specify a key ID is by using the fingerprint of
+the key. This avoids any ambiguities in case that there are duplicated
+key IDs (which are really rare for the long key IDs).
 
-@item ~/.gnupg/trustdb.gpg
-The trust database
+@item =Heinrich Heine <heinrichh@@uni-duesseldorf.de>
+Using an exact to match string. The equal sign indicates this.
 
-@item ~/.gnupg/trustdb.gpg.lock
-and the lock file
+@item <heinrichh@@uni-duesseldorf.de>
+Using the email address part which must match exactly. The left angle bracket
+indicates this email address mode.
 
-@item ~/.gnupg/random_seed
-used to preserve the internal random pool
+@item @@heinrichh
+Match within the <email.address> part of a user ID. The at sign
+indicates this email address mode.
 
-@item ~/.gnupg/gpg.conf
-Default configuration file
+@item Heine
+@itemx *Heine
+By case insensitive substring matching. This is the default mode but
+applications may want to explicitly indicate this by putting the asterisk
+in front.
+@end table
 
-@item ~/.gnupg/options
-Old style configuration file; only used when gpg.conf
-is not found
+Note that you can append an exclamation mark (!) to key IDs or
+fingerprints. This flag tells GnuPG to use the specified primary or
+secondary key and not to try and calculate which primary or secondary
+key to use.
 
-@item /usr[/local]/share/gnupg/options.skel
-Skeleton options file
+@mansect return vaue
+@chapheading RETURN VALUE
 
-@item /usr[/local]/lib/gnupg/
-Default location for extensions
-@end table
+The program returns 0 if everything was fine, 1 if at least
+a signature was bad, and other error codes for fatal errors.
+
+@mansect warnings
 @chapheading WARNINGS
 
 Use a *good* password for your user account and a *good* passphrase
@@ -2077,6 +2533,8 @@ is *very* easy to spy out your passphrase!
 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.
+
+@mansect interoperability
 @chapheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
 
 GnuPG tries to be a very flexible implementation of the OpenPGP
@@ -2105,6 +2563,8 @@ better off using the --pgp6, --pgp7, or --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 many systems this program should be installed as setuid(root). This
@@ -2115,4 +2575,3 @@ 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.
 
-@bye