* gpg.sgml: Document --list-options (show-photos, show-policy-url,
[gnupg.git] / doc / gpg.sgml
index 91f4b0a..cd5de63 100644 (file)
@@ -1,5 +1,6 @@
 <!-- gpg.sgml - the man page for GnuPG
-    Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+    Copyright (C) 1998, 1999, 2000, 2001, 2002,
+                  2003 Free Software Foundation, Inc.
 
     This file is part of GnuPG.
 
 </refnamediv>
 <refsynopsisdiv>
   <synopsis>
-<command>gpg</>
+<command>gpg</command>
  <optional>--homedir <parameter/name/</optional>
  <optional>--options <parameter/file/</optional>
  <optional><parameter/options/</optional>
- <parameter>command</>
+ <parameter>command</parameter>
  <optional><parameter/args/</optional>
   </synopsis>
 </refsynopsisdiv>
@@ -124,10 +125,12 @@ Encrypt data. This option may be combined with --sign.
 <varlistentry>
 <term>-c, --symmetric</term>
 <listitem><para>
-Encrypt with symmetric cipher only.
-This command asks for a passphrase.
+Encrypt with a symmetric cipher using a passphrase.  The default
+symmetric cipher used is CAST5, but may be chosen with the
+--cipher-algo option.
 </para></listitem></varlistentry>
 
+
 <varlistentry>
 <term>--store</term>
 <listitem><para>
@@ -213,8 +216,13 @@ B<-k> [I<username>] [I<keyring>]
 <term>--list-keys &OptParmNames;</term>
 <term>--list-public-keys &OptParmNames;</term>
 <listitem><para>
-List all keys from the public keyrings, or just the
-ones given on the command line.
+List all keys from the public keyrings, or just the ones given on the
+command line.
+</para><para>
+Avoid using the output of this command in scripts or other programs as
+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.
 </para></listitem></varlistentry>
 
 
@@ -232,6 +240,18 @@ is not usable (for example, if it was created via
 <term>--list-sigs &OptParmNames;</term>
 <listitem><para>
 Same as --list-keys, but the signatures are listed too.
+</para><para>
+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 --default-cert-check-level), "L" for a
+local or non-exportable signature (see --lsign-key), "R" for a
+nonRevocable signature (see --nrsign-key), "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").
 </para></listitem></varlistentry>
 
 
@@ -334,8 +354,8 @@ trust-db immediately and no save is required.</para></listitem></varlistentry>
     <term>disable</term>
     <term>enable</term>
     <listitem><para>
-Disable or enable an entire key. A disabled key can normally not be used
-for encryption.</para></listitem></varlistentry>
+Disable or enable an entire key. A disabled key can not normally be
+used for encryption.</para></listitem></varlistentry>
     <varlistentry>
     <term>adduid</term>
     <listitem><para>
@@ -343,12 +363,17 @@ Create an alternate user id.</para></listitem></varlistentry>
     <varlistentry>
     <term>addphoto</term>
     <listitem><para>
-Create a photographic user id.</para></listitem></varlistentry>
+Create a photographic user id.  This will prompt for a JPEG file that
+will be embedded into the user ID.</para></listitem></varlistentry>
     <varlistentry>
     <term>deluid</term>
     <listitem><para>
 Delete a user id.</para></listitem></varlistentry>
     <varlistentry>
+    <term>revuid</term>
+    <listitem><para>
+Revoke a user id.</para></listitem></varlistentry>
+    <varlistentry>
     <term>addkey</term>
     <listitem><para>
 Add a subkey to this key.</para></listitem></varlistentry>
@@ -530,7 +555,7 @@ a subkey or a signature, use the --edit command.
 <term>--desig-revoke</term>
 <listitem><para>
 Generate a designated revocation certificate for a key.  This allows a
-user (with the permission of the keyholder) to revoke someone elses
+user (with the permission of the keyholder) to revoke someone else's
 key.
 </para></listitem></varlistentry>
 
@@ -622,37 +647,38 @@ Option --keyserver must be used to give the name of this keyserver.
 <varlistentry>
 <term>--update-trustdb</term>
 <listitem><para>
-Do trust DB maintenance.  This command goes over all keys and builds
-the Web-of-Trust. This is an interactive command because it may has to
-ask for the "ownertrust" values of keys.  The user has to give an
-estimation in how far she trusts the owner of the displayed key to
-correctly certify (sign) other keys.  It does only ask for that value
-if it has not yet been assigned to a key.  Using the edit menu, that
-value can be changed at any time later.
+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.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--check-trustdb</term>
 <listitem><para>
-Do trust DB maintenance without user interaction.  Form time to time
-the trust database must be updated so that expired keys and resulting
-changes in the Web-of-Trust can be tracked.  GnuPG tries to figure
-when this is required and then does it implicitly; this command can be
-used to force such a check.  The processing is identically to that of
---update-trustdb but it skips keys with a not yet defined "ownertrust".
+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".
 </para>
 <para>
 For use with cron jobs, this command can be used together with --batch
