summaryrefslogtreecommitdiffstats
path: root/doc/gpg.texi
diff options
context:
space:
mode:
authorWerner Koch <wk@gnupg.org>2006-09-25 20:29:20 +0200
committerWerner Koch <wk@gnupg.org>2006-09-25 20:29:20 +0200
commitd94faf4a3d4daf6be1d732b226a4d6468dbf0f4f (patch)
tree5ac646af1bdfeb051ddd903a69f430bc18693171 /doc/gpg.texi
parentPreparing a new release (diff)
downloadgnupg2-d94faf4a3d4daf6be1d732b226a4d6468dbf0f4f.tar.xz
gnupg2-d94faf4a3d4daf6be1d732b226a4d6468dbf0f4f.zip
New "relax" option for trustlist.txt
Diffstat (limited to 'doc/gpg.texi')
-rw-r--r--doc/gpg.texi855
1 files changed, 446 insertions, 409 deletions
diff --git a/doc/gpg.texi b/doc/gpg.texi
index b7c05c394..07358711c 100644
--- a/doc/gpg.texi
+++ b/doc/gpg.texi
@@ -67,8 +67,8 @@ all bells and whistles you can expect from a decent OpenPGP
implementation.
@ifset gpgone
-This is the standa alone version of @command{gpg}. For desktop use you
-shoul consider using @command{gpg2}.
+This is the standalone version of @command{gpg}. For desktop use you
+should consider using @command{gpg2}.
@end ifset
@ifclear gpgone
@@ -123,7 +123,7 @@ a file containing keys is listed).
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 "--".
+using the special option @option{--}.
@menu
@@ -174,11 +174,11 @@ abbreviate this command.
@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
-together (for a signed message that may be decrypted via a secret key
-or a passphrase).
+Make a signature. This command may be combined with @option{--encrypt}
+(for a signed and encrypted message), @option{--symmetric} (for a signed
+and symmetrically encrypted message), or @option{--encrypt} and
+@option{--symmetric} together (for a signed message that may be
+decrypted via a secret key or a passphrase).
@item --clearsign
@opindex clearsign
@@ -196,22 +196,23 @@ Make a detached signature.
@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).
+Encrypt data. This option may be combined with @option{--sign} (for a
+signed and encrypted message), @option{--symmetric} (for a message that
+may be decrypted via a secret key or a passphrase), or @option{--sign}
+and @option{--symmetric} together (for a signed message that may be
+decrypted via a secret key or a passphrase).
@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
-signed and symmetrically encrypted message), --encrypt (for a message
-that may be decrypted via a secret key or a passphrase), or --sign and
---encrypt together (for a signed message that may be decrypted via a
-secret key or a passphrase).
+@option{--cipher-algo} option. This option may be combined with
+@option{--sign} (for a signed and symmetrically encrypted message),
+@option{--encrypt} (for a message that may be decrypted via a secret key
+or a passphrase), or @option{--sign} and @option{--encrypt} together
+(for a signed message that may be decrypted via a secret key or a
+passphrase).
@item --store
@opindex store
@@ -222,7 +223,7 @@ Store only (make a simple RFC1991 literal data packet).
@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
+@option{--output}). If the decrypted file is signed, the signature is also
verified. This command differs from the default operation, as it never
writes to the filename which is included in the file and it rejects
files which don't begin with an encrypted message.
@@ -245,31 +246,37 @@ from stdin without denoting it in the above way.
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.
+once. @option{--multifile} may currently be used along with
+@option{--verify}, @option{--encrypt}, and @option{--decrypt}. Note that
+@option{--multifile --verify} may not be used with detached signatures.
@item --verify-files
@opindex verify-files
-Identical to `--multifile --verify'.
+Identical to @option{--multifile --verify}.
@item --encrypt-files
@opindex encrypt-files
-Identical to `--multifile --encrypt'.
+Identical to @option{--multifile --encrypt}.
@item --decrypt-files
@opindex decrypt-files
-Identical to `--multifile --decrypt'.
+Identical to @option{--multifile --decrypt}.
@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
+List all keys from the public keyrings, or just the keys given on the
command line.
+@ifset gpgone
+@option{-k} is slightly different from @option{--list-keys} in that it
+allwos only for one argument and takes the second argument as the
+keyring to search. This is for command line compatibility with PGP 2
+and has been removed in @command{gpg2}.
+@end ifset
Avoid using the output of this command in scripts or other programs as
-it is likely to change as GnuPG changes. See --with-colons for a
+it is likely to change as GnuPG changes. See @option{--with-colons} for a
machine-parseable key listing command that is appropriate for use in
scripts and other programs.
@@ -279,34 +286,37 @@ scripts and other programs.
List all keys from the secret keyrings, or just the ones given on the
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).
+@option{--export-secret-subkeys}).
@item --list-sigs
@opindex list-sigs
-Same as --list-keys, but the signatures are listed too.
+Same as @option{--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").
+check level (see @option{--ask-cert-level}), "L" for a local or
+non-exportable signature (see @option{--lsign-key}), "R" for a
+nonRevocable signature (see the @option{--edit-key} command "nrsign"),
+"P" for a signature that contains a policy URL (see
+@option{--cert-policy-url}), "N" for a signature that contains a
+notation (see @option{--cert-notation}), "X" for an eXpired signature
+(see @option{--ask-cert-expire}), and the numbers 1-9 or "T" for 10 and
+above to indicate trust signature levels (see the @option{--edit-key}
+command "tsign").
@item --check-sigs
@opindex check-sigs
-Same as --list-sigs, but the signatures are verified.
+Same as @option{--list-sigs}, but the signatures are verified.
@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.
+fingerprints. This is the same output as @option{--list-keys} but with
+the additional output of a line with the fingerprint. May also be
+combined with @option{--list-sigs} or @option{--check-sigs}. If this
+command is given twice, the fingerprints of all secondary keys are
+listed too.
@item --list-packets
@opindex list-packets
@@ -329,11 +339,11 @@ Show the content of the smart card.
@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.
+@option{--card-edit} command.
@item --delete-key @code{name}
@opindex delete-key
-Remove key from the public keyring. In batch mode either --yes is
+Remove key from the public keyring. In batch mode either @option{--yes} is
required or the key must be specified by fingerprint. This is a
safeguard against accidental deletion of multiple keys.
@@ -344,35 +354,35 @@ 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.
+Same as @option{--delete-key}, but if a secret key exists, it will be
+removed first. In batch mode the key must be specified by fingerprint.
@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,
+registered via option @option{--keyring}), or if at least one name is given,
those of the given name. The new keyring is written to stdout or to the
-file given with option "output". Use together with --armor to mail those
-keys.
+file given with option @option{--output}. Use together with
+@option{--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.
+Same as @option{--export} but sends the keys to a keyserver. Option
+@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.
+Same as @option{--export}, but exports the secret keys instead. This is
+normally not very useful and a security risk. The second form of the
+command has the special property to render the secret part of the
+primary key useless; this is a GNU extension to OpenPGP and other
+implementations can not be expected to successfully import such a key.
+See the option @option{--simple-sk-checksum} if you want to import such
+an exported key with an older OpenPGP implementation.
@item --import
@itemx --fast-import
@@ -381,31 +391,31 @@ 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.
+Most notable here is the @option{--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.
+@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).
+signatures, user IDs, etc. Calling this with no arguments will refresh
+the entire keyring. Option @option{--keyserver} must be used to give the
+name of the keyserver for all keys that do not have preferred keyservers
+set (see @option{--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
+Search the keyserver for the given names. Multiple names given here will
+be joined together to create the search string for the keyserver.
+Option @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.
@@ -422,8 +432,8 @@ 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.
+value if it has not yet been assigned to a key. Using the
+@option{--edit-key} menu, the assigned value can be changed at any time.
@item --check-trustdb
@opindex check-trustdb
@@ -431,14 +441,15 @@ 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".
+automatically unless @option{--no-auto-check-trustdb} is set. This
+command can be used to force a trust database check at any time. The
+processing is identical to that of @option{--update-trustdb} but it
+skips keys with a not yet defined "ownertrust".
-For use with cron jobs, this command can be used together with --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.
+For use with cron jobs, this command can be used together with
+@option{--batch} in which case the trust database check is done only if
+a check is needed. To force a run even in batch mode add the option
+@option{--yes}.
@item --export-ownertrust
@opindex export-ownertrust
@@ -453,7 +464,7 @@ 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
+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.
@@ -475,6 +486,14 @@ may remove precious entropy from the system!
@opindex gen-prime
Use the source, Luke :-). The output format is still subject to change.
+
+@item --enarmor
+@item --dearmor
+@opindex enarmor
+@opindex --enarmor
+Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
+This is a GnuPG extension to OpenPGP and in general not very useful.
+
@end table
@@ -500,7 +519,7 @@ on how to use this.
@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.
+a subkey or a signature, use the @option{--edit} command.
@item --desig-revoke @code{name}
@opindex desig-revoke
@@ -701,28 +720,28 @@ preferred keyserver and signature notations (if any) are shown.
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
---default-preference-list), and calling setpref with "none" as the
-argument sets an empty preference list. Use "gpg --version" to get a
-list of available algorithms. Note that while you can change the
-preferences on an attribute user ID (aka "photo ID"), GnuPG does not
-select keys via attribute user IDs so these preferences will not be
-used by GnuPG.
+@option{--default-preference-list}), and calling setpref with "none" as
+the argument sets an empty preference list. Use @command{@gpgname
+--version} to get a list of available algorithms. Note that while you
+can change the preferences on an attribute user ID (aka "photo ID"),
+GnuPG does not select keys via attribute user IDs so these preferences
+will not be used by GnuPG.
@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-options honor-keyserver-url for more on how this works.
-Setting a value of "none" removes an existing preferred keyserver.
+@option{--keyserver-options honor-keyserver-url} for more on how this
+works. Setting a value of "none" removes an existing preferred
+keyserver.
@item notation
@opindex keyedit:notation
Set a name=value notation for the specified user ID(s). See
---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.
+@option{--cert-notation} for more on how this works. Setting a value of
+"none" removes all notations, setting a notation prefixed with a minus
+sign (-) removes that notation, and setting a notation name (without the
+=value) prefixed with a minus sign removes all notations with that name.
@item toggle
@opindex keyedit:toggle
@@ -747,7 +766,7 @@ each user ID except for the most recent self-signature.
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.
+@option{--require-cross-certification}.
@item save
@opindex keyedit:save
@@ -797,13 +816,13 @@ Ultimately trusted.
@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 @option{--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.
+from @option{--edit-key}.
@end table
@@ -840,7 +859,7 @@ every execution of gpg.
Please remember that option parsing stops as soon as a non-option is
encountered, you can explicitly stop parsing by using the special option
-@code{--}.
+@option{--}.
@c *******************************************
@c ******** CONFIGURATION OPTIONS **********
@@ -857,22 +876,23 @@ in the option file.
@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.
+Note that @option{-u} or @option{--local-user} overrides this option.
@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.
+Use @var{name} as default recipient if option @option{--recipient} is
+not used and don't ask if this is a valid one. @var{name} must be
+non-empty.
@item --default-recipient-self
@opindex default-recipient-self
-Use the default key as default recipient if option --recipient is not
+Use the default key as default recipient if option @option{--recipient} is not
used and don't ask if this is a valid one. The default key is the first
-one from the secret keyring or the one set with --default-key.
+one from the secret keyring or the one set with @option{--default-key}.
@item --no-default-recipient
@opindex no-default-recipient
-Reset --default-recipient and --default-recipient-self.
+Reset @option{--default-recipient} and @option{--default-recipient-self}.
@item -v, --verbose
@opindex verbose
@@ -890,23 +910,25 @@ Try to be as quiet as possible.
@item --list-options @code{parameters}
@opindex list-options
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, --list-secret-keys, and the --edit-key functions).
-Options can be prepended with a `no-' to give the opposite meaning.
-The options are:
+listing keys and signatures (that is, @option{--list-keys},
+@option{--list-sigs}, @option{--list-public-keys},
+@option{--list-secret-keys}, and the @option{--edit-key} functions).
+Options can be prepended with a @option{no-} (after the two dashes) to
+give the opposite meaning. The options are:
@table @asis
@item show-photos
@opindex list-options:show-photos
-Causes --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.
+Causes @option{--list-keys}, @option{--list-sigs},
+@option{--list-public-keys}, and @option{--list-secret-keys} to display
+any photo IDs attached to the key. Defaults to no. See also
+@option{--photo-viewer}.
@item show-policy-urls
@opindex list-options:show-policy-urls
-Show policy URLs in the --list-sigs or --check-sigs listings.
-Defaults to no.
+Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
+listings. Defaults to no.
@item show-notations
@itemx show-std-notations
@@ -915,12 +937,12 @@ Defaults to no.
@opindex list-options:show-std-notations
@opindex list-options:show-user-notations
Show all, IETF standard, or user-defined signature notations in the
---list-sigs or --check-sigs listings. Defaults to no.
+@option{--list-sigs} or @option{--check-sigs} listings. Defaults to no.
@item show-keyserver-urls
-Show any preferred keyserver URL in the --list-sigs or --check-sigs
-listings. Defaults to no.
+Show any preferred keyserver URL in the @option{--list-sigs} or
+@option{--check-sigs} listings. Defaults to no.
@item show-uid-validity
Display the calculated validity of user IDs during key listings.
@@ -937,15 +959,15 @@ Display the keyring name at the head of key listings to show which
keyring a given key resides on. Defaults to no.
@item show-sig-expire
-Show signature expiration dates (if any) during --list-sigs or
---check-sigs listings. Defaults to no.
+Show signature expiration dates (if any) during @option{--list-sigs} or
+@option{--check-sigs} listings. Defaults to no.
@item show-sig-subpackets
-Include signature subpackets in the key listing. This option can take
-an optional argument list of the subpackets to list. If no argument
-is passed, list all subpackets. Defaults to no. This option is only
-meaningful when using --with-colons along with --list-sigs or
---check-sigs.
+Include signature subpackets in the key listing. This option can take an
+optional argument list of the subpackets to list. If no argument is
+passed, list all subpackets. Defaults to no. This option is only
+meaningful when using @option{--with-colons} along with
+@option{--list-sigs} or @option{--check-sigs}.
@end table
@item --verify-options @code{parameters}
@@ -957,7 +979,7 @@ the opposite meaning. The options are:
@item show-photos
Display any photo IDs present on the key that issued the signature.
-Defaults to no. See also --photo-viewer.
+Defaults to no. See also @option{--photo-viewer}.
@item show-policy-urls
Show policy URLs in the signature being verified. Defaults to no.
@@ -1023,29 +1045,29 @@ keyserver helpers.
@item --keyring @code{file}
Add @code{file} to the current list of keyrings. If @code{file} begins
-with a tilde and a slash, these are replaced by the $HOME
-directory. If the filename does not contain a slash, it is assumed to
-be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
-is not used).
+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 @option{--homedir} or $GNUPGHOME is not
+used).
-Note that this adds a keyring to the current list. If the intent is
-to use the specified keyring alone, use --keyring along with
---no-default-keyring.
+Note that this adds a keyring to the current list. If the intent is to
+use the specified keyring alone, use @option{--keyring} along with
+@option{--no-default-keyring}.
@item --secret-keyring @code{file}
-Same as --keyring but for the secret keyrings.
+Same as @option{--keyring} but for the secret keyrings.
@item --primary-keyring @code{file}
Designate @code{file} as the primary public keyring. This means that
-newly imported keys (via --import or keyserver --recv-from) will go to
-this keyring.
+newly imported keys (via @option{--import} or keyserver
+@option{--recv-from}) will go to this keyring.
@item --trustdb-name @code{file}
Use @code{file} instead of the default trustdb. If @code{file} begins
-with a tilde and a slash, these are replaced by the $HOME
-directory. If the filename does not contain a slash, it is assumed to
-be in the GnuPG home directory ("~/.gnupg" if --homedir or $GNUPGHOME
-is not used).
+with a tilde and a slash, these are replaced by the $HOME directory. If
+the filename does not contain a slash, it is assumed to be in the GnuPG
+home directory (@file{~/.gnupg} if @option{--homedir} or $GNUPGHOME is
+not used).
@include opt-homedir.texi
@@ -1102,22 +1124,20 @@ that the OS uses native UTF-8 encoding.
@item --utf8-strings
@itemx --no-utf8-strings
Assume that command line arguments are given as UTF8 strings. The
-default (--no-utf8-strings) is to assume that arguments are encoded in
-the character set as specified by --display-charset. These options
-affect all following arguments. Both options may be used multiple
-times.
+default (@option{--no-utf8-strings}) is to assume that arguments are
+encoded in the character set as specified by
+@option{--display-charset}. These options affect all following
+arguments. Both options may be used multiple times.
@item --options @code{file}
-Read options from @code{file} and do not try to read
-them from the default options file in the homedir
-(see --homedir). This option is ignored if used
-in an options file.
+Read options from @code{file} and do not try to read them from the
+default options file in the homedir (see @option{--homedir}). This
+option is ignored if used in an options file.
@item --no-options
-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
-"~./gnupg" homedir.
+Shortcut for @option{--options /dev/null}. This option is detected
+before an attempt to open an option file. Using this option will also
+prevent the creation of a @file{~/.gnupg} homedir.
@@ -1125,20 +1145,19 @@ Using this option will also prevent the creation of a
@itemx --compress-level @code{n}
@itemx --bzip2-compress-level @code{n}
Set compression level to @code{n} for the ZIP and ZLIB compression
-algorithms. The default is to use the default compression level of
-zlib (normally 6). --bzip2-compress-level sets the compression level
-for the BZIP2 compression algorithm (defaulting to 6 as well). This
-is a different option from --compress-level since BZIP2 uses a
+algorithms. The default is to use the default compression level of zlib
+(normally 6). @option{--bzip2-compress-level} sets the compression level
+for the BZIP2 compression algorithm (defaulting to 6 as well). This is a
+different option from @option{--compress-level} since BZIP2 uses a
significant amount of memory for each additional compression level.
--z sets both. A value of 0 for @code{n} disables compression.
+@option{-z} sets both. A value of 0 for @code{n} disables compression.
@item --bzip2-decompress-lowmem
Use a different decompression method for BZIP2 compressed files. This
alternate method uses a bit more than half the memory, but also runs
at half the speed. This is useful under extreme low memory
circumstances when the file was originally compressed at a high
---bzip2-compress-level.
-
+@option{--bzip2-compress-level}.
@item --mangle-dos-filenames
@@ -1146,17 +1165,19 @@ circumstances when the file was originally compressed at a high
@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.
+dot. @option{--mangle-dos-filenames} causes GnuPG to replace (rather
+than add to) the extension of an output filename to avoid this
+problem. This option is off by default and has no effect on non-Windows
+platforms.
@item --ask-cert-level
@itemx --no-ask-cert-level
-When making a key signature, prompt for a certification level. If
-this option is not specified, the certification level used is set via
---default-cert-level. See --default-cert-level for information on the
-specific levels and how they are used. --no-ask-cert-level disables
-this option. This option defaults to no.
+When making a key signature, prompt for a certification level. If this
+option is not specified, the certification level used is set via
+@option{--default-cert-level}. See @option{--default-cert-level} for
+information on the specific levels and how they are
+used. @option{--no-ask-cert-level} disables this option. This option
+defaults to no.
@item --default-cert-level @code{n}
The default to use for the check level when signing a key.
@@ -1253,11 +1274,11 @@ 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.
+locate a key using whatever keyserver is defined using the
+@option{--keyserver} option.
@item (keyserver URL)
-In addition, a keyserver URL as used in the --keyserver option may be
+In addition, a keyserver URL as used in the @option{--keyserver} option may be
used here to query that particular keyserver.
@end table
@@ -1269,17 +1290,17 @@ beginning of the key ID, as in 0x99242560.
@item --keyserver @code{name}
Use @code{name} as your keyserver. This is the server that
---recv-keys, --send-keys, and --search-keys will communicate with to
-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 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.
+@option{--recv-keys}, @option{--send-keys}, and @option{--search-keys}
+will communicate with to receive keys from, send keys to, and search for
+keys on. The format of the @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 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 @option{--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
@@ -1289,25 +1310,25 @@ keyserver each time you use it.
@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
-well to apply to importing (--recv-key) or exporting (--send-key) a
-key from a keyserver. While not all options are available for all
-keyserver types, some common options are:
+meaning. Valid import-options or export-options may be used here as well
+to apply to importing (@option{--recv-key}) or exporting
+(@option{--send-key}) a key from a keyserver. While not all options are
+available for all keyserver types, some common options are:
@table @asis
@item include-revoked
-When searching for a key with --search-keys, include keys that are
-marked on the keyserver as revoked. Note that not all keyservers
+When searching for a key with @option{--search-keys}, include keys that
+are marked on the keyserver as revoked. Note that not all keyservers
differentiate between revoked and unrevoked keys, and for such
-keyservers this option is meaningless. Note also that most keyservers
-do not have cryptographic verification of key revocations, and so
-turning this option off may result in skipping keys that are
-incorrectly marked as revoked.
+keyservers this option is meaningless. Note also that most keyservers do
+not have cryptographic verification of key revocations, and so turning
+this option off may result in skipping keys that are incorrectly marked
+as revoked.
@item include-disabled
-When searching for a key with --search-keys, include keys that are
-marked on the keyserver as disabled. Note that this option is not
+When searching for a key with @option{--search-keys}, include keys that
+are marked on the keyserver as disabled. Note that this option is not
used with HKP keyservers.
@item auto-key-retrieve
@@ -1322,7 +1343,7 @@ 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
+When using @option{--refresh-keys}, if the key in question has a preferred
keyserver URL, then use that preferred keyserver to refresh the key
from. In addition, if auto-key-retrieve is set, and the signature
being verified has a preferred keyserver URL, then use that preferred
@@ -1357,9 +1378,9 @@ be repeated multiple times to increase the verbosity level.
Tell the keyserver helper program how long (in seconds) to try and
perform a keyserver action before giving up. Note that performing
multiple actions at the same time uses this timeout value per action.
-For example, when retrieving multiple keys via --recv-keys, the
+For example, when retrieving multiple keys via @option{--recv-keys}, the
timeout applies separately to each key retrieval, and not to the
---recv-keys command as a whole. Defaults to 30 seconds.
+@option{--recv-keys} command as a whole. Defaults to 30 seconds.
@item http-proxy
For HTTP-like keyserver schemes that (such as HKP and HTTP itself),
@@ -1414,9 +1435,9 @@ interaction, this performance penalty does not matter in most settings.
@item --auto-check-trustdb
@itemx --no-auto-check-trustdb
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.
+updated, it automatically runs the @option{--check-trustdb} command
+internally. This may be a time consuming
+process. @option{--no-auto-check-trustdb} disables this option.
@item --use-agent
@itemx --no-use-agent
@@ -1424,15 +1445,15 @@ disables this option.
This is dummy option. @command{@gpgname} always requires the agent.
@end ifclear
@ifset gpgone
-Try to use the GnuPG-Agent.
-With this option, GnuPG first tries to connect to the
-agent before it asks for a passphrase. --no-use-agent disables this
-option.
+Try to use the GnuPG-Agent. With this option, GnuPG first tries to
+connect to the agent before it asks for a
+passphrase. @option{--no-use-agent} disables this option.
@end ifset
@item --gpg-agent-info
Override the value of the environment variable
-@samp{GPG_AGENT_INFO}. This is only used when --use-agent has been given
+@samp{GPG_AGENT_INFO}. This is only used when @option{--use-agent} has
+been given
@item --lock-once
Lock the databases the first time a lock is requested
@@ -1441,7 +1462,7 @@ terminates.
@item --lock-multiple
Release the locks every time a lock is no longer
-needed. Use this to override a previous --lock-once
+needed. Use this to override a previous @option{--lock-once}
from a config file.
@item --lock-never
@@ -1453,12 +1474,12 @@ option may lead to data and key corruption.
@item --exit-on-status-write-error
This option will cause write errors on the status FD to immediately
-terminate the process. That should in fact be the default but it
-never worked this way and thus we need an option to enable this, so
-that the change won't break applications which close their end of a
-status fd connected pipe too early. Using this option along with
---enable-progress-filter may be used to cleanly cancel long running
-gpg operations.
+terminate the process. That should in fact be the default but it never
+worked this way and thus we need an option to enable this, so that the
+change won't break applications which close their end of a status fd
+connected pipe too early. Using this option along with
+@option{--enable-progress-filter} may be used to cleanly cancel long
+running gpg operations.
@item --limit-card-insert-tries @code{n}
With @code{n} greater than 0 the number of prompts asking to insert a
@@ -1481,16 +1502,16 @@ Suppress the initial copyright message.
Suppress the warning about "using insecure memory".
@item --no-permission-warning
-Suppress the warning about unsafe file and home directory (--homedir)
+Suppress the warning about unsafe file and home directory (@option{--homedir})
permissions. Note that the permission checks that GnuPG performs are
not intended to be authoritative, but rather they simply warn about
certain common permission problems. Do not assume that the lack of a
warning means that your system is secure.
-Note that the warning for unsafe --homedir permissions cannot be
+Note that the warning for unsafe @option{--homedir} permissions cannot be
suppressed in the gpg.conf file, as this would allow an attacker to
place an unsafe gpg.conf file in place, and use this file to suppress
-warnings about itself. The --homedir permissions warning may only be
+warnings about itself. The @option{--homedir} permissions warning may only be
suppressed on the command line.
@item --no-mdc-warning
@@ -1505,9 +1526,10 @@ Refuse to run if GnuPG cannot get secure memory. Defaults to no
@item --require-cross-certification
@itemx --no-require-cross-certification
When verifying a signature made from a subkey, ensure that the cross
-certification "back signature" on the subkey is present and valid.
-This protects against a subtle attack against subkeys that can sign.
-Defaults to --require-cross-certification for @command{@gpgname}.
+certification "back signature" on the subkey is present and valid. This
+protects against a subtle attack against subkeys that can sign.
+Defaults to @option{--require-cross-certification} for
+@command{@gpgname}.
@item --expert
@itemx --no-expert
@@ -1517,7 +1539,7 @@ things like generating unusual key types. This also disables certain
warning messages about potentially incompatible actions. As the name
implies, this option is for experts only. If you don't fully
understand the implications of what it allows you to do, leave this
-off. --no-expert disables this option.
+off. @option{--no-expert} disables this option.
@@ -1536,9 +1558,9 @@ off. --no-expert disables this option.
@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.
+Encrypt for user id @var{name}. If this option or
+@option{--hidden-recipient} is not specified, GnuPG asks for the user-id
+unless @option{--default-recipient} is given.
@item --hidden-recipient @var{name}
@itemx -R
@@ -1546,60 +1568,61 @@ given.
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.
+@option{--recipient} is not specified, GnuPG asks for the user ID unless
+@option{--default-recipient} is given.
@item --encrypt-to @code{name}
-Same as --recipient but this one is intended for use
-in the options file and may be used with
-your own user-id as an "encrypt-to-self". These keys
-are only used when there are other recipients given
-either by use of --recipient or by the asked user id.
-No trust checking is performed for these user ids and
-even disabled keys can be used.
+Same as @option{--recipient} but this one is intended for use in the
+options file and may be used with your own user-id as an
+"encrypt-to-self". These keys are only used when there are other
+recipients given either by use of @option{--recipient} or by the asked
+user id. No trust checking is performed for these user ids and even
+disabled keys can be used.
@item --hidden-encrypt-to @code{name}
-Same as --hidden-recipient but this one is intended for use in the
+Same as @option{--hidden-recipient} but this one is intended for use in the
options file and may be used with your own user-id as a hidden
"encrypt-to-self". These keys are only used when there are other
-recipients given either by use of --recipient or by the asked user id.
+recipients given either by use of @option{--recipient} or by the asked user id.
No trust checking is performed for these user ids and even disabled
keys can be used.
@item --no-encrypt-to
-Disable the use of all --encrypt-to and --hidden-encrypt-to keys.
+Disable the use of all @option{--encrypt-to} and
+@option{--hidden-encrypt-to} keys.
@item --group @code{name=value1 }
Sets up a named group, which is similar to aliases in email programs.
-Any time the group name is a recipient (-r or --recipient), it will be
-expanded to the values specified. Multiple groups with the same name
-are automatically merged into a single group.
+Any time the group name is a recipient (@option{-r} or
+@option{--recipient}), it will be expanded to the values
+specified. Multiple groups with the same name are automatically merged
+into a single group.
The values are @code{key IDs} or fingerprints, but any key description
is accepted. Note that a value with spaces in it will be treated as
two different values. Note also there is only one level of expansion
-- you cannot make an group that points to another group. When used
+--- you cannot make an group that points to another group. When used
from the command line, it may be necessary to quote the argument to
this option to prevent the shell from treating it as multiple
arguments.
@item --ungroup @code{name}
-Remove a given entry from the --group list.
+Remove a given entry from the @option{--group} list.
@item --no-groups
-Remove all entries from the --group list.
+Remove all entries from the @option{--group} list.
@item --local-user @var{name}
@itemx -u
@opindex local-user
Use @var{name} as the key to sign with. Note that this option overrides
---default-key.
+@option{--default-key}.
@item --try-all-secrets
Don't look at the key ID as stored in the message but try all secret
keys in turn to find the right decryption key. This option forces the
behaviour as used by anonymous recipients (created by using
---throw-keyids) and might come handy in case where an encrypted
+@option{--throw-keyids}) and might come handy in case where an encrypted
message contains a bogus key ID.
@@ -1653,12 +1676,12 @@ generally useful unless a shared keyring scheme is being used.
Defaults to no.
@item repair-pks-subkey-bug
-During import, attempt to repair the damage caused by the PKS
-keyserver bug (pre version 0.9.6) that mangles keys with multiple
-subkeys. Note that this cannot completely repair the damaged key as
-some crucial data is removed by the keyserver, but it does at least
-give you back one subkey. Defaults to no for regular --import and to
-yes for keyserver --recv-keys.
+During import, attempt to repair the damage caused by the PKS keyserver
+bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note
+that this cannot completely repair the damaged key as some crucial data
+is removed by the keyserver, but it does at least give you back one
+subkey. Defaults to no for regular @option{--import} and to yes for
+keyserver @option{--recv-keys}.
@item merge-only
During import, allow key updates to existing keys, but do not allow
@@ -1669,13 +1692,13 @@ 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
+on the keyring. This option is the same as running the @option{--edit-key}
command "clean" after import. Defaults to no.
@item import-minimal
Import the smallest key possible. This removes all signatures except
the most recent self-signature on each user ID. This option is the
-same as running the --edit-key command "minimize" after import.
+same as running the @option{--edit-key} command "minimize" after import.
Defaults to no.
@end table
@@ -1701,7 +1724,7 @@ Include designated revoker information that was marked as
"sensitive". Defaults to no.
@item export-reset-subkey-passwd
-When using the "--export-secret-subkeys" command, this option resets
+When using the @option{--export-secret-subkeys} command, this option resets
the passphrases for all exported subkeys to empty. This is useful
when the exported subkey is to be used on an unattended machine where
a passphrase doesn't necessarily make sense. Defaults to no.
@@ -1711,21 +1734,21 @@ 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
+the same as running the @option{--edit-key} command "clean" before export
except that the local copy of the key is not modified. Defaults to
no.
@item export-minimal
-Export the smallest key possible. This removes all signatures except
-the most recent self-signature on each user ID. This option is the
-same as running the --edit-key command "minimize" before export except
+Export the smallest key possible. This removes all signatures except the
+most recent self-signature on each user ID. This option is the same as
+running the @option{--edit-key} command "minimize" before export except
that the local copy of the key is not modified. Defaults to no.
@end table
@item --with-colons
@opindex with-colons
Print key listings delimited by colons. Note that the output will be
-encoded in UTF-8 regardless of any --display-charset setting. This
+encoded in UTF-8 regardless of any @option{--display-charset} setting. This
format is useful when GnuPG is called from scripts and other programs
as it is easily machine parsed. The details of this format are
documented in the file @file{doc/DETAILS}, which is included in the GnuPG
@@ -1733,13 +1756,13 @@ source distribution.
@item --fixed-list-mode
@opindex fixed-list-mode
-Do not merge primary 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 @option{--with-colon}
+listing mode and print all timestamps as seconds since 1970-01-01.
@item --with-fingerprint
@opindex with-fingerprint
-Same as the command --fingerprint but changes only the format of the output
-and may be used together with another command.
+Same as the command @option{--fingerprint} but changes only the format
+of the output and may be used together with another command.
@end table
@@ -1756,19 +1779,20 @@ and may be used together with another command.
@itemx --no-textmode
Treat input files as text and store them in the OpenPGP canonical text
form with standard "CRLF" line endings. This also sets the necessary
-flags to inform the recipient that the encrypted or signed data is
-text and may need its line endings converted back to whatever the
-local system uses. This option is useful when communicating between
-two platforms that have different line ending conventions (UNIX-like
-to Mac, Mac to Windows, etc). --no-textmode disables this option, and
+flags to inform the recipient that the encrypted or signed data is text
+and may need its line endings converted back to whatever the local
+system uses. This option is useful when communicating between two
+platforms that have different line ending conventions (UNIX-like to Mac,
+Mac to Windows, etc). @option{--no-textmode} disables this option, and
is the default.
-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.
-
+@ifset gpgone
+If @option{-t} (but not @option{--textmode}) is used together with
+armoring and signing, this enables clearsigned messages. This kludge is
+needed for command-line compatibility with command-line versions of PGP;
+normally you would use @option{--sign} or @option{--clearsign} to select
+the type of the signature.
+@end ifset
@@ -1777,15 +1801,15 @@ signature.
OpenPGP states that an implementation should generate v4 signatures
but PGP versions 5 through 7 only recognize v4 signatures on key
material. This option forces v3 signatures for signatures on data.
-Note that this option overrides --ask-sig-expire, as v3 signatures
-cannot have expiration dates. --no-force-v3-sigs disables this
+Note that this option overrides @option{--ask-sig-expire}, as v3 signatures
+cannot have expiration dates. @option{--no-force-v3-sigs} disables this
option.
@item --force-v4-certs
@itemx --no-force-v4-certs
Always use v4 key signatures even on v3 keys. This option also
changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1.
---no-force-v4-certs disables this option.
+@option{--no-force-v4-certs} disables this option.
@item --force-mdc
Force the use of encryption with a modification detection code. This
@@ -1804,7 +1828,7 @@ 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.
+@option{--symmetric} encryption command.
@item --personal-digest-preferences @code{string}
Set the list of personal digest preferences to @code{string}, this list
@@ -1812,8 +1836,8 @@ 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.
+signing without encryption (e.g. @option{--clearsign} or
+@option{--sign}). The default value is SHA-1.
@item --personal-compress-preferences @code{string}
Set the list of personal compression preferences to @code{string}, this
@@ -1821,15 +1845,15 @@ 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 algorithm in this list is also
-used when there are no recipient keys to consider (e.g. --symmetric).
+used when there are no recipient keys to consider (e.g. @option{--symmetric}).
@item --s2k-cipher-algo @code{name}
Use @code{name} as the cipher algorithm used to protect secret keys.
The default cipher is CAST5. This cipher is also used for
-conventional encryption if --personal-cipher-preferences and
---cipher-algo is not given.
+conventional encryption if @option{--personal-cipher-preferences} and
+@option{--cipher-algo} is not given.
@item --s2k-digest-algo @code{name}
Use @code{name} as the digest algorithm used to mangle the passphrases.
@@ -1839,7 +1863,7 @@ The default algorithm is SHA-1.
Selects how passphrases are mangled. If @code{n} is 0 a plain
passphrase (which is not recommended) will be used, a 1 adds a salt to
the passphrase and a 3 (the default) iterates the whole process a
-couple of times. Unless --rfc1991 is used, this mode is also used for
+couple of times. Unless @option{--rfc1991} is used, this mode is also used for
conventional encryption.
@@ -1862,7 +1886,7 @@ options.
@item --gnupg
@opindex gnupg
Use standard GnuPG behavior. This is essentially OpenPGP behavior
-(see --openpgp), but with some additional workarounds for common
+(see @option{--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.
@@ -1871,14 +1895,15 @@ override a different compliance option in the gpg.conf file.
@opindex openpgp
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.
+@option{--rfc1991}, @option{--force-v3-sigs}, @option{--s2k-*},
+@option{--cipher-algo}, @option{--digest-algo} and
+@option{--compress-algo} to OpenPGP compliant values. All PGP
+workarounds are disabled.
@item --rfc2440
-opindex rfc2440
+@opindex rfc2440
Reset all packet, cipher and digest options to strict RFC-2440
-behavior. Note that this is currently the same thing as --openpgp.
+behavior. Note that this is currently the same thing as @option{--openpgp}.
@item --rfc1991
@opindex rfc1991
@@ -1892,11 +1917,11 @@ a message that PGP 2.x will not be able to handle. Note that `PGP
2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x
available, but the MIT release is a good common baseline.
-This option implies `--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.
+This option implies @option{--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 @option{--textmode} when
+encrypting.
@item --pgp6
@opindex pgp6
@@ -1907,23 +1932,23 @@ compression algorithms none and ZIP. This also disables
--throw-keyids, and making signatures with signing subkeys as PGP 6
does not understand signatures made by signing subkeys.
-This option implies `--disable-mdc --no-sk-comment --escape-from-lines
---force-v3-sigs --no-ask-sig-expire'
+This option implies @option{--disable-mdc --no-sk-comment
+--escape-from-lines --force-v3-sigs --no-ask-sig-expire}.
@item --pgp7
@opindex pgp7
Set up all options to be as PGP 7 compliant as possible. This is
-identical to --pgp6 except that MDCs are not disabled, and the list of
-allowable ciphers is expanded to add AES128, AES192, AES256, and
+identical to @option{--pgp6} except that MDCs are not disabled, and the
+list of allowable ciphers is expanded to add AES128, AES192, AES256, and
TWOFISH.
@item --pgp8
@opindex pgp8
-Set up all options to be as PGP 8 compliant as possible. PGP 8 is a
-lot closer to the OpenPGP standard than previous versions of PGP, so
-all this does is disable --throw-keyids and set --escape-from-lines.
-All algorithms are allowed except for the SHA224, SHA384, and SHA512
-digests.
+Set up all options to be as PGP 8 compliant as possible. PGP 8 is a lot
+closer to the OpenPGP standard than previous versions of PGP, so all
+this does is disable @option{--throw-keyids} and set
+@option{--escape-from-lines}. All algorithms are allowed except for the
+SHA224, SHA384, and SHA512 digests.
@end table
@@ -1942,7 +1967,7 @@ digests.
Don't make any changes (this is not completely implemented).
@item --list-only
-Changes the behaviour of some commands. This is like --dry-run but
+Changes the behaviour of some commands. This is like @option{--dry-run} but
different in some cases. The semantic of this command may be extended in
the future. Currently it only skips the actual decryption pass and
therefore enables a fast listing of the encryption keys.
@@ -1960,9 +1985,11 @@ be given in C syntax (e.g. 0x0042).
@item --debug-all
Set all useful debugging flags.
+@ifset gpgone
@item --debug-ccid-driver
Enable debug output from the included CCID driver for smartcards.
Note that this option is only available on some system.
+@end ifset
@item --enable-progress-filter
Enable certain PROGRESS status outputs. This option allows frontends
@@ -1974,41 +2001,41 @@ Write special status strings to the file descriptor @code{n}.
See the file DETAILS in the documentation for a listing of them.
@item --status-file @code{file}
-Same as --status-fd, except the status data is written to file
+Same as @option{--status-fd}, except the status data is written to file
@code{file}.
@item --logger-fd @code{n}
Write log output to file descriptor @code{n} and not to stderr.
@item --logger-file @code{file}
-Same as --logger-fd, except the logger data is written to file
+Same as @option{--logger-fd}, except the logger data is written to file
@code{file}.
@item --attribute-fd @code{n}
-Write attribute subpackets to the file descriptor @code{n}. This is
-most useful for use with --status-fd, since the status messages are
-needed to separate out the various subpackets from the stream
-delivered to the file descriptor.
+Write attribute subpackets to the file descriptor @code{n}. This is most
+useful for use with @option{--status-fd}, since the status messages are
+needed to separate out the various subpackets from the stream delivered
+to the file descriptor.
@item --attribute-file @code{file}
-Same as --attribute-fd, except the attribute data is written to file
-@code{file}.
+Same as @option{--attribute-fd}, except the attribute data is written to
+file @code{file}.
@item --comment @code{string}
@itemx --no-comments
-Use @code{string} as a comment string in clear text signatures and
-ASCII armored messages or keys (see --armor). The default behavior is
-not to use a comment string. --comment may be repeated multiple times
-to get multiple comment strings. --no-comments removes all comments.
-It is a good idea to keep the length of a single comment below 60
-characters to avoid problems with mail programs wrapping such lines.
-Note that comment lines, like all other header lines, are not
+Use @code{string} as a comment string in clear text signatures and ASCII
+armored messages or keys (see @option{--armor}). The default behavior is
+not to use a comment string. @option{--comment} may be repeated multiple
+times to get multiple comment strings. @option{--no-comments} removes
+all comments. It is a good idea to keep the length of a single comment
+below 60 characters to avoid problems with mail programs wrapping such
+lines. Note that comment lines, like all other header lines, are not
protected by the signature.
@item --emit-version
@itemx --no-emit-version
Force inclusion of the version string in ASCII armored output.
---no-emit-version disables this option.
+@option{--no-emit-version} disables this option.
@item --sig-notation @code{name=value}
@itemx --cert-notation @code{name=value}
@@ -2016,15 +2043,16 @@ Force inclusion of the version string in ASCII armored output.
Put the name value pair into the signature as notation data.
@code{name} must consist only of printable characters or spaces, and
must contain a '@@' character in the form keyname@@domain.example.com
-(substituting the appropriate keyname and domain name, of course).
-This is to help prevent pollution of the IETF reserved notation
-namespace. The --expert flag overrides the '@@' check. @code{value}
-may be any printable string; it will be encoded in UTF8, so you should
-check that your --display-charset is set correctly. If you prefix
-@code{name} with an exclamation mark (!), the notation data will be
-flagged as critical (rfc2440:5.2.3.15). --sig-notation sets a
-notation for data signatures. --cert-notation sets a notation for key
-signatures (certifications). --set-notation sets both.
+(substituting the appropriate keyname and domain name, of course). This
+is to help prevent pollution of the IETF reserved notation
+namespace. The @option{--expert} flag overrides the '@@'
+check. @code{value} may be any printable string; it will be encoded in
+UTF8, so you should check that your @option{--display-charset} is set
+correctly. If you prefix @code{name} with an exclamation mark (!), the
+notation data will be flagged as critical
+(rfc2440:5.2.3.15). @option{--sig-notation} sets a notation for data
+signatures. @option{--cert-notation} sets a notation for key signatures
+(certifications). @option{--set-notation} sets both.
There are special codes that may be used in notation names. "%k" will
be expanded into the key ID of the key being signed, "%K" into the
@@ -2041,11 +2069,11 @@ meaningful when using the OpenPGP smartcard.
@item --sig-policy-url @code{string}
@itemx --cert-policy-url @code{string}
@itemx --set-policy-url @code{string}
-Use @code{string} as a Policy URL for signatures (rfc2440:5.2.3.19).
-If you prefix it with an exclamation mark (!), the policy URL packet
-will be flagged as critical. --sig-policy-url sets a policy url for
-data signatures. --cert-policy-url sets a policy url for key
-signatures (certifications). --set-policy-url sets both.
+Use @code{string} as a 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. @option{--sig-policy-url} sets a policy url for
+data signatures. @option{--cert-policy-url} sets a policy url for key
+signatures (certifications). @option{--set-policy-url} sets both.
The same %-expandos used for notation data are available here as well.
@@ -2064,10 +2092,10 @@ file being encrypted.
@item --for-your-eyes-only
@itemx --no-for-your-eyes-only
Set the `for your eyes only' flag in the message. This causes GnuPG
-to refuse to save the file unless the --output option is given, and
+to refuse to save the file unless the @option{--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.
---no-for-your-eyes-only disables this option.
+display the message. This option overrides @option{--set-filename}.
+@option{--no-for-your-eyes-only} disables this option.
@item --use-embedded-filename
@itemx --no-use-embedded-filename
@@ -2076,18 +2104,18 @@ a dangerous option as it allows to overwrite files. Defaults to no.
@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. 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.
+command @option{--version} yields a list of supported algorithms. If
+this is not used the cipher algorithm is selected from the preferences
+stored with the key. In general, you do not want to use this option as
+it allows you to violate the OpenPGP standard.
+@option{--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. In
+with the command @option{--version} yields a list of supported algorithms. In
general, you do not want to use this option as it allows you to
-violate the OpenPGP standard. --personal-digest-preferences is the
+violate the OpenPGP standard. @option{--personal-digest-preferences} is the
safe way to accomplish the same thing.
@item --compress-algo @code{name}
@@ -2109,14 +2137,14 @@ significant in low memory situations. Note, however, that PGP (all
versions) only supports ZIP compression. Using any algorithm other
than ZIP or "none" will make the message unreadable with PGP. In
general, you do not want to use this option as it allows you to
-violate the OpenPGP standard. --personal-compress-preferences is the
+violate the OpenPGP standard. @option{--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
-key. Running the program with the command --version yields a list of
-supported algorithms. Be aware that if you choose an algorithm that
-GnuPG supports but other OpenPGP implementations do not, then some
+key. Running the program with the command @option{--version} yields a
+list of supported algorithms. Be aware that if you choose an algorithm
+that GnuPG supports but other OpenPGP implementations do not, then some
users will not be able to use the key signatures you make, or quite
possibly your entire key.
@@ -2136,8 +2164,8 @@ Do not put the recipient key IDs into encrypted messages. This helps
to hide the receivers of the message and is a limited countermeasure
against traffic analysis. On the receiving side, it may slow down the
decryption process because all available secret keys must be tried.
---no-throw-keyids disables this option. This option is essentially
-the same as using --hidden-recipient for all recipients.
+@option{--no-throw-keyids} disables this option. This option is essentially
+the same as using @option{--hidden-recipient} for all recipients.
@item --not-dash-escaped
This option changes the behavior of cleartext signatures
@@ -2150,11 +2178,11 @@ line tells GnuPG about this cleartext signature option.
@item --escape-from-lines
@itemx --no-escape-from-lines
-Because some mailers change lines starting with "From " to ">From
-" it is good to handle such lines in a special way when creating
-cleartext signatures to prevent the mail system from breaking the
-signature. Note that all other PGP versions do it this way too.
-Enabled by default. --no-escape-from-lines disables this option.
+Because some mailers change lines starting with "From " to ">From " it
+is good to handle such lines in a special way when creating cleartext
+signatures to prevent the mail system from breaking the signature. Note
+that all other PGP versions do it this way too. Enabled by
+default. @option{--no-escape-from-lines} disables this option.
@item --passphrase-fd @code{n}
Read the passphrase from file descriptor @code{n}. Only the first line
@@ -2179,18 +2207,18 @@ avoid it.
This is a replacement for the deprecated shared-memory IPC mode.
If this option is enabled, user input on questions is not expected
from the TTY but from the given file descriptor. It should be used
-together with --status-fd. See the file doc/DETAILS in the source
+together with @option{--status-fd}. See the file doc/DETAILS in the source
distribution for details on how to use it.
@item --command-file @code{file}
-Same as --command-fd, except the commands are read out of file
+Same as @option{--command-fd}, except the commands are read out of file
@code{file}
@item --allow-non-selfsigned-uid
@itemx --no-allow-non-selfsigned-uid
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. --no-allow-non-selfsigned-uid disables.
+trivial to forge. @option{--no-allow-non-selfsigned-uid} disables.
@item --allow-freeform-uid
Disable all checks on the form of the user ID while generating a new
@@ -2201,14 +2229,14 @@ it does not ensure the de-facto standard format of user IDs.
GnuPG normally checks that the timestamps associated with keys and
signatures have plausible values. However, sometimes a signature
seems to be older than the key due to clock problems. This option
-makes these checks just a warning. See also --ignore-valid-from for
+makes these checks just a warning. See also @option{--ignore-valid-from} for
timestamp issues on subkeys.
@item --ignore-valid-from
GnuPG normally does not select and use subkeys created in the future.
This option allows the use of such keys and thus exhibits the
pre-1.0.7 behaviour. You should not use this option unless you there
-is some clock problem. See also --ignore-time-conflict for timestamp
+is some clock problem. See also @option{--ignore-time-conflict} for timestamp
issues with signatures.
@item --ignore-crc-error
@@ -2228,8 +2256,8 @@ message was tampered with intentionally by an attacker.
@item --no-default-keyring
Do not add the default keyrings to the list of keyrings. Note that
GnuPG will not operate without any keyrings, so if you use this option
-and do not provide alternate keyrings via --keyring or
---secret-keyring, then GnuPG will still use the default public or
+and do not provide alternate keyrings via @option{--keyring} or
+@option{--secret-keyring}, then GnuPG will still use the default public or
secret keyrings.
@item --skip-verify
@@ -2238,7 +2266,8 @@ used to make the decryption faster if the signature
verification is not needed.
@item --with-key-data
-Print key listings delimited by colons (like --with-colons) and print the public key data.
+Print key listings delimited by colons (like @option{--with-colons}) and
+print the public key data.
@item --fast-list-mode
Changes the output of the list commands to work faster; this is achieved
@@ -2254,8 +2283,8 @@ This is not for normal use. Use the source to see for what it might be useful.
This is not for normal use. Use the source to see for what it might be useful.
@item --show-session-key
-Display the session key used for one message. See --override-session-key
-for the counterpart of this option.
+Display the session key used for one message. See
+@option{--override-session-key} for the counterpart of this option.
We think that Key Escrow is a Bad Thing; however the user should have
the freedom to decide whether to go to prison or to reveal the content
@@ -2264,20 +2293,22 @@ encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY
FORCED TO DO SO.
@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.
+Don't use the public key but the session key @code{string}. The format
+of this string is the same as the one printed by
+@option{--show-session-key}. This option is normally not used but comes
+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 --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. 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.
+@option{--default-sig-expire} is used. @option{--no-ask-sig-expire}
+disables this option. Note that by default, @option{--force-v3-sigs} is
+set which also disables this option. If you want signature expiration,
+you must set @option{--no-force-v3-sigs} as well as turning
+@option{--ask-sig-expire} on.
@item --default-sig-expire
The default expiration time to use for signature expiration. Valid
@@ -2290,8 +2321,8 @@ date in the form YYYY-MM-DD. Defaults to "0".
@itemx --no-ask-cert-expire
When making a key signature, prompt for an expiration time. If this
option is not specified, the expiration time set via
---default-cert-expire is used. --no-ask-cert-expire disables this
-option.
+@option{--default-cert-expire} is used. @option{--no-ask-cert-expire}
+disables this option.
@item --default-cert-expire
The default expiration time to use for key signature expiration.
@@ -2335,12 +2366,12 @@ 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.
+Display various internal configuration parameters of GnuPG. This option
+is intended for external programs that call GnuPG to perform tasks, and
+is thus not generally useful. See the file @file{doc/DETAILS} in the
+source distribution for the details of which configuration items may be
+listed. @option{--list-config} is only usable with
+@option{--with-colons} set.
@end table
@@ -2351,24 +2382,27 @@ only usable with --with-colons set.
@table @gnupgtabopt
+@ifset gpgone
@item --load-extension @code{name}
Load an extension module. If @code{name} does not contain a slash it is
searched for in the directory configured when GnuPG was built
(generally "/usr/local/lib/gnupg"). Extensions are not generally
useful anymore, and the use of this option is deprecated.
+@end ifset
@item --show-photos
@itemx --no-show-photos
-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.
+Causes @option{--list-keys}, @option{--list-sigs},
+@option{--list-public-keys}, @option{--list-secret-keys}, and verifying
+a signature to also display the photo ID attached to the key, if
+any. See also @option{--photo-viewer}. These options are deprecated. Use
+@option{--list-options [no-]show-photos} and/or @option{--verify-options
+[no-]show-photos} instead.
@item --show-keyring
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.
+@option{--list-options [no-]show-keyring} instead.
@item --ctapi-driver @code{file}
Use @code{file} to access the smartcard reader. The current default
@@ -2376,21 +2410,22 @@ is `libtowitoko.so'. Note that the use of this interface is
deprecated; it may be removed in future releases.
@item --always-trust
-Identical to `--trust-model always'. This option is deprecated.
+Identical to @option{--trust-model always}. This option is deprecated.
@item --show-notation
@itemx --no-show-notation
-Show signature notations in the --list-sigs or --check-sigs listings
+Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings
as well as when verifying a signature with a notation in it. These
-options are deprecated. Use `--list-options [no-]show-notation'
-and/or `--verify-options [no-]show-notation' instead.
+options are deprecated. Use @option{--list-options [no-]show-notation}
+and/or @option{--verify-options [no-]show-notation} instead.
@item --show-policy-url
@itemx --no-show-policy-url
-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.
+Show policy URLs in the @option{--list-sigs} or @option{--check-sigs}
+listings as well as when verifying a signature with a policy URL in
+it. These options are deprecated. Use @option{--list-options
+[no-]show-policy-url} and/or @option{--verify-options
+[no-]show-policy-url} instead.
@end table
@@ -2474,13 +2509,15 @@ Used to locate the default home directory.
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.
+Used to locate the gpg-agent.
+@ifset gpgone
+This is only honored when @option{--use-agent} is set.
+@end ifset
+The value consists of 3 colon delimited fields: The first is the path
+to the Unix Domain Socket, the second the PID of the gpg-agent and the
+protocol version which should be set to 1. When starting the gpg-agent
+as described in its documentation, this variable is set to the correct
+value. The option @option{--gpg-agent-info} can be used to override it.
@item COLUMNS
@itemx LINES
@@ -2567,8 +2604,8 @@ standard. In particular, GnuPG implements many of the optional parts
of the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
compression algorithms. It is important to be aware that not all
OpenPGP programs implement these optional algorithms and that by
-forcing their use via the --cipher-algo, --digest-algo,
---cert-digest-algo, or --compress-algo options in GnuPG, it is
+forcing their use via the @option{--cipher-algo}, @option{--digest-algo},
+@option{--cert-digest-algo}, or @option{--compress-algo} options in GnuPG, it is
possible to create a perfectly valid OpenPGP message, but one that
cannot be read by the intended recipient.
@@ -2582,12 +2619,12 @@ create messages that are usable by all recipients, regardless of which
OpenPGP program they use. Only override this safe default if you
really know what you are doing.
-If you absolutely must override the safe default, or if the
-preferences on a given key are invalid for some reason, you are far
-better off using the --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.
+If you absolutely must override the safe default, or if the preferences
+on a given key are invalid for some reason, you are far better off using
+the @option{--pgp6}, @option{--pgp7}, or @option{--pgp8} options. These
+options are safe as they do not force any particular algorithms in
+violation of OpenPGP, but rather reduce the available algorithms to a
+"PGP-safe" list.
@mansect bugs
@chapheading BUGS