-in which case the check is only done when it is due.  To force a run
-even in batch mode add the option --yes.
+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.
 </para></listitem></varlistentry>
 
 
 <varlistentry>
-<term>--export-ownertrust &OptParmFile;</term>
+<term>--export-ownertrust</term>
 <listitem><para>
-Store the ownertrust values into
-&ParmFile; (or stdin if not given).  This is useful for backup
+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.
 </para></listitem></varlistentry>
@@ -720,12 +746,10 @@ Print warranty information.
 <varlistentry>
 <term>-h, --help</term>
 <listitem><para>
-Print usage information.  This is a really long list even though it doesn't list
-all options.
+Print usage information.  This is a really long list even though it
+doesn't list all options.  For every option, consult this manual.
 </para></listitem></varlistentry>
 
-
-
 </variablelist>
 </refsect1>
 
@@ -738,7 +762,8 @@ Long options can be put in an options file (default
 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 does not make sense.
+file too, but that is not generally useful as the command will execute
+automatically with every execution of gpg.
 </para>
 <para>
 <command/gpg/ recognizes these options:
@@ -760,6 +785,18 @@ Create ASCII armored output.
 Write output to &ParmFile;.
 </para></listitem></varlistentry>
 
+<varlistentry>
+<term>--mangle-dos-filenames</term>
+<term>--no-mangle-dos-filenames</term>
+<listitem><para>
+The Windows version of GnuPG replaces the extension of an output
+filename to avoid problems with filenames containing more than one
+dot.  This is not necessary for newer Windows versions and so
+--no-mangle-dos-filenames can be used to switch this feature off and
+have GnuPG append the new extension.  This option has no effect on
+non-Windows platforms.
+</para></listitem></varlistentry>
+
 
 <varlistentry>
 <term>-u, --local-user &ParmName;</term>
@@ -877,13 +914,13 @@ compression level of zlib (normally 6).
 
 <varlistentry>
 <term>-t, --textmode</term>
+<term>--no-textmode</term>
 <listitem><para>
-Use canonical text mode.  If -t (but not
---textmode) is used together with armoring
-and signing, this enables clearsigned messages.
-This kludge is needed for PGP compatibility;
-normally you would use --sign or --clearsign
-to selected the type of the signature.
+Use canonical text mode.  --no-textmode disables this option.  If -t
+(but not --textmode) is used together with armoring and signing, this
+enables clearsigned messages.  This kludge is needed for command-line
+compatibility with command-line versions of PGP; normally you would
+use --sign or --clearsign to select the type of the signature.
 </para></listitem></varlistentry>
 
 
@@ -903,11 +940,13 @@ Prompt before overwriting any files.
 
 <varlistentry>
 <term>--batch</term>
+<term>--no-batch</term>
 <listitem><para>
-Use batch mode.  Never ask, do not allow interactive
-commands.
+Use batch mode.  Never ask, do not allow interactive commands.
+--no-batch disables this option.
 </para></listitem></varlistentry>
 
+
 <varlistentry>
 <term>--no-tty</term>
 <listitem><para>
@@ -918,14 +957,6 @@ warnings to the TTY if --batch is used.
 
 
 <varlistentry>
-<term>--no-batch</term>
-<listitem><para>
-Disable batch mode.  This may be of use if --batch
-is enabled from an options file.
-</para></listitem></varlistentry>
-
-
-<varlistentry>
 <term>--yes</term>
 <listitem><para>
 Assume "yes" on most questions.
@@ -984,14 +1015,14 @@ recipient's or signator's key.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>--trust-model <parameter>openpgp|classic|always</parameter></term>
+<term>--trust-model <parameter>pgp|classic|always</parameter></term>
 <listitem><para>
 
 Set what trust model GnuPG should follow.  The models are:
 
 <variablelist>
 
-<varlistentry><term>openpgp</term><listitem><para>
+<varlistentry><term>pgp</term><listitem><para>
 This is the web-of-trust combined with trust signatures as used in PGP
 5.x and later.  This is the default trust model.
 </para></listitem></varlistentry>
@@ -1052,27 +1083,25 @@ keyserver types, some common options are:
 <varlistentry>
 <term>include-revoked</term>
 <listitem><para>
-When searching for a key, include keys that are marked on the
-keyserver as revoked.  Note that this option is always set when using
-the NAI HKP keyserver, as this keyserver does not differentiate
-between revoked and unrevoked keys.  When using the LDAP keyserver,
-this applies to both searching (--search-keys) and receiving
-(--recv-keys).
+When searching for a key with --search-keys, include keys that are
+marked on the keyserver as revoked.  Note that this option is always
+set when using the NAI HKP keyserver, as this keyserver does not
+differentiate between revoked and unrevoked keys.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>include-disabled</term>
 <listitem><para>
-When receiving or searching for a key, include keys that are marked on
-the keyserver as disabled.  Note that this option is not used with HKP
-keyservers, as they do not support disabling keys.
+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.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>include-subkeys</term>
 <listitem><para>
-When receiving a key, include subkeys in the search.  Note that this
-option is not used with HKP keyservers, as they do not support
+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.
 </para></listitem></varlistentry>
 
@@ -1136,11 +1165,12 @@ Defaults to no.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>repair-hkp-subkey-bug</term>
+<term>repair-pks-subkey-bug</term>
 <listitem><para>
-During import, attempt to repair the HKP keyserver mangling multiple
-subkeys bug.  Note that this cannot completely repair the damaged key
-as some crucial data is removed by the keyserver, but it does at least
+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 --import and to
 yes for keyserver --recv-keys.
 </para></listitem></varlistentry>
@@ -1189,18 +1219,86 @@ Include designated revoker information that was marked as
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>--show-photos</term>
+<term>--list-options <parameter>parameters</parameter></term>
 <listitem><para>
-Causes --list-keys, --list-sigs, --list-public-keys,
---list-secret-keys, and verifying a signature to also display the
-photo ID attached to the key, if any.
-See also --photo-viewer.
+This is a space or comma delimited string that gives options used when
+listing keys and signatures (that is, --list-keys, --list-sigs,
+--list-public-keys, and --list-secret-keys).  Options can be prepended
+with a `no-' to give the opposite meaning.  The options are:
+<variablelist>
+
+<varlistentry>
+<term>show-photos</term>
+<listitem><para>
+Causes --list-keys, --list-sigs, --list-public-keys, and
+--list-secret-keys to display any photo IDs attached to the key.
+Defaults to no.  See also --photo-viewer.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>show-policy-url</term>
+<listitem><para>
+Show policy URLs in the --list-sigs or --check-sigs listings.
+Defaults to no.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>show-notation</term>
+<listitem><para>
+Show signature notations in the --list-sigs or --check-sigs listings.
+Defaults to no.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>show-keyring</term>
+<listitem><para>
+Display the keyring name at the head of key listings to show which
+keyring a given key resides on.  Defaults to no.
+</para></listitem></varlistentry>
+
+</variablelist>
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>--verify-options <parameter>parameters</parameter></term>
+<listitem><para>
+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:
+<variablelist>
+
+<varlistentry>
+<term>show-photos</term>
+<listitem><para>
+Display any photo IDs present on the key that issued the signature.
+Defaults to no.  See also --photo-viewer.
 </para></listitem></varlistentry>
 
 <varlistentry>
+<term>show-policy-url</term>
+<listitem><para>
+Show policy URLs in the signature being verified.  Defaults to no.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>show-notation</term>
+<listitem><para>
+Show signature notations in the signature being verified.  Defaults to
+no.
+</para></listitem></varlistentry>
+
+</variablelist>
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>--show-photos</term>
 <term>--no-show-photos</term>
 <listitem><para>
-Resets the --show-photos flag.
+Causes --list-keys, --list-sigs, --list-public-keys,
+--list-secret-keys, and verifying a signature to also display the
+photo ID attached to the key, if any.  See also --photo-viewer.  These
+options are deprecated.  Use `--list-options [no-]show-photos' and/or
+`--verify-options [no-]show-photos' instead.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1216,7 +1314,8 @@ 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.
 </para><para>
 The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
-stdin"
+stdin".  Note that if your image viewer program is not secure, then
+executing it from GnuPG does not make it secure.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1231,21 +1330,19 @@ variable.
 <varlistentry>
 <term>--show-keyring</term>
 <listitem><para>
-Causes --list-keys, --list-public-keys, and --list-secret-keys to
-display the name of the keyring a given key resides on. This is only
-useful when you're listing a specific key or set of keys. It has no
-effect when listing all keys.
+Display the keyring name at the head of key listings to show which
+keyring a given key resides on.  This option is deprecated: use
+`--list-options [no-]show-keyring' instead.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--keyring &ParmFile;</term>
 <listitem><para>
-Add &ParmFile to the list of keyrings.
-If &ParmFile 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
-home-directory ("~/.gnupg" if --homedir is not used).
-The filename may be prefixed with a scheme:</para>
+Add &ParmFile; to the list of keyrings.  If &ParmFile; 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" if --homedir is not used).  The filename
+may be prefixed with a scheme:</para>
 <para>"gnupg-ring:" is the default one.</para>
 <para>It might make sense to use it together with --no-default-keyring.
 </para></listitem></varlistentry>
@@ -1257,6 +1354,25 @@ The filename may be prefixed with a scheme:</para>
 Same as --keyring but for the secret keyrings.
 </para></listitem></varlistentry>
 
+<varlistentry>
+<term>--primary-keyring &ParmFile;</term>
+<listitem><para>
+Designate &ParmFile; as the primary public keyring.  This means that
+newly imported keys (via --import or keyserver --recv-from) will go to
+this keyring.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>--trustdb-name &ParmFile;</term>
+<listitem><para>
+
+Use &ParmFile; instead of the default trustdb.  If &ParmFile; 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" if --homedir is not used).
+
+</para></listitem></varlistentry>
+
 
 <varlistentry>
 <term>--homedir &ParmDir;</term>
@@ -1355,6 +1471,15 @@ be given in C syntax (e.g. 0x0042).
 
 
 <varlistentry>
+<term>--enable-progress-filter</term>
+<listitem><para>
+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.
+</para></listitem></varlistentry>
+
+
+<varlistentry>
 <term>--status-fd &ParmN;</term>
 <listitem><para>
 Write special status strings to the file descriptor &ParmN;.
@@ -1381,31 +1506,29 @@ delivered to the file descriptor.
 
 <varlistentry>
 <term>--sk-comments</term>
+<term>--no-sk-comments</term>
 <listitem><para>
 Include secret key comment packets when exporting secret keys.  This
 is a GnuPG extension to the OpenPGP standard, and is off by default.
 Please note that this has nothing to do with the comments in clear
-text signatures or armor headers.
+text signatures or armor headers.  --no-sk-comments disables this
+option.
 </para></listitem></varlistentry>
 
-<varlistentry>
-<term>--no-sk-comments</term>
-<listitem><para>
-Resets the --sk-comments option.
-</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--no-comment</term>
 <listitem><para>
-See --sk-comments.  This option is deprecated and may be removed soon.
+See --no-sk-comments.  This option is deprecated and may be removed
+soon.
 </para></listitem></varlistentry>
 
 
 <varlistentry>
 <term>--comment &ParmString;</term>
 <listitem><para>
-Use &ParmString; as comment string in clear text signatures.
-The default is not do write a comment string.
+Use &ParmString; as the comment string in clear text signatures.  The
+default behavior is not to use a comment string.
 </para></listitem></varlistentry>
 
 
@@ -1420,89 +1543,99 @@ default comment string anymore.
 
 
 <varlistentry>
-<term>--no-version</term>
-<listitem><para>
-Omit the version string in clear text signatures.
-</para></listitem></varlistentry>
-
-
-<varlistentry>
 <term>--emit-version</term>
+<term>--no-emit-version</term>
 <listitem><para>
-Force to write the version string in clear text
-signatures.  Use this to overwrite a previous
---no-version from a config file.
+Force inclusion of the version string in ASCII armored output.
+--no-emit-version disables this option.
 </para></listitem></varlistentry>
 
 
 <varlistentry>
-<term>-N, --notation-data &ParmNameValue;</term>
+<term>--sig-notation &ParmNameValue;</term>
+<term>--cert-notation &ParmNameValue;</term>
+<term>-N, --set-notation &ParmNameValue;</term>
 <listitem><para>
 Put the name value pair into the signature as notation data.
-&ParmName; must consist only of alphanumeric characters, digits
-or the underscore; the first character must not be a digit.
-&ParmValue; may be any printable string; it will be encoded in UTF8,
-so you should check that your --charset is set correctly.
-If you prefix &ParmName; with an exclamation mark, the notation
-data will be flagged as critical (rfc2440:5.2.3.15).
-</para></listitem></varlistentry>
+&ParmName; must consist only of printable characters or spaces, and
+must contain a '@' character.  This is to help prevent pollution of
+the IETF reserved notation namespace.  The --expert flag overrides the
+'@' check.  &ParmValue; may be any printable string; it will be
+encoded in UTF8, so you should check that your --charset is set
+correctly.  If you prefix &ParmName; with an exclamation mark, the
+notation data will be flagged as critical (rfc2440:5.2.3.15).
+--sig-notation sets a notation for data signatures.  --cert-notation
+sets a notation for key signatures (certifications).  --set-notation
+sets both.
+</para>
 
-<varlistentry>
-<term>--show-notation</term>
-<listitem><para>
-Show key signature notations in the --list-sigs or --check-sigs
-listings.
-</para></listitem></varlistentry>
+<para>
+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, and "%%" results in a single "%".  %k, %K, and
+%f are only meaningful when making a key signature (certification).
+</para>
+
+</listitem></varlistentry>
 
 <varlistentry>
+<term>--show-notation</term>
 <term>--no-show-notation</term>
 <listitem><para>
-Do not show key signature notations in the --list-sigs or --check-sigs
-listings.
+Show signature notations in the --list-sigs or --check-sigs listings
+as well as when verifying a signature with a notation in it.  These
+options are deprecated.  Use `--list-options [no-]show-notation'
+and/or `--verify-options [no-]show-notation' instead.
 </para></listitem></varlistentry>
 
+
 <varlistentry>
+<term>--sig-policy-url &ParmString;</term>
+<term>--cert-policy-url &ParmString;</term>
 <term>--set-policy-url &ParmString;</term>
 <listitem><para>
-Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19).
-If you prefix it with an exclamation mark, the policy URL
-packet will be flagged as critical.
+Use &ParmString; as Policy URL for signatures (rfc2440:5.2.3.19).  If
+you prefix it with an exclamation mark, the policy URL packet will be
+flagged as critical.  --sig-policy-url sets a a policy url for data
+signatures.  --cert-policy-url sets a policy url for key signatures
+(certifications).  --set-policy-url sets both.
+</para><para>
+The same %-expandos used for notation data are available here as well.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--show-policy-url</term>
-<listitem><para>
-Show any policy URLs set in the --list-sigs or --check-sigs listings.
-</para></listitem></varlistentry>
-
-<varlistentry>
 <term>--no-show-policy-url</term>
 <listitem><para>
-Do not show any policy URLs set in the --list-sigs or --check-sigs
-listings.
+Show policy URLs in the --list-sigs or --check-sigs listings as well
+as when verifying a signature with a policy URL in it.  These options
+are deprecated.  Use `--list-options [no-]show-policy-url' and/or
+`--verify-options [no-]show-policy-url' instead.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--set-filename &ParmString;</term>
 <listitem><para>
-Use &ParmString; as the name of file which is stored in
-messages.
+Use &ParmString; as the filename which is stored inside messages.
+This overrides the default, which is to use the actual filename of the
+file being encrypted.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--for-your-eyes-only</term>
+<term>--no-for-your-eyes-only</term>
 <listitem><para>
 Set the `for your eyes only' flag in the message.  This causes GnuPG
 to refuse to save the file unless the --output option is given, and
 PGP to use the "secure viewer" with a Tempest-resistant font to
 display the message.  This option overrides --set-filename.
-</para></listitem></varlistentry
-
-<varlistentry>
-<term>--no-for-your-eyes-only</term>
-<listitem><para>
-Resets the --for-your-eyes-only flag.
-</para></listitem></varlistentry
+--no-for-your-eyes-only disables this option.
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--use-embedded-filename</term>
@@ -1584,29 +1717,27 @@ possibly your entire key.
 <listitem><para>
 Use &ParmName; as the cipher algorithm used to protect secret keys.
 The default cipher is CAST5.  This cipher is also used for
-conventional encryption if --cipher-algo is not given.
+conventional encryption if --personal-cipher-preferences and
+--cipher-algo is not given.
 </para></listitem></varlistentry>
 
 
 <varlistentry>
 <term>--s2k-digest-algo &ParmName;</term>
 <listitem><para>
-Use  &ParmName; as the digest algorithm used to mangle the
-passphrases.  The default algorithm is RIPE-MD-160.
-This digest algorithm is also used for conventional
-encryption if --digest-algo is not given.
+Use &ParmName; as the digest algorithm used to mangle the passphrases.
+The default algorithm is SHA-1.
 </para></listitem></varlistentry>
 
 
 <varlistentry>
 <term>--s2k-mode &ParmN;</term>
 <listitem><para>
-Selects how passphrases are mangled. If &ParmN; is 0
-a plain passphrase (which is not recommended) will be used,
-a 1 (default) adds a salt to the passphrase and
-a 3 iterates the whole process a couple of times.
-Unless --rfc1991 is used, this mode is also used
-for conventional encryption.
+Selects how passphrases are mangled. If &ParmN; is 0 a plain
+passphrase (which is not recommended) will be used, a 1 adds a salt to
+the passphrase and a 3 (the default) iterates the whole process a
+couple of times.  Unless --rfc1991 is used, this mode is also used for
+conventional encryption.
 </para></listitem></varlistentry>
 
 
@@ -1665,16 +1796,12 @@ interaction, this performance penalty does not matter in most settings.
 
 <varlistentry>
 <term>--auto-check-trustdb</term>
-<listitem><para>
-If GnuPG feels that its information about the Web-of-Trust has to be
-updated, it automatically runs the --check-trustdb command 
-internally.  This may be a time consuming process.
-</para></listitem></varlistentry>
-
-<varlistentry>
 <term>--no-auto-check-trustdb</term>
 <listitem><para>
-Resets the --auto-check-trustdb option.
+If GnuPG feels that its information about the Web-of-Trust has to be
+updated, it automatically runs the --check-trustdb command internally.
+This may be a time consuming process.  --no-auto-check-trustdb
+disables this option.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1707,12 +1834,13 @@ line tells GnuPG about this cleartext signature option.
 
 <varlistentry>
 <term>--escape-from-lines</term>
+<term>--no-escape-from-lines</term>
 <listitem><para>
-Because some mailers change lines starting with "From "
-to "&#60;From " it is good to handle such lines in a special
-way when creating cleartext signatures. All other PGP
-versions do it this way too. This option is not enabled
-by default because it would violate rfc2440.
+Because some mailers change lines starting with "From " to "&#62;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.  --no-escape-from-lines disables this option.
 </para></listitem></varlistentry>
 
 
@@ -1738,24 +1866,55 @@ distribution for details on how to use it.
 
 <varlistentry>
 <term>--use-agent</term>
+<term>--no-use-agent</term>
 <listitem><para>
 Try to use the GnuPG-Agent. Please note that this agent is still under
 development.  With this option, GnuPG first tries to connect to the
-agent before it asks for a passphrase.
+agent before it asks for a passphrase.  --no-use-agent disables this
+option.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--gpg-agent-info</term>
 <listitem><para>
 Override the value of the environment variable
-<literal>GPG_AGENT_INFO</>.  This is only used when --use-agent has been given
+<literal>GPG_AGENT_INFO</literal>.  This is only used when --use-agent has been given
 </para></listitem></varlistentry>
 
+<varlistentry>
+<term>Compliance options</term>
+<listitem><para>
+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.
+<variablelist>
+
+<varlistentry>
+<term>--gnupg</term>
+<listitem><para>
+Use standard GnuPG behavior.  This is essentially OpenPGP behavior
+(see --openpgp), but 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.
+</para></listitem></varlistentry>
+
+<varlistentry>
+<term>--openpgp</term>
+<listitem><para>
+Reset all packet, cipher and digest options to strict OpenPGP
+behavior.  Use this option to reset all previous options like
+--rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
+--compress-algo to OpenPGP compliant values.  All PGP workarounds are
+disabled.
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--rfc1991</term>
 <listitem><para>
-Try to be more RFC1991 (PGP 2.x) compliant.
+Try to be more RFC-1991 (PGP 2.x) compliant.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1767,37 +1926,25 @@ a message that PGP 2.x will not be able to handle.  Note that `PGP
 2.x' here means `MIT PGP 2.6.2'.  There are other versions of PGP 2.x
 available, but the MIT release is a good common baseline.
 </para><para>
-This option implies `--rfc1991 --no-openpgp --disable-mdc
---no-force-v4-certs --no-comment --escape-from-lines --force-v3-sigs
+This option implies `--rfc1991 --disable-mdc --no-force-v4-certs
+--no-sk-comment --escape-from-lines --force-v3-sigs
 --no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
 --digest-algo MD5 --compress-algo 1'.  It also disables --textmode
 when encrypting.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>--no-pgp2</term>
-<listitem><para>
-Resets the --pgp2 option.
-</para></listitem></varlistentry>
-
-<varlistentry>
 <term>--pgp6</term>
 <listitem><para>
 Set up all options to be as PGP 6 compliant as possible.  This
 restricts you to the ciphers IDEA (if the IDEA plugin is installed),
 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the
-compression algorithms none and ZIP.  This also disables making
-signatures with signing subkeys as PGP 6 does not understand
-signatures made by signing subkeys.
+compression algorithms none and ZIP.  This also disables
+--throw-keyid, and making signatures with signing subkeys as PGP 6
+does not understand signatures made by signing subkeys.
 </para><para>
-This option implies `--disable-mdc --no-comment --escape-from-lines
---force-v3-sigs --no-ask-sig-expire --compress-algo 1'
-</para></listitem></varlistentry>
-
-<varlistentry>
-<term>--no-pgp6</term>
-<listitem><para>
-Resets the --pgp6 option.
+This option implies `--disable-mdc --no-sk-comment --escape-from-lines
+--force-v3-sigs --no-ask-sig-expire'
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1810,49 +1957,36 @@ TWOFISH.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>--no-pgp7</term>
+<term>--pgp8</term>
 <listitem><para>
-Resets the --pgp7 option.
-</para></listitem></varlistentry>
-
-<varlistentry>
-<term>--openpgp</term>
-<listitem><para>
-Reset all packet, cipher and digest options to OpenPGP behavior. Use
-this option to reset all previous options like --rfc1991,
---force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and
---compress-algo to OpenPGP compliant values.  All PGP workarounds are
-also disabled.
+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-keyid and set --escape-from-lines.
+The allowed algorithms list is the same as --pgp7 with the addition of
+the SHA-256 digest algorithm.
 </para></listitem></varlistentry>
 
+</variablelist></para></listitem></varlistentry>
 
 <varlistentry>
 <term>--force-v3-sigs</term>
+<term>--no-force-v3-sigs</term>
 <listitem><para>
 OpenPGP states that an implementation should generate v4 signatures
 but PGP versions 5 and higher only recognize v4 signatures on key
 material.  This option forces v3 signatures for signatures on data.
 Note that this option overrides --ask-sig-expire, as v3 signatures
-cannot have expiration dates.
-</para></listitem></varlistentry>
-
-<varlistentry>
-<term>--no-force-v3-sigs</term>
-<listitem><para>
-Reset the --force-v3-sigs option.
+cannot have expiration dates.  --no-force-v3-sigs disables this
+option.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--force-v4-certs</term>
+<term>--no-force-v4-certs</term>
 <listitem><para>
 Always use v4 key signatures even on v3 keys.  This option also
 changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
-</para></listitem></varlistentry>
-
-<varlistentry>
-<term>--no-force-v4-certs</term>
-<listitem><para>
-Reset the --force-v4-certs option.
+--no-force-v4-certs disables this option.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1860,8 +1994,8 @@ Reset the --force-v4-certs option.
 <listitem><para>
 Force the use of encryption with a modification detection code.  This
 is always used with the newer ciphers (those with a blocksize greater
-than 64 bits), or if the recipient key has one of those ciphers as a
-preference.
+than 64 bits), or if all of the recipient keys indicate MDC support in
+their feature flags.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1874,16 +2008,11 @@ message modification attack.
 
 <varlistentry>
 <term>--allow-non-selfsigned-uid</term>
+<term>--no-allow-non-selfsigned-uid</term>
 <listitem><para>
 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.
-</para></listitem></varlistentry>
-
-<varlistentry>
-<term>--no-allow-non-selfsigned-uid</term>
-<listitem><para>
-Reset the --allow-non-selfsigned-uid option.
+trivial to forge.  --no-allow-non-selfsigned-uid disables.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1894,23 +2023,24 @@ one.  This option should only be used in very special environments as
 it does not ensure the de-facto standard format of user IDs.
 </para></listitem></varlistentry>
 
-
 <varlistentry>
 <term>--ignore-time-conflict</term>
 <listitem><para>
 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.
+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 --ignore-valid-from for
+timestamp issues on subkeys.
 </para></listitem></varlistentry>
 
 <varlistentry>
 <term>--ignore-valid-from</term>
 <listitem><para>
-GnuPG normally does not select and use subkeys created in the future.  This
-option allows the use of such keys and thus exhibits the pre-1.0.7
-behaviour.  You should not use this option unless you there is some
-clock problem.
+GnuPG normally does not select and use subkeys created in the future.
+This option allows the use of such keys and thus exhibits the
+pre-1.0.7 behaviour.  You should not use this option unless you there
+is some clock problem.  See also --ignore-time-conflict for timestamp
+issues with signatures.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1941,7 +2071,6 @@ and do not release the lock until the process
 terminates.
 </para></listitem></varlistentry>
 
-
 <varlistentry>
 <term>--lock-multiple</term>
 <listitem><para>
@@ -1969,19 +2098,16 @@ are not desired.  This option can be used to achieve that with the cost of
 slower random generation.
 </para></listitem></varlistentry>
 
-
 <varlistentry>
 <term>--no-verbose</term>
 <listitem><para>
 Reset verbose level to 0.
 </para></listitem></varlistentry>
 
-
 <varlistentry>
 <term>--no-greeting</term>
 <listitem><para>
-Suppress the initial copyright message but do not
-enter batch mode.
+Suppress the initial copyright message.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -1993,7 +2119,18 @@ Suppress the warning about "using insecure memory".
 <varlistentry>
 <term>--no-permission-warning</term>
 <listitem><para>
-Suppress the warning about unsafe file permissions.
+
+Suppress the warning about unsafe file and home directory (--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.
+</para><para>
+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
+warnings about itself.  The --homedir permissions warning may only be
+supressed on the command line.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2030,8 +2167,12 @@ verification is not needed.
 <varlistentry>
 <term>--with-colons</term>
 <listitem><para>
-Print key listings delimited by colons.  Note, that the output will be
-encoded in UTF-8 regardless of any --charset setting.
+Print key listings delimited by colons.  Note that the output will be
+encoded in UTF-8 regardless of any --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 doc/DETAILS, which is included in the GnuPG source
+distribution.
 </para></listitem></varlistentry>
 
 
@@ -2061,8 +2202,8 @@ in future versions.
 <varlistentry>
 <term>--fixed-list-mode</term>
 <listitem><para>
-Do not merge user ID and primary key in --with-colon listing mode and
-print all timestamps as seconds since 1970-01-01.
+Do not merge primary user ID and primary key in --with-colon listing
+mode and print all timestamps as seconds since 1970-01-01.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2120,32 +2261,25 @@ handing out the secret key.
 
 <varlistentry>
 <term>--ask-sig-expire</term>
+<term>--no-ask-sig-expire</term>
 <listitem><para>
 When making a data signature, prompt for an expiration time.  If this
 option is not specified, the expiration time is "never".
-</para></listitem></varlistentry
-
-<varlistentry>
-<term>--no-ask-sig-expire</term>
-<listitem><para>
-Resets the --ask-sig-expire option.
-</para></listitem></varlistentry
+--no-ask-sig-expire disables this option.
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--ask-cert-expire</term>
+<term>--no-ask-cert-expire</term>
 <listitem><para>
 When making a key signature, prompt for an expiration time.  If this
 option is not specified, the expiration time is "never".
-</para></listitem></varlistentry
-
-<varlistentry>
-<term>--no-ask-cert-expire</term>
-<listitem><para>
-Resets the --ask-cert-expire option.
-</para></listitem></varlistentry
+--no-ask-cert-expire disables this option.
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--expert</term>
+<term>--no-expert</term>
 <listitem><para>
 Allow the user to do certain nonsensical or "silly" things like
 signing an expired or revoked key, or certain potentially incompatible
@@ -2153,14 +2287,8 @@ things like generating deprecated 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.
-</para></listitem></varlistentry
-
-<varlistentry>
-<term>--no-expert</term>
-<listitem><para>
-Resets the --expert option.
-</para></listitem></varlistentry
+off.  --no-expert disables this option.
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--merge-only</term>
@@ -2187,7 +2315,7 @@ handy in case where an encrypted message contains a bogus key ID.
 <term>--enable-special-filenames</term>
 <listitem><para>
 This options enables a mode in which filenames of the form
-<filename>-&#38;n</>, where n is a non-negative decimal number,
+<filename>-&#38;n</filename>, where n is a non-negative decimal number,
 refer to the file descriptor n and not to a file with that name.
 </para></listitem></varlistentry>
 
@@ -2201,13 +2329,16 @@ Experimental use only.
 <term>--group &ParmNameValues;</term>
 <listitem><para>
 Sets up a named group, which is similar to aliases in email programs.
-Any time the group name is a receipient (-r or --recipient), it will
+Any time the group name is a recipient (-r or --recipient), it will
 be expanded to the values specified.
-
+</para><para>
 The values are &ParmKeyIDs; 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.
+- 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.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2224,6 +2355,8 @@ Set the list of personal cipher preferences to &ParmString;, this list
 should be a string similar to the one printed by the command "pref" in
 the edit menu.  This allows the user to factor in their own preferred
 algorithms when algorithms are chosen via recipient key preferences.
+The most highly ranked cipher in this list is also used for the
+--symmetric encryption command.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2233,6 +2366,9 @@ Set the list of personal digest preferences to &ParmString;, this list
 should be a string similar to the one printed by the command "pref" in
 the edit menu.  This allows the user to factor in their own preferred
 algorithms when algorithms are chosen via recipient key preferences.
+The most highly ranked digest algorithm in this list is algo used when
+signing without encryption (e.g. --clearsign or --sign).  The default
+value is SHA-1.
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2242,7 +2378,8 @@ Set the list of personal compression preferences to &ParmString;, this
 list should be a string similar to the one printed by the command
 "pref" in the edit menu.  This allows the user to factor in their own
 preferred algorithms when algorithms are chosen via recipient key
-preferences.
+preferences.  The most highly ranked algorithm in this list is also
+used when there are no recipient keys to consider (e.g. --symmetric).
 </para></listitem></varlistentry>
 
 <varlistentry>
@@ -2262,8 +2399,8 @@ menu.
 <refsect1>
     <title>How to specify a user ID</title>
     <para>
-There are different ways on how to specify a user ID to GnuPG;
-here are some examples:
+There are different ways to specify a user ID to GnuPG; here are some
+examples:
     </para>
 
     <variablelist>
@@ -2520,6 +2657,41 @@ command line or using <literal>-</literal> to specify stdin.
 </para>
 </refsect1>
 
+<refsect1>
+    <title>INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS</title>
+<para>
+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 RIPEMD/160 hash, and the ZLIB
+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 --cipher-algo, --digest-algo,
+--cert-digest-algo, or --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.
+</para>
+
+<para>
+For example, as of this writing, no version of official PGP supports
+the BLOWFISH cipher algorithm.  If you use it, no PGP user will be
+able to decrypt your message.  The same thing applies to the ZLIB
+compression algorithm.  By default, GnuPG uses the 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 know what you are doing.
+</para>
+
+<para>
+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 --pgp2, --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.
+</para>
+
+</refsect1>
+
 
 <refsect1>
     <title>BUGS</title>
@@ -2534,4 +2706,3 @@ as locked memory is allocated.
 </refsect1>
 
 </refentry>
-