diff --git a/doc/ChangeLog b/doc/ChangeLog index 2be7a3bca..17c58ecd4 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,5 +1,7 @@ 2011-10-12 Werner Koch + * gpg.texi: Add a bunch of opindex items. + * yat2m.c (parse_file): Add hack to allow table indentation. 2011-08-12 Werner Koch diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi index b212153e3..4c7f13f33 100644 --- a/doc/gpg-agent.texi +++ b/doc/gpg-agent.texi @@ -204,7 +204,6 @@ below the home directory of the user. @item -v @item --verbose -@opindex v @opindex verbose Outputs additional information while running. You can increase the verbosity by giving several @@ -212,7 +211,6 @@ verbose commands to @command{gpgsm}, such as @samp{-vv}. @item -q @item --quiet -@opindex q @opindex quiet Try to be as quiet as possible. @@ -300,9 +298,7 @@ debugging. @itemx --sh @itemx -c @itemx --csh -@opindex s @opindex sh -@opindex c @opindex csh Format the info output in daemon mode for use with the standard Bourne shell or the C-shell respectively. The default is to guess it based on diff --git a/doc/gpg.texi b/doc/gpg.texi index 1112fa21a..715b599ec 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -551,7 +551,7 @@ Use the source, Luke :-). The output format is still subject to change. @item --enarmor @item --dearmor @opindex enarmor -@opindex --enarmor +@opindex dearmor Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor. This is a GnuPG extension to OpenPGP and in general not very useful. @@ -598,42 +598,42 @@ line. @c ******** Begin Edit-key Options ********** @table @asis -@item uid @code{n} -@opindex keyedit:uid -Toggle selection of user ID or photographic user ID with index @code{n}. -Use @code{*} to select all and @code{0} to deselect all. + @item uid @code{n} + @opindex keyedit:uid + Toggle selection of user ID or photographic user ID with index @code{n}. + Use @code{*} to select all and @code{0} to deselect all. -@item key @code{n} -@opindex keyedit:key -Toggle selection of subkey with index @code{n}. -Use @code{*} to select all and @code{0} to deselect all. + @item key @code{n} + @opindex keyedit:key + Toggle selection of subkey with index @code{n}. + Use @code{*} to select all and @code{0} to deselect all. -@item sign -@opindex keyedit:sign -Make a signature on key of user @code{name} If the key is not yet -signed by the default user (or the users given with -u), the program -displays the information of the key again, together with its -fingerprint and asks whether it should be signed. This question is -repeated for all users specified with --u. + @item sign + @opindex keyedit:sign + Make a signature on key of user @code{name} If the key is not yet + signed by the default user (or the users given with -u), the program + displays the information of the key again, together with its + fingerprint and asks whether it should be signed. This question is + repeated for all users specified with + -u. -@item lsign -@opindex keyedit:lsign -Same as "sign" but the signature is marked as non-exportable and will -therefore never be used by others. This may be used to make keys -valid only in the local environment. + @item lsign + @opindex keyedit:lsign + Same as "sign" but the signature is marked as non-exportable and will + therefore never be used by others. This may be used to make keys + valid only in the local environment. -@item nrsign -@opindex keyedit:nrsign -Same as "sign" but the signature is marked as non-revocable and can -therefore never be revoked. + @item nrsign + @opindex keyedit:nrsign + Same as "sign" but the signature is marked as non-revocable and can + therefore never be revoked. -@item tsign -@opindex keyedit:tsign -Make a trust signature. This is a signature that combines the notions -of certification (like a regular signature), and trust (like the -"trust" command). It is generally only useful in distinct communities -or groups. + @item tsign + @opindex keyedit:tsign + Make a trust signature. This is a signature that combines the notions + of certification (like a regular signature), and trust (like the + "trust" command). It is generally only useful in distinct communities + or groups. @end table @c man:.RS @@ -644,212 +644,211 @@ create a signature of any type desired. @table @asis -@item delsig -@opindex keyedit:delsig -Delete a signature. Note that it is not possible to retract a signature, -once it has been send to the public (i.e. to a keyserver). In that case -you better use @code{revsig}. + @item delsig + @opindex keyedit:delsig + Delete a signature. Note that it is not possible to retract a signature, + once it has been send to the public (i.e. to a keyserver). In that case + you better use @code{revsig}. -@item revsig -@opindex keyedit:revsig -Revoke a signature. For every signature which has been generated by -one of the secret keys, GnuPG asks whether a revocation certificate -should be generated. + @item revsig + @opindex keyedit:revsig + Revoke a signature. For every signature which has been generated by + one of the secret keys, GnuPG asks whether a revocation certificate + should be generated. -@item check -@opindex keyedit:check -Check the signatures on all selected user IDs. + @item check + @opindex keyedit:check + Check the signatures on all selected user IDs. -@item adduid -@opindex keyedit:adduid -Create an additional user ID. + @item adduid + @opindex keyedit:adduid + Create an additional user ID. -@item addphoto -@opindex keyedit:addphoto -Create a photographic user ID. This will prompt for a JPEG file that -will be embedded into the user ID. Note that a very large JPEG will make -for a very large key. Also note that some programs will display your -JPEG unchanged (GnuPG), and some programs will scale it to fit in a -dialog box (PGP). + @item addphoto + @opindex keyedit:addphoto + Create a photographic user ID. This will prompt for a JPEG file that + will be embedded into the user ID. Note that a very large JPEG will make + for a very large key. Also note that some programs will display your + JPEG unchanged (GnuPG), and some programs will scale it to fit in a + dialog box (PGP). -@item showphoto -@opindex keyedit:showphoto -Display the selected photographic user ID. + @item showphoto + @opindex keyedit:showphoto + Display the selected photographic user ID. -@item deluid -@opindex keyedit:deluid -Delete a user ID or photographic user ID. Note that it is not -possible to retract a user id, once it has been send to the public -(i.e. to a keyserver). In that case you better use @code{revuid}. + @item deluid + @opindex keyedit:deluid + Delete a user ID or photographic user ID. Note that it is not + possible to retract a user id, once it has been send to the public + (i.e. to a keyserver). In that case you better use @code{revuid}. -@item revuid -@opindex keyedit:revuid -Revoke a user ID or photographic user ID. + @item revuid + @opindex keyedit:revuid + Revoke a user ID or photographic user ID. -@item primary -@opindex keyedit:primary -Flag the current user id as the primary one, removes the primary user -id flag from all other user ids and sets the timestamp of all affected -self-signatures one second ahead. Note that setting a photo user ID -as primary makes it primary over other photo user IDs, and setting a -regular user ID as primary makes it primary over other regular user -IDs. + @item primary + @opindex keyedit:primary + Flag the current user id as the primary one, removes the primary user + id flag from all other user ids and sets the timestamp of all affected + self-signatures one second ahead. Note that setting a photo user ID + as primary makes it primary over other photo user IDs, and setting a + regular user ID as primary makes it primary over other regular user + IDs. -@item keyserver -@opindex keyedit:keyserver -Set a preferred keyserver for the specified user ID(s). This allows -other users to know where you prefer they get your key from. See -@option{--keyserver-options honor-keyserver-url} for more on how this -works. Setting a value of "none" removes an existing preferred -keyserver. + @item keyserver + @opindex keyedit:keyserver + Set a preferred keyserver for the specified user ID(s). This allows + other users to know where you prefer they get your key from. See + @option{--keyserver-options honor-keyserver-url} for more on how this + works. Setting a value of "none" removes an existing preferred + keyserver. -@item notation -@opindex keyedit:notation -Set a name=value notation for the specified user ID(s). See -@option{--cert-notation} for more on how this works. Setting a value of -"none" removes all notations, setting a notation prefixed with a minus -sign (-) removes that notation, and setting a notation name (without the -=value) prefixed with a minus sign removes all notations with that name. + @item notation + @opindex keyedit:notation + Set a name=value notation for the specified user ID(s). See + @option{--cert-notation} for more on how this works. Setting a value of + "none" removes all notations, setting a notation prefixed with a minus + sign (-) removes that notation, and setting a notation name (without the + =value) prefixed with a minus sign removes all notations with that name. -@item pref -@opindex keyedit:pref -List preferences from the selected user ID. This shows the actual -preferences, without including any implied preferences. + @item pref + @opindex keyedit:pref + List preferences from the selected user ID. This shows the actual + preferences, without including any implied preferences. -@item showpref -@opindex keyedit:showpref -More verbose preferences listing for the selected user ID. This shows -the preferences in effect by including the implied preferences of 3DES -(cipher), SHA-1 (digest), and Uncompressed (compression) if they are -not already included in the preference list. In addition, the -preferred keyserver and signature notations (if any) are shown. + @item showpref + @opindex keyedit:showpref + More verbose preferences listing for the selected user ID. This shows + the preferences in effect by including the implied preferences of 3DES + (cipher), SHA-1 (digest), and Uncompressed (compression) if they are + not already included in the preference list. In addition, the + preferred keyserver and signature notations (if any) are shown. -@item setpref @code{string} -@opindex keyedit:setpref -Set the list of user ID preferences to @code{string} for all (or just -the selected) user IDs. Calling setpref with no arguments sets the -preference list to the default (either built-in or set via -@option{--default-preference-list}), and calling setpref with "none" -as the argument sets an empty preference list. Use @command{@gpgname ---version} to get a list of available algorithms. Note that while you -can change the preferences on an attribute user ID (aka "photo ID"), -GnuPG does not select keys via attribute user IDs so these preferences -will not be used by GnuPG. + @item setpref @code{string} + @opindex keyedit:setpref + Set the list of user ID preferences to @code{string} for all (or just + the selected) user IDs. Calling setpref with no arguments sets the + preference list to the default (either built-in or set via + @option{--default-preference-list}), and calling setpref with "none" + as the argument sets an empty preference list. Use @command{@gpgname + --version} to get a list of available algorithms. Note that while you + can change the preferences on an attribute user ID (aka "photo ID"), + GnuPG does not select keys via attribute user IDs so these preferences + will not be used by GnuPG. -When setting preferences, you should list the algorithms in the order -which you'd like to see them used by someone else when encrypting a -message to your key. If you don't include 3DES, it will be -automatically added at the end. Note that there are many factors that -go into choosing an algorithm (for example, your key may not be the -only recipient), and so the remote OpenPGP application being used to -send to you may or may not follow your exact chosen order for a given -message. It will, however, only choose an algorithm that is present -on the preference list of every recipient key. See also the -INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below. + When setting preferences, you should list the algorithms in the order + which you'd like to see them used by someone else when encrypting a + message to your key. If you don't include 3DES, it will be + automatically added at the end. Note that there are many factors that + go into choosing an algorithm (for example, your key may not be the + only recipient), and so the remote OpenPGP application being used to + send to you may or may not follow your exact chosen order for a given + message. It will, however, only choose an algorithm that is present + on the preference list of every recipient key. See also the + INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below. -@item addkey -@opindex keyedit:addkey -Add a subkey to this key. + @item addkey + @opindex keyedit:addkey + Add a subkey to this key. -@item addcardkey -@opindex keyedit:addcardkey -Generate a subkey on a card and add it to this key. + @item addcardkey + @opindex keyedit:addcardkey + Generate a subkey on a card and add it to this key. -@item keytocard -@opindex keyedit:keytocard -Transfer the selected secret subkey (or the primary key if no subkey -has been selected) to a smartcard. The secret key in the keyring will -be replaced by a stub if the key could be stored successfully on the -card and you use the save command later. Only certain key types may be -transferred to the card. A sub menu allows you to select on what card -to store the key. Note that it is not possible to get that key back -from the card - if the card gets broken your secret key will be lost -unless you have a backup somewhere. + @item keytocard + @opindex keyedit:keytocard + Transfer the selected secret subkey (or the primary key if no subkey + has been selected) to a smartcard. The secret key in the keyring will + be replaced by a stub if the key could be stored successfully on the + card and you use the save command later. Only certain key types may be + transferred to the card. A sub menu allows you to select on what card + to store the key. Note that it is not possible to get that key back + from the card - if the card gets broken your secret key will be lost + unless you have a backup somewhere. -@item bkuptocard @code{file} -@opindex keyedit:bkuptocard -Restore the given file to a card. This command may be used to restore a -backup key (as generated during card initialization) to a new card. In -almost all cases this will be the encryption key. You should use this -command only with the corresponding public key and make sure that the -file given as argument is indeed the backup to restore. You should then -select 2 to restore as encryption key. You will first be asked to enter -the passphrase of the backup key and then for the Admin PIN of the card. + @item bkuptocard @code{file} + @opindex keyedit:bkuptocard + Restore the given file to a card. This command may be used to restore a + backup key (as generated during card initialization) to a new card. In + almost all cases this will be the encryption key. You should use this + command only with the corresponding public key and make sure that the + file given as argument is indeed the backup to restore. You should then + select 2 to restore as encryption key. You will first be asked to enter + the passphrase of the backup key and then for the Admin PIN of the card. -@item delkey -@opindex keyedit:delkey -Remove a subkey (secondart key). Note that it is not possible to retract -a subkey, once it has been send to the public (i.e. to a keyserver). In -that case you better use @code{revkey}. + @item delkey + @opindex keyedit:delkey + Remove a subkey (secondart key). Note that it is not possible to retract + a subkey, once it has been send to the public (i.e. to a keyserver). In + that case you better use @code{revkey}. -@item revkey -@opindex keyedit:revkey -Revoke a subkey. + @item revkey + @opindex keyedit:revkey + Revoke a subkey. -@item expire -@opindex keyedit:expire -Change the key or subkey expiration time. If a subkey is selected, the -expiration time of this subkey will be changed. With no selection, the -key expiration of the primary key is changed. + @item expire + @opindex keyedit:expire + Change the key or subkey expiration time. If a subkey is selected, the + expiration time of this subkey will be changed. With no selection, the + key expiration of the primary key is changed. -@item trust -@opindex keyedit:trust -Change the owner trust value for the key. This updates the trust-db -immediately and no save is required. + @item trust + @opindex keyedit:trust + Change the owner trust value for the key. This updates the trust-db + immediately and no save is required. -@item disable -@itemx enable -@opindex keyedit:disable -@opindex keyedit:enable -Disable or enable an entire key. A disabled key can not normally be -used for encryption. + @item disable + @itemx enable + @opindex keyedit:disable + @opindex keyedit:enable + Disable or enable an entire key. A disabled key can not normally be + used for encryption. -@item addrevoker -@opindex keyedit:addrevoker -Add a designated revoker to the key. This takes one optional argument: -"sensitive". If a designated revoker is marked as sensitive, it will -not be exported by default (see export-options). + @item addrevoker + @opindex keyedit:addrevoker + Add a designated revoker to the key. This takes one optional argument: + "sensitive". If a designated revoker is marked as sensitive, it will + not be exported by default (see export-options). -@item passwd -@opindex keyedit:passwd -Change the passphrase of the secret key. + @item passwd + @opindex keyedit:passwd + Change the passphrase of the secret key. -@item toggle -@opindex keyedit:toggle -Toggle between public and secret key listing. + @item toggle + @opindex keyedit:toggle + Toggle between public and secret key listing. -@item clean -@opindex keyedit:clean -Compact (by removing all signatures except the selfsig) any user ID -that is no longer usable (e.g. revoked, or expired). Then, remove any -signatures that are not usable by the trust calculations. -Specifically, this removes any signature that does not validate, any -signature that is superseded by a later signature, revoked signatures, -and signatures issued by keys that are not present on the keyring. + @item clean + @opindex keyedit:clean + Compact (by removing all signatures except the selfsig) any user ID + that is no longer usable (e.g. revoked, or expired). Then, remove any + signatures that are not usable by the trust calculations. + Specifically, this removes any signature that does not validate, any + signature that is superseded by a later signature, revoked signatures, + and signatures issued by keys that are not present on the keyring. -@item minimize -@opindex keyedit:minimize -Make the key as small as possible. This removes all signatures from -each user ID except for the most recent self-signature. + @item minimize + @opindex keyedit:minimize + Make the key as small as possible. This removes all signatures from + each user ID except for the most recent self-signature. -@item cross-certify -@opindex keyedit:cross-certify -Add cross-certification signatures to signing subkeys that may not -currently have them. Cross-certification signatures protect against a -subtle attack against signing subkeys. See -@option{--require-cross-certification}. All new keys generated have -this signature by default, so this option is only useful to bring -older keys up to date. + @item cross-certify + @opindex keyedit:cross-certify + Add cross-certification signatures to signing subkeys that may not + currently have them. Cross-certification signatures protect against a + subtle attack against signing subkeys. See + @option{--require-cross-certification}. All new keys generated have + this signature by default, so this option is only useful to bring + older keys up to date. -@item save -@opindex keyedit:save -Save all changes to the key rings and quit. - -@item quit -@opindex keyedit:quit -Quit the program without updating the -key rings. + @item save + @opindex keyedit:save + Save all changes to the key rings and quit. + @item quit + @opindex keyedit:quit + Quit the program without updating the + key rings. @end table @c man:.RS @@ -863,27 +862,28 @@ the values: @table @asis -@item - -No ownertrust assigned / not yet calculated. + @item - + No ownertrust assigned / not yet calculated. -@item e -Trust -calculation has failed; probably due to an expired key. + @item e + Trust + calculation has failed; probably due to an expired key. -@item q -Not enough information for calculation. + @item q + Not enough information for calculation. -@item n -Never trust this key. + @item n + Never trust this key. -@item m -Marginally trusted. + @item m + Marginally trusted. -@item f -Fully trusted. + @item f + Fully trusted. + + @item u + Ultimately trusted. -@item u -Ultimately trusted. @end table @c ******** End Edit-key Options ********** @@ -1026,117 +1026,139 @@ give the opposite meaning. The options are: @table @asis -@item show-photos -@opindex list-options:show-photos -Causes @option{--list-keys}, @option{--list-sigs}, -@option{--list-public-keys}, and @option{--list-secret-keys} to -display any photo IDs attached to the key. Defaults to no. See also -@option{--photo-viewer}. Does not work with @option{--with-colons}: -see @option{--attribute-fd} for the appropriate way to get photo data -for scripts and other frontends. + @item show-photos + @opindex list-options:show-photos + Causes @option{--list-keys}, @option{--list-sigs}, + @option{--list-public-keys}, and @option{--list-secret-keys} to + display any photo IDs attached to the key. Defaults to no. See also + @option{--photo-viewer}. Does not work with @option{--with-colons}: + see @option{--attribute-fd} for the appropriate way to get photo data + for scripts and other frontends. -@item show-policy-urls -@opindex list-options:show-policy-urls -Show policy URLs in the @option{--list-sigs} or @option{--check-sigs} -listings. Defaults to no. + @item show-policy-urls + @opindex list-options:show-policy-urls + Show policy URLs in the @option{--list-sigs} or @option{--check-sigs} + listings. Defaults to no. -@item show-notations -@itemx show-std-notations -@itemx show-user-notations -@opindex list-options:show-notations -@opindex list-options:show-std-notations -@opindex list-options:show-user-notations -Show all, IETF standard, or user-defined signature notations in the -@option{--list-sigs} or @option{--check-sigs} listings. Defaults to no. + @item show-notations + @itemx show-std-notations + @itemx show-user-notations + @opindex list-options:show-notations + @opindex list-options:show-std-notations + @opindex list-options:show-user-notations + Show all, IETF standard, or user-defined signature notations in the + @option{--list-sigs} or @option{--check-sigs} listings. Defaults to no. -@item show-keyserver-urls + @item show-keyserver-urls + @opindex list-options:show-keyserver-urls + Show any preferred keyserver URL in the @option{--list-sigs} or + @option{--check-sigs} listings. Defaults to no. -Show any preferred keyserver URL in the @option{--list-sigs} or -@option{--check-sigs} listings. Defaults to no. + @item show-uid-validity + @opindex list-options:show-uid-validity + Display the calculated validity of user IDs during key listings. + Defaults to no. -@item show-uid-validity -Display the calculated validity of user IDs during key listings. -Defaults to no. + @item show-unusable-uids + @opindex list-options:show-unusable-uids + Show revoked and expired user IDs in key listings. Defaults to no. -@item show-unusable-uids -Show revoked and expired user IDs in key listings. Defaults to no. + @item show-unusable-subkeys + @opindex list-options:show-unusable-subkeys + Show revoked and expired subkeys in key listings. Defaults to no. -@item show-unusable-subkeys -Show revoked and expired subkeys in key listings. Defaults to no. + @item show-keyring + @opindex list-options:show-keyring + Display the keyring name at the head of key listings to show which + keyring a given key resides on. Defaults to no. -@item show-keyring -Display the keyring name at the head of key listings to show which -keyring a given key resides on. Defaults to no. + @item show-sig-expire + @opindex list-options:show-sig-expire + Show signature expiration dates (if any) during @option{--list-sigs} or + @option{--check-sigs} listings. Defaults to no. -@item show-sig-expire -Show signature expiration dates (if any) during @option{--list-sigs} or -@option{--check-sigs} listings. Defaults to no. + @item show-sig-subpackets + @opindex list-options:show-sig-subpackets + Include signature subpackets in the key listing. This option can take an + optional argument list of the subpackets to list. If no argument is + passed, list all subpackets. Defaults to no. This option is only + meaningful when using @option{--with-colons} along with + @option{--list-sigs} or @option{--check-sigs}. -@item show-sig-subpackets -Include signature subpackets in the key listing. This option can take an -optional argument list of the subpackets to list. If no argument is -passed, list all subpackets. Defaults to no. This option is only -meaningful when using @option{--with-colons} along with -@option{--list-sigs} or @option{--check-sigs}. @end table @item --verify-options @code{parameters} +@opindex verify-options This is a space or comma delimited string that gives options used when verifying signatures. Options can be prepended with a `no-' to give the opposite meaning. The options are: @table @asis -@item show-photos -Display any photo IDs present on the key that issued the signature. -Defaults to no. See also @option{--photo-viewer}. + @item show-photos + @opindex verify-options:show-photos + Display any photo IDs present on the key that issued the signature. + Defaults to no. See also @option{--photo-viewer}. -@item show-policy-urls -Show policy URLs in the signature being verified. Defaults to no. + @item show-policy-urls + @opindex verify-options:show-policy-urls + Show policy URLs in the signature being verified. Defaults to no. -@item show-notations -@itemx show-std-notations -@itemx show-user-notations -Show all, IETF standard, or user-defined signature notations in the -signature being verified. Defaults to IETF standard. + @item show-notations + @itemx show-std-notations + @itemx show-user-notations + @opindex verify-options:show-notations + @opindex verify-options:show-std-notations + @opindex verify-options:show-user-notations + Show all, IETF standard, or user-defined signature notations in the + signature being verified. Defaults to IETF standard. -@item show-keyserver-urls -Show any preferred keyserver URL in the signature being verified. -Defaults to no. + @item show-keyserver-urls + @opindex verify-options:show-keyserver-urls + Show any preferred keyserver URL in the signature being verified. + Defaults to no. -@item show-uid-validity -Display the calculated validity of the user IDs on the key that issued -the signature. Defaults to no. + @item show-uid-validity + @opindex verify-options:show-uid-validity + Display the calculated validity of the user IDs on the key that issued + the signature. Defaults to no. -@item show-unusable-uids -Show revoked and expired user IDs during signature verification. -Defaults to no. + @item show-unusable-uids + @opindex verify-options:show-unusable-uids + Show revoked and expired user IDs during signature verification. + Defaults to no. -@item show-primary-uid-only -Show only the primary user ID during signature verification. That is -all the AKA lines as well as photo Ids are not shown with the signature -verification status. + @item show-primary-uid-only + @opindex verify-options:show-primary-uid-only + Show only the primary user ID during signature verification. That is + all the AKA lines as well as photo Ids are not shown with the signature + verification status. -@item pka-lookups -Enable PKA lookups to verify sender addresses. Note that PKA is based -on DNS, and so enabling this option may disclose information on when -and what signatures are verified or to whom data is encrypted. This -is similar to the "web bug" described for the auto-key-retrieve -feature. + @item pka-lookups + @opindex verify-options:pka-lookups + Enable PKA lookups to verify sender addresses. Note that PKA is based + on DNS, and so enabling this option may disclose information on when + and what signatures are verified or to whom data is encrypted. This + is similar to the "web bug" described for the auto-key-retrieve + feature. -@item pka-trust-increase -Raise the trust in a signature to full if the signature passes PKA -validation. This option is only meaningful if pka-lookups is set. + @item pka-trust-increase + @opindex verify-options:pka-trust-increase + Raise the trust in a signature to full if the signature passes PKA + validation. This option is only meaningful if pka-lookups is set. @end table @item --enable-dsa2 @itemx --disable-dsa2 +@opindex enable-dsa2 +@opindex disable-dsa2 Enable hash truncation for all DSA keys even for old DSA Keys up to 1024 bit. This is also the default with @option{--openpgp}. Note that older versions of GnuPG also required this flag to allow the generation of DSA larger than 1024 bit. @item --photo-viewer @code{string} +@opindex photo-viewer This is the command line that should be run to view a photo ID. "%i" will be expanded to a filename containing the photo. "%I" does the same, except the file will not be deleted once the viewer exits. @@ -1154,6 +1176,7 @@ STDIN". Note that if your image viewer program is not secure, then executing it from GnuPG does not make it secure. @item --exec-path @code{string} +@opindex exec-path Sets a list of directories to search for photo viewers and keyserver helpers. If not provided, keyserver helpers use the compiled-in default directory, and photo viewers use the $PATH environment @@ -1162,6 +1185,7 @@ Note, that on W32 system this value is ignored when searching for keyserver helpers. @item --keyring @code{file} +@opindex keyring Add @code{file} to the current list of keyrings. If @code{file} begins with a tilde and a slash, these are replaced by the $HOME directory. If the filename does not contain a slash, it is assumed to be in the GnuPG @@ -1173,14 +1197,17 @@ use the specified keyring alone, use @option{--keyring} along with @option{--no-default-keyring}. @item --secret-keyring @code{file} +@opindex secret-keyring Same as @option{--keyring} but for the secret keyrings. @item --primary-keyring @code{file} +@opindex primary-keyring Designate @code{file} as the primary public keyring. This means that newly imported keys (via @option{--import} or keyserver @option{--recv-from}) will go to this keyring. @item --trustdb-name @code{file} +@opindex trustdb-name Use @code{file} instead of the default trustdb. If @code{file} begins with a tilde and a slash, these are replaced by the $HOME directory. If the filename does not contain a slash, it is assumed to be in the GnuPG @@ -1195,6 +1222,7 @@ not used). @ifset gpgone @item --pcsc-driver @code{file} +@opindex pcsc-driver Use @code{file} to access the smartcard reader. The current default is `libpcsclite.so.1' for GLIBC based systems, `/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X, @@ -1203,6 +1231,7 @@ Use @code{file} to access the smartcard reader. The current default is @ifset gpgone @item --disable-ccid +@opindex disable-ccid Disable the integrated support for CCID compliant readers. This allows to fall back to one of the other drivers even if the internal CCID driver can handle the reader. Note, that CCID support is only @@ -1211,6 +1240,7 @@ available if libusb was available at build time. @ifset gpgone @item --reader-port @code{number_or_string} +@opindex reader-port This option may be used to specify the port of the card terminal. A value of 0 refers to the first serial device; add 32768 to access USB devices. The default is 32768 (first USB device). PC/SC or CCID @@ -1220,6 +1250,7 @@ found. @end ifset @item --display-charset @code{name} +@opindex display-charset Set the name of the native character set. This is used to convert some informational strings like user IDs to the proper UTF-8 encoding. Note that this has nothing to do with the character set of data to be @@ -1230,26 +1261,32 @@ Valid values for @code{name} are: @table @asis -@item iso-8859-1 -This is the Latin 1 set. + @item iso-8859-1 + @opindex display-charset:iso-8859-1 + This is the Latin 1 set. -@item iso-8859-2 -The Latin 2 set. + @item iso-8859-2 + @opindex display-charset:iso-8859-2 + The Latin 2 set. -@item iso-8859-15 -This is currently an alias for -the Latin 1 set. + @item iso-8859-15 + @opindex display-charset:iso-8859-15 + This is currently an alias for + the Latin 1 set. -@item koi8-r -The usual Russian set (rfc1489). + @item koi8-r + @opindex display-charset:koi8-r + The usual Russian set (rfc1489). -@item utf-8 -Bypass all translations and assume -that the OS uses native UTF-8 encoding. + @item utf-8 + @opindex display-charset:utf-8 + Bypass all translations and assume + that the OS uses native UTF-8 encoding. @end table @item --utf8-strings @itemx --no-utf8-strings +@opindex utf8-strings Assume that command line arguments are given as UTF8 strings. The default (@option{--no-utf8-strings}) is to assume that arguments are encoded in the character set as specified by @@ -1260,20 +1297,22 @@ arguments. Both options may be used multiple times. @anchor{option --options} @end ifset @item --options @code{file} +@opindex options Read options from @code{file} and do not try to read them from the default options file in the homedir (see @option{--homedir}). This option is ignored if used in an options file. @item --no-options +@opindex no-options Shortcut for @option{--options /dev/null}. This option is detected before an attempt to open an option file. Using this option will also prevent the creation of a @file{~/.gnupg} homedir. - - @item -z @code{n} @itemx --compress-level @code{n} @itemx --bzip2-compress-level @code{n} +@opindex compress-level +@opindex bzip2-compress-level Set compression level to @code{n} for the ZIP and ZLIB compression algorithms. The default is to use the default compression level of zlib (normally 6). @option{--bzip2-compress-level} sets the compression level @@ -1283,6 +1322,7 @@ significant amount of memory for each additional compression level. @option{-z} sets both. A value of 0 for @code{n} disables compression. @item --bzip2-decompress-lowmem +@opindex bzip2-decompress-lowmem Use a different decompression method for BZIP2 compressed files. This alternate method uses a bit more than half the memory, but also runs at half the speed. This is useful under extreme low memory @@ -1302,6 +1342,7 @@ platforms. @item --ask-cert-level @itemx --no-ask-cert-level +@opindex ask-cert-level When making a key signature, prompt for a certification level. If this option is not specified, the certification level used is set via @option{--default-cert-level}. See @option{--default-cert-level} for @@ -1310,6 +1351,7 @@ used. @option{--no-ask-cert-level} disables this option. This option defaults to no. @item --default-cert-level @code{n} +@opindex default-cert-level The default to use for the check level when signing a key. 0 means you make no particular claim as to how carefully you verified @@ -1339,12 +1381,14 @@ and "extensive" mean to you. This option defaults to 0 (no particular claim). @item --min-cert-level +@opindex min-cert-level When building the trust database, treat any signatures with a certification level below this as invalid. Defaults to 2, which disregards level 1 signatures. Note that level 0 "no particular claim" signatures are always accepted. @item --trusted-key @code{long key ID} +@opindex trusted-key Assume that the specified key (which must be given as a full 8 byte key ID) is as trustworthy as one of your own secret keys. This option is useful if you @@ -1353,37 +1397,44 @@ online but still want to be able to check the validity of a given recipient's or signator's key. @item --trust-model @code{pgp|classic|direct|always|auto} +@opindex trust-model Set what trust model GnuPG should follow. The models are: @table @asis -@item pgp -This is the Web of Trust combined with trust signatures as used in PGP -5.x and later. This is the default trust model when creating a new -trust database. + @item pgp + @opindex trust-mode:pgp + This is the Web of Trust combined with trust signatures as used in PGP + 5.x and later. This is the default trust model when creating a new + trust database. -@item classic -This is the standard Web of Trust as used in PGP 2.x and earlier. + @item classic + @opindex trust-mode:classic + This is the standard Web of Trust as used in PGP 2.x and earlier. -@item direct -Key validity is set directly by the user and not calculated via the -Web of Trust. + @item direct + @opindex trust-mode:direct + Key validity is set directly by the user and not calculated via the + Web of Trust. -@item always -Skip key validation and assume that used keys are always fully -trusted. You generally won't use this unless you are using some -external validation scheme. This option also suppresses the -"[uncertain]" tag printed with signature checks when there is no -evidence that the user ID is bound to the key. + @item always + @opindex trust-mode:always + Skip key validation and assume that used keys are always fully + trusted. You generally won't use this unless you are using some + external validation scheme. This option also suppresses the + "[uncertain]" tag printed with signature checks when there is no + evidence that the user ID is bound to the key. -@item auto -Select the trust model depending on whatever the internal trust -database says. This is the default model if such a database already -exists. + @item auto + @opindex trust-mode:auto + Select the trust model depending on whatever the internal trust + database says. This is the default model if such a database already + exists. @end table @item --auto-key-locate @code{parameters} @itemx --no-auto-key-locate +@opindex auto-key-locate GnuPG can automatically locate and retrieve keys as needed using this option. This happens when encrypting to an email address (in the "user@@example.com" form), and there are no user@@example.com keys on @@ -1392,40 +1443,41 @@ mechanisms, in the order they are to be tried: @table @asis -@item cert -Locate a key using DNS CERT, as specified in rfc4398. + @item cert + Locate a key using DNS CERT, as specified in rfc4398. -@item pka -Locate a key using DNS PKA. + @item pka + Locate a key using DNS PKA. -@item ldap -Using DNS Service Discovery, check the domain in question for any LDAP -keyservers to use. If this fails, attempt to locate the key using the -PGP Universal method of checking @samp{ldap://keys.(thedomain)}. + @item ldap + Using DNS Service Discovery, check the domain in question for any LDAP + keyservers to use. If this fails, attempt to locate the key using the + PGP Universal method of checking @samp{ldap://keys.(thedomain)}. -@item keyserver -Locate a key using whatever keyserver is defined using the -@option{--keyserver} option. + @item keyserver + Locate a key using whatever keyserver is defined using the + @option{--keyserver} option. -@item keyserver-URL -In addition, a keyserver URL as used in the @option{--keyserver} option -may be used here to query that particular keyserver. + @item keyserver-URL + In addition, a keyserver URL as used in the @option{--keyserver} option + may be used here to query that particular keyserver. -@item local -Locate the key using the local keyrings. This mechanism allows to -select the order a local key lookup is done. Thus using -@samp{--auto-key-locate local} is identical to -@option{--no-auto-key-locate}. + @item local + Locate the key using the local keyrings. This mechanism allows to + select the order a local key lookup is done. Thus using + @samp{--auto-key-locate local} is identical to + @option{--no-auto-key-locate}. -@item nodefault -This flag disables the standard local key lookup, done before any of the -mechanisms defined by the @option{--auto-key-locate} are tried. The -position of this mechanism in the list does not matter. It is not -required if @code{local} is also used. + @item nodefault + This flag disables the standard local key lookup, done before any of the + mechanisms defined by the @option{--auto-key-locate} are tried. The + position of this mechanism in the list does not matter. It is not + required if @code{local} is also used. @end table @item --keyid-format @code{short|0xshort|long|0xlong} +@opindex keyid-format Select how to display key IDs. "short" is the traditional 8-character key ID. "long" is the more accurate (but less convenient) 16-character key ID. Add an "0x" to either to include an "0x" at the @@ -1433,6 +1485,7 @@ beginning of the key ID, as in 0x99242560. Note that this option is ignored if the option --with-colons is used. @item --keyserver @code{name} +@opindex keyserver Use @code{name} as your keyserver. This is the server that @option{--recv-keys}, @option{--send-keys}, and @option{--search-keys} will communicate with to receive keys from, send keys to, and search for @@ -1452,6 +1505,7 @@ need to send keys to more than one server. The keyserver keyserver each time you use it. @item --keyserver-options @code{name=value1 } +@opindex keyserver-options This is a space or comma delimited string that gives options for the keyserver. Options can be prefixed with a `no-' to give the opposite meaning. Valid import-options or export-options may be used here as @@ -1461,111 +1515,115 @@ are available for all keyserver types, some common options are: @table @asis -@item include-revoked -When searching for a key with @option{--search-keys}, include keys that -are marked on the keyserver as revoked. Note that not all keyservers -differentiate between revoked and unrevoked keys, and for such -keyservers this option is meaningless. Note also that most keyservers do -not have cryptographic verification of key revocations, and so turning -this option off may result in skipping keys that are incorrectly marked -as revoked. + @item include-revoked + When searching for a key with @option{--search-keys}, include keys that + are marked on the keyserver as revoked. Note that not all keyservers + differentiate between revoked and unrevoked keys, and for such + keyservers this option is meaningless. Note also that most keyservers do + not have cryptographic verification of key revocations, and so turning + this option off may result in skipping keys that are incorrectly marked + as revoked. -@item include-disabled -When searching for a key with @option{--search-keys}, include keys that -are marked on the keyserver as disabled. Note that this option is not -used with HKP keyservers. + @item include-disabled + When searching for a key with @option{--search-keys}, include keys that + are marked on the keyserver as disabled. Note that this option is not + used with HKP keyservers. -@item auto-key-retrieve -This option enables the automatic retrieving of keys from a keyserver -when verifying signatures made by keys that are not on the local -keyring. + @item auto-key-retrieve + This option enables the automatic retrieving of keys from a keyserver + when verifying signatures made by keys that are not on the local + keyring. -Note that this option makes a "web bug" like behavior possible. -Keyserver operators can see which keys you request, so by sending you -a message signed by a brand new key (which you naturally will not have -on your local keyring), the operator can tell both your IP address and -the time when you verified the signature. + Note that this option makes a "web bug" like behavior possible. + Keyserver operators can see which keys you request, so by sending you + a message signed by a brand new key (which you naturally will not have + on your local keyring), the operator can tell both your IP address and + the time when you verified the signature. -@item honor-keyserver-url -When using @option{--refresh-keys}, if the key in question has a preferred -keyserver URL, then use that preferred keyserver to refresh the key -from. In addition, if auto-key-retrieve is set, and the signature -being verified has a preferred keyserver URL, then use that preferred -keyserver to fetch the key from. Defaults to yes. + @item honor-keyserver-url + When using @option{--refresh-keys}, if the key in question has a preferred + keyserver URL, then use that preferred keyserver to refresh the key + from. In addition, if auto-key-retrieve is set, and the signature + being verified has a preferred keyserver URL, then use that preferred + keyserver to fetch the key from. Defaults to yes. -@item honor-pka-record -If auto-key-retrieve is set, and the signature being verified has a -PKA record, then use the PKA information to fetch the key. Defaults -to yes. + @item honor-pka-record + If auto-key-retrieve is set, and the signature being verified has a + PKA record, then use the PKA information to fetch the key. Defaults + to yes. -@item include-subkeys -When receiving a key, include subkeys as potential targets. Note that -this option is not used with HKP keyservers, as they do not support -retrieving keys by subkey id. + @item include-subkeys + When receiving a key, include subkeys as potential targets. Note that + this option is not used with HKP keyservers, as they do not support + retrieving keys by subkey id. -@item use-temp-files -On most Unix-like platforms, GnuPG communicates with the keyserver -helper program via pipes, which is the most efficient method. This -option forces GnuPG to use temporary files to communicate. On some -platforms (such as Win32 and RISC OS), this option is always enabled. + @item use-temp-files + On most Unix-like platforms, GnuPG communicates with the keyserver + helper program via pipes, which is the most efficient method. This + option forces GnuPG to use temporary files to communicate. On some + platforms (such as Win32 and RISC OS), this option is always enabled. -@item keep-temp-files -If using `use-temp-files', do not delete the temp files after using -them. This option is useful to learn the keyserver communication -protocol by reading the temporary files. + @item keep-temp-files + If using `use-temp-files', do not delete the temp files after using + them. This option is useful to learn the keyserver communication + protocol by reading the temporary files. -@item verbose -Tell the keyserver helper program to be more verbose. This option can -be repeated multiple times to increase the verbosity level. + @item verbose + Tell the keyserver helper program to be more verbose. This option can + be repeated multiple times to increase the verbosity level. -@item timeout -Tell the keyserver helper program how long (in seconds) to try and -perform a keyserver action before giving up. Note that performing -multiple actions at the same time uses this timeout value per action. -For example, when retrieving multiple keys via @option{--recv-keys}, the -timeout applies separately to each key retrieval, and not to the -@option{--recv-keys} command as a whole. Defaults to 30 seconds. + @item timeout + Tell the keyserver helper program how long (in seconds) to try and + perform a keyserver action before giving up. Note that performing + multiple actions at the same time uses this timeout value per action. + For example, when retrieving multiple keys via @option{--recv-keys}, the + timeout applies separately to each key retrieval, and not to the + @option{--recv-keys} command as a whole. Defaults to 30 seconds. -@item http-proxy=@code{value} -Set the proxy to use for HTTP and HKP keyservers. This overrides the -"http_proxy" environment variable, if any. + @item http-proxy=@code{value} + Set the proxy to use for HTTP and HKP keyservers. This overrides the + "http_proxy" environment variable, if any. -@item max-cert-size -When retrieving a key via DNS CERT, only accept keys up to this size. -Defaults to 16384 bytes. + @item max-cert-size + When retrieving a key via DNS CERT, only accept keys up to this size. + Defaults to 16384 bytes. -@item debug -Turn on debug output in the keyserver helper program. Note that the -details of debug output depends on which keyserver helper program is -being used, and in turn, on any libraries that the keyserver helper -program uses internally (libcurl, openldap, etc). + @item debug + Turn on debug output in the keyserver helper program. Note that the + details of debug output depends on which keyserver helper program is + being used, and in turn, on any libraries that the keyserver helper + program uses internally (libcurl, openldap, etc). -@item check-cert -Enable certificate checking if the keyserver presents one (for hkps or -ldaps). Defaults to on. + @item check-cert + Enable certificate checking if the keyserver presents one (for hkps or + ldaps). Defaults to on. -@item ca-cert-file -Provide a certificate store to override the system default. Only -necessary if check-cert is enabled, and the keyserver is using a -certificate that is not present in a system default certificate list. + @item ca-cert-file + Provide a certificate store to override the system default. Only + necessary if check-cert is enabled, and the keyserver is using a + certificate that is not present in a system default certificate list. -Note that depending on the SSL library that the keyserver helper is -built with, this may actually be a directory or a file. + Note that depending on the SSL library that the keyserver helper is + built with, this may actually be a directory or a file. @end table @item --completes-needed @code{n} +@opindex compliant-needed Number of completely trusted users to introduce a new key signer (defaults to 1). @item --marginals-needed @code{n} +@opindex marginals-needed Number of marginally trusted users to introduce a new key signer (defaults to 3) @item --max-cert-depth @code{n} +@opindex max-cert-depth Maximum depth of a certification chain (default is 5). @ifclear gpgtwoone @item --simple-sk-checksum +@opindex simple-sk-checksum Secret keys are integrity protected by using a SHA-1 checksum. This method is part of the upcoming enhanced OpenPGP specification but GnuPG already uses it as a countermeasure against certain attacks. @@ -1578,6 +1636,7 @@ value is acceptable). @end ifclear @item --no-sig-cache +@opindex no-sig-cache Do not cache the verification status of key signatures. Caching gives a much better performance in key listings. However, if you suspect that your public keyring is not save against write @@ -1586,6 +1645,7 @@ probably does not make sense to disable it because all kind of damage can be done if someone else has write access to your public keyring. @item --no-sig-create-check +@opindex no-sig-create-check GnuPG normally verifies each signature right after creation to protect against bugs and hardware malfunctions which could leak out bits from the secret key. This extra verification needs some time (about 115% @@ -1595,6 +1655,7 @@ interaction, this performance penalty does not matter in most settings. @item --auto-check-trustdb @itemx --no-auto-check-trustdb +@opindex auto-check-trustdb If GnuPG feels that its information about the Web of Trust has to be updated, it automatically runs the @option{--check-trustdb} command internally. This may be a time consuming @@ -1602,6 +1663,7 @@ process. @option{--no-auto-check-trustdb} disables this option. @item --use-agent @itemx --no-use-agent +@opindex use-agent @ifclear gpgone This is dummy option. @command{@gpgname} always requires the agent. @end ifclear @@ -1612,6 +1674,7 @@ passphrase. @option{--no-use-agent} disables this option. @end ifset @item --gpg-agent-info +@opindex gpg-agent-info @ifclear gpgone This is dummy option. It has no effect when used with @command{gpg2}. @end ifclear @@ -1623,16 +1686,19 @@ been given. Given that this option is not anymore used by @end ifset @item --lock-once +@opindex lock-once Lock the databases the first time a lock is requested and do not release the lock until the process terminates. @item --lock-multiple +@opindex lock-multiple Release the locks every time a lock is no longer needed. Use this to override a previous @option{--lock-once} from a config file. @item --lock-never +@opindex lock-never Disable locking entirely. This option should be used only in very special environments, where it can be assured that only one process is accessing those files. A bootable floppy with a stand-alone @@ -1640,6 +1706,7 @@ encryption system will probably use this. Improper usage of this option may lead to data and key corruption. @item --exit-on-status-write-error +@opindex exit-on-status-write-error This option will cause write errors on the status FD to immediately terminate the process. That should in fact be the default but it never worked this way and thus we need an option to enable this, so that the @@ -1649,6 +1716,7 @@ connected pipe too early. Using this option along with running gpg operations. @item --limit-card-insert-tries @code{n} +@opindex limit-card-insert-tries With @code{n} greater than 0 the number of prompts asking to insert a smartcard gets limited to N-1. Thus with a value of 1 gpg won't at all ask to insert a card if none has been inserted at startup. This @@ -1657,18 +1725,22 @@ not know about the smartcard support and waits ad infinitum for an inserted card. @item --no-random-seed-file +@opindex no-random-seed-file GnuPG uses a file to store its internal random pool over invocations. This makes random generation faster; however sometimes write operations are not desired. This option can be used to achieve that with the cost of slower random generation. @item --no-greeting +@opindex no-greeting Suppress the initial copyright message. @item --no-secmem-warning +@opindex no-secmem-warning Suppress the warning about "using insecure memory". @item --no-permission-warning +@opindex permission-warning Suppress the warning about unsafe file and home directory (@option{--homedir}) permissions. Note that the permission checks that GnuPG performs are not intended to be authoritative, but rather they simply warn about @@ -1682,16 +1754,19 @@ warnings about itself. The @option{--homedir} permissions warning may only be suppressed on the command line. @item --no-mdc-warning +@opindex no-mdc-warning Suppress the warning about missing MDC integrity protection. @item --require-secmem @itemx --no-require-secmem +@opindex require-secmem Refuse to run if GnuPG cannot get secure memory. Defaults to no (i.e. run, but give a warning). @item --require-cross-certification @itemx --no-require-cross-certification +@opindex require-cross-certification When verifying a signature made from a subkey, ensure that the cross certification "back signature" on the subkey is present and valid. This protects against a subtle attack against subkeys that can sign. @@ -1700,6 +1775,7 @@ Defaults to @option{--require-cross-certification} for @item --expert @itemx --no-expert +@opindex expert Allow the user to do certain nonsensical or "silly" things like signing an expired or revoked key, or certain potentially incompatible things like generating unusual key types. This also disables certain @@ -1708,9 +1784,6 @@ implies, this option is for experts only. If you don't fully understand the implications of what it allows you to do, leave this off. @option{--no-expert} disables this option. - - - @end table @@ -1739,6 +1812,7 @@ limited countermeasure against traffic analysis. If this option or @option{--default-recipient} is given. @item --encrypt-to @code{name} +@opindex encrypt-to Same as @option{--recipient} but this one is intended for use in the options file and may be used with your own user-id as an "encrypt-to-self". These keys are only used when there are other @@ -1747,6 +1821,7 @@ user id. No trust checking is performed for these user ids and even disabled keys can be used. @item --hidden-encrypt-to @code{name} +@opindex hidden-encrypt-to Same as @option{--hidden-recipient} but this one is intended for use in the options file and may be used with your own user-id as a hidden "encrypt-to-self". These keys are only used when there are other @@ -1755,10 +1830,12 @@ No trust checking is performed for these user ids and even disabled keys can be used. @item --no-encrypt-to +@opindex no-encrypt-to Disable the use of all @option{--encrypt-to} and @option{--hidden-encrypt-to} keys. @item --group @code{name=value1 } +@opindex group Sets up a named group, which is similar to aliases in email programs. Any time the group name is a recipient (@option{-r} or @option{--recipient}), it will be expanded to the values @@ -1774,9 +1851,11 @@ this option to prevent the shell from treating it as multiple arguments. @item --ungroup @code{name} +@opindex ungroup Remove a given entry from the @option{--group} list. @item --no-groups +@opindex no-groups Remove all entries from the @option{--group} list. @item --local-user @var{name} @@ -1837,6 +1916,7 @@ Create ASCII armored output. The default is to create the binary OpenPGP format. @item --no-armor +@opindex no-armor Assume the input data is not in ASCII armored format. @item --output @var{file} @@ -1855,91 +1935,93 @@ maximum file size that will be generated before processing is forced to stop by the OS limits. Defaults to 0, which means "no limit". @item --import-options @code{parameters} +@opindex import-options This is a space or comma delimited string that gives options for importing keys. Options can be prepended with a `no-' to give the opposite meaning. The options are: @table @asis -@item import-local-sigs -Allow importing key signatures marked as "local". This is not -generally useful unless a shared keyring scheme is being used. -Defaults to no. + @item import-local-sigs + Allow importing key signatures marked as "local". This is not + generally useful unless a shared keyring scheme is being used. + Defaults to no. -@item repair-pks-subkey-bug -During import, attempt to repair the damage caused by the PKS keyserver -bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note -that this cannot completely repair the damaged key as some crucial data -is removed by the keyserver, but it does at least give you back one -subkey. Defaults to no for regular @option{--import} and to yes for -keyserver @option{--recv-keys}. + @item repair-pks-subkey-bug + During import, attempt to repair the damage caused by the PKS keyserver + bug (pre version 0.9.6) that mangles keys with multiple subkeys. Note + that this cannot completely repair the damaged key as some crucial data + is removed by the keyserver, but it does at least give you back one + subkey. Defaults to no for regular @option{--import} and to yes for + keyserver @option{--recv-keys}. -@item merge-only -During import, allow key updates to existing keys, but do not allow -any new keys to be imported. Defaults to no. + @item merge-only + During import, allow key updates to existing keys, but do not allow + any new keys to be imported. Defaults to no. -@item import-clean -After import, compact (remove all signatures except the -self-signature) any user IDs from the new key that are not usable. -Then, remove any signatures from the new key that are not usable. -This includes signatures that were issued by keys that are not present -on the keyring. This option is the same as running the @option{--edit-key} -command "clean" after import. Defaults to no. + @item import-clean + After import, compact (remove all signatures except the + self-signature) any user IDs from the new key that are not usable. + Then, remove any signatures from the new key that are not usable. + This includes signatures that were issued by keys that are not present + on the keyring. This option is the same as running the @option{--edit-key} + command "clean" after import. Defaults to no. -@item import-minimal -Import the smallest key possible. This removes all signatures except -the most recent self-signature on each user ID. This option is the -same as running the @option{--edit-key} command "minimize" after import. -Defaults to no. + @item import-minimal + Import the smallest key possible. This removes all signatures except + the most recent self-signature on each user ID. This option is the + same as running the @option{--edit-key} command "minimize" after import. + Defaults to no. @end table @item --export-options @code{parameters} +@opindex export-options This is a space or comma delimited string that gives options for exporting keys. Options can be prepended with a `no-' to give the opposite meaning. The options are: @table @asis -@item export-local-sigs -Allow exporting key signatures marked as "local". This is not -generally useful unless a shared keyring scheme is being used. -Defaults to no. + @item export-local-sigs + Allow exporting key signatures marked as "local". This is not + generally useful unless a shared keyring scheme is being used. + Defaults to no. -@item export-attributes -Include attribute user IDs (photo IDs) while exporting. This is -useful to export keys if they are going to be used by an OpenPGP -program that does not accept attribute user IDs. Defaults to yes. + @item export-attributes + Include attribute user IDs (photo IDs) while exporting. This is + useful to export keys if they are going to be used by an OpenPGP + program that does not accept attribute user IDs. Defaults to yes. -@item export-sensitive-revkeys -Include designated revoker information that was marked as -"sensitive". Defaults to no. + @item export-sensitive-revkeys + Include designated revoker information that was marked as + "sensitive". Defaults to no. -@c Since GnuPG 2.1 gpg-agent manages the secret key and thus the -@c export-reset-subkey-passwd hack is not anymore justified. Such use -@c cases need to be implemented using a specialized secret key export -@c tool. + @c Since GnuPG 2.1 gpg-agent manages the secret key and thus the + @c export-reset-subkey-passwd hack is not anymore justified. Such use + @c cases need to be implemented using a specialized secret key export + @c tool. @ifclear gpgtwoone -@item export-reset-subkey-passwd -When using the @option{--export-secret-subkeys} command, this option resets -the passphrases for all exported subkeys to empty. This is useful -when the exported subkey is to be used on an unattended machine where -a passphrase doesn't necessarily make sense. Defaults to no. + @item export-reset-subkey-passwd + When using the @option{--export-secret-subkeys} command, this option resets + the passphrases for all exported subkeys to empty. This is useful + when the exported subkey is to be used on an unattended machine where + a passphrase doesn't necessarily make sense. Defaults to no. @end ifclear -@item export-clean -Compact (remove all signatures from) user IDs on the key being -exported if the user IDs are not usable. Also, do not export any -signatures that are not usable. This includes signatures that were -issued by keys that are not present on the keyring. This option is -the same as running the @option{--edit-key} command "clean" before export -except that the local copy of the key is not modified. Defaults to -no. + @item export-clean + Compact (remove all signatures from) user IDs on the key being + exported if the user IDs are not usable. Also, do not export any + signatures that are not usable. This includes signatures that were + issued by keys that are not present on the keyring. This option is + the same as running the @option{--edit-key} command "clean" before export + except that the local copy of the key is not modified. Defaults to + no. -@item export-minimal -Export the smallest key possible. This removes all signatures except the -most recent self-signature on each user ID. This option is the same as -running the @option{--edit-key} command "minimize" before export except -that the local copy of the key is not modified. Defaults to no. + @item export-minimal + Export the smallest key possible. This removes all signatures except the + most recent self-signature on each user ID. This option is the same as + running the @option{--edit-key} command "minimize" before export except + that the local copy of the key is not modified. Defaults to no. @end table @item --with-colons @@ -1983,6 +2065,7 @@ Include the keygrip in the key listings. @item -t, --textmode @itemx --no-textmode +@opindex textmode Treat input files as text and store them in the OpenPGP canonical text form with standard "CRLF" line endings. This also sets the necessary flags to inform the recipient that the encrypted or signed data is text @@ -2002,6 +2085,7 @@ the type of the signature. @item --force-v3-sigs @itemx --no-force-v3-sigs +@opindex force-v3-sigs OpenPGP states that an implementation should generate v4 signatures but PGP versions 5 through 7 only recognize v4 signatures on key material. This option forces v3 signatures for signatures on data. @@ -2013,22 +2097,26 @@ Defaults to no. @item --force-v4-certs @itemx --no-force-v4-certs +@opindex force-v4-certs Always use v4 key signatures even on v3 keys. This option also changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1. @option{--no-force-v4-certs} disables this option. @item --force-mdc +@opindex force-mdc Force the use of encryption with a modification detection code. This is always used with the newer ciphers (those with a blocksize greater than 64 bits), or if all of the recipient keys indicate MDC support in their feature flags. @item --disable-mdc +@opindex disable-mdc Disable the use of the modification detection code. Note that by using this option, the encrypted message becomes vulnerable to a message modification attack. @item --personal-cipher-preferences @code{string} +@opindex personal-cipher-preferences Set the list of personal cipher preferences to @code{string}. Use @command{@gpgname --version} to get a list of available algorithms, and use @code{none} to set no preference at all. This allows the user @@ -2038,6 +2126,7 @@ all recipients. The most highly ranked cipher in this list is also used for the @option{--symmetric} encryption command. @item --personal-digest-preferences @code{string} +@opindex personal-digest-preferences Set the list of personal digest preferences to @code{string}. Use @command{@gpgname --version} to get a list of available algorithms, and use @code{none} to set no preference at all. This allows the user @@ -2048,6 +2137,7 @@ is also used when signing without encryption (e.g. @option{--clearsign} or @option{--sign}). @item --personal-compress-preferences @code{string} +@opindex personal-compress-preferences Set the list of personal compression preferences to @code{string}. Use @command{@gpgname --version} to get a list of available algorithms, and use @code{none} to set no preference at all. This @@ -2058,16 +2148,19 @@ algorithm in this list is also used when there are no recipient keys to consider (e.g. @option{--symmetric}). @item --s2k-cipher-algo @code{name} +@opindex s2k-cipher-algo Use @code{name} as the cipher algorithm used to protect secret keys. The default cipher is CAST5. This cipher is also used for conventional encryption if @option{--personal-cipher-preferences} and @option{--cipher-algo} is not given. @item --s2k-digest-algo @code{name} +@opindex s2k-digest-algo Use @code{name} as the digest algorithm used to mangle the passphrases. The default algorithm is SHA-1. @item --s2k-mode @code{n} +@opindex s2k-mode Selects how passphrases are mangled. If @code{n} is 0 a plain passphrase (which is not recommended) will be used, a 1 adds a salt to the passphrase and a 3 (the default) iterates the whole process a @@ -2075,12 +2168,13 @@ number of times (see --s2k-count). Unless @option{--rfc1991} is used, this mode is also used for conventional encryption. @item --s2k-count @code{n} +@opindex s2k-count Specify how many times the passphrase mangling is repeated. This -value may range between 1024 and 65011712 inclusive, and the default -is 65536. Note that not all values in the 1024-65011712 range are -legal and if an illegal value is selected, GnuPG will round up to the -nearest legal value. This option is only meaningful if -@option{--s2k-mode} is 3. +value may range between 1024 and 65011712 inclusive. The default is +inquired from gpg-agent. Note that not all values in the +1024-65011712 range are legal and if an illegal value is selected, +GnuPG will round up to the nearest legal value. This option is only +meaningful if @option{--s2k-mode} is 3. @end table @@ -2186,6 +2280,7 @@ SHA224, SHA384, and SHA512 digests. Don't make any changes (this is not completely implemented). @item --list-only +@opindex list-only Changes the behaviour of some commands. This is like @option{--dry-run} but different in some cases. The semantic of this command may be extended in the future. Currently it only skips the actual decryption pass and @@ -2202,22 +2297,22 @@ Select the debug level for investigating problems. @var{level} may be a numeric value or by a keyword: @table @code -@item none -No debugging at all. A value of less than 1 may be used instead of -the keyword. -@item basic -Some basic debug messages. A value between 1 and 2 may be used -instead of the keyword. -@item advanced -More verbose debug messages. A value between 3 and 5 may be used -instead of the keyword. -@item expert -Even more detailed messages. A value between 6 and 8 may be used -instead of the keyword. -@item guru -All of the debug messages you can get. A value greater than 8 may be -used instead of the keyword. The creation of hash tracing files is -only enabled if the keyword is used. + @item none + No debugging at all. A value of less than 1 may be used instead of + the keyword. + @item basic + Some basic debug messages. A value between 1 and 2 may be used + instead of the keyword. + @item advanced + More verbose debug messages. A value between 3 and 5 may be used + instead of the keyword. + @item expert + Even more detailed messages. A value between 6 and 8 may be used + instead of the keyword. + @item guru + All of the debug messages you can get. A value greater than 8 may be + used instead of the keyword. The creation of hash tracing files is + only enabled if the keyword is used. @end table How these messages are mapped to the actual debugging flags is not @@ -2230,10 +2325,12 @@ Set debugging flags. All flags are or-ed and @var{flags} may be given in C syntax (e.g. 0x0042). @item --debug-all +@opindex debug-all Set all useful debugging flags. @ifset gpgone @item --debug-ccid-driver +@opindex 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 @@ -2246,39 +2343,47 @@ forth to @var{epoch} which is the number of seconds elapsed since the year (e.g. "20070924T154812"). @item --enable-progress-filter +@opindex enable-progress-filter Enable certain PROGRESS status outputs. This option allows frontends to display a progress indicator while gpg is processing larger files. There is a slight performance overhead using it. @item --status-fd @code{n} +@opindex status-fd Write special status strings to the file descriptor @code{n}. See the file DETAILS in the documentation for a listing of them. @item --status-file @code{file} +@opindex status-file Same as @option{--status-fd}, except the status data is written to file @code{file}. @item --logger-fd @code{n} +@opindex logger-fd Write log output to file descriptor @code{n} and not to STDERR. @item --log-file @code{file} @itemx --logger-file @code{file} +@opindex log-file Same as @option{--logger-fd}, except the logger data is written to file @code{file}. Note that @option{--log-file} is only implemented for GnuPG-2. @item --attribute-fd @code{n} +@opindex attribute-fd Write attribute subpackets to the file descriptor @code{n}. This is most useful for use with @option{--status-fd}, since the status messages are needed to separate out the various subpackets from the stream delivered to the file descriptor. @item --attribute-file @code{file} +@opindex attribute-file Same as @option{--attribute-fd}, except the attribute data is written to file @code{file}. @item --comment @code{string} @itemx --no-comments +@opindex comment Use @code{string} as a comment string in clear text signatures and ASCII armored messages or keys (see @option{--armor}). The default behavior is not to use a comment string. @option{--comment} may be repeated multiple @@ -2290,12 +2395,16 @@ protected by the signature. @item --emit-version @itemx --no-emit-version +@opindex emit-version Force inclusion of the version string in ASCII armored output. @option{--no-emit-version} disables this option. @item --sig-notation @code{name=value} @itemx --cert-notation @code{name=value} @itemx -N, --set-notation @code{name=value} +@opindex sig-notation +@opindex cert-notation +@opindex set-notation Put the name value pair into the signature as notation data. @code{name} must consist only of printable characters or spaces, and must contain a '@@' character in the form keyname@@domain.example.com @@ -2325,6 +2434,9 @@ meaningful when using the OpenPGP smartcard. @item --sig-policy-url @code{string} @itemx --cert-policy-url @code{string} @itemx --set-policy-url @code{string} +@opindex sig-policy-url +@opindex cert-policy-url +@opindex set-policy-url 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 @@ -2334,6 +2446,7 @@ signatures (certifications). @option{--set-policy-url} sets both. The same %-expandos used for notation data are available here as well. @item --sig-keyserver-url @code{string} +@opindex sig-keyserver-url Use @code{string} as a preferred keyserver URL for data signatures. If you prefix it with an exclamation mark (!), the keyserver URL packet will be flagged as critical. @@ -2341,12 +2454,14 @@ will be flagged as critical. The same %-expandos used for notation data are available here as well. @item --set-filename @code{string} +@opindex set-filename Use @code{string} as the filename which is stored inside messages. This overrides the default, which is to use the actual filename of the file being encrypted. @item --for-your-eyes-only @itemx --no-for-your-eyes-only +@opindex for-your-eyes-only Set the `for your eyes only' flag in the message. This causes GnuPG to refuse to save the file unless the @option{--output} option is given, and PGP to use a "secure viewer" with a claimed Tempest-resistant font @@ -2355,10 +2470,12 @@ to display the message. This option overrides @option{--set-filename}. @item --use-embedded-filename @itemx --no-use-embedded-filename +@opindex use-embedded-filename Try to create a file with a name as embedded in the data. This can be a dangerous option as it allows to overwrite files. Defaults to no. @item --cipher-algo @code{name} +@opindex cipher-algo Use @code{name} as cipher algorithm. Running the program with the command @option{--version} yields a list of supported algorithms. If this is not used the cipher algorithm is selected from the preferences @@ -2368,6 +2485,7 @@ it allows you to violate the OpenPGP standard. same thing. @item --digest-algo @code{name} +@opindex digest-algo Use @code{name} as the message digest algorithm. Running the program with the command @option{--version} yields a list of supported algorithms. In general, you do not want to use this option as it allows you to @@ -2375,6 +2493,7 @@ violate the OpenPGP standard. @option{--personal-digest-preferences} is the safe way to accomplish the same thing. @item --compress-algo @code{name} +@opindex compress-algo Use compression algorithm @code{name}. "zlib" is RFC-1950 ZLIB compression. "zip" is RFC-1951 ZIP compression which is used by PGP. "bzip2" is a more modern compression scheme that can compress some @@ -2397,6 +2516,7 @@ violate the OpenPGP standard. @option{--personal-compress-preferences} is the safe way to accomplish the same thing. @item --cert-digest-algo @code{name} +@opindex cert-digest-algo Use @code{name} as the message digest algorithm used when signing a key. Running the program with the command @option{--version} yields a list of supported algorithms. Be aware that if you choose an algorithm @@ -2405,17 +2525,20 @@ users will not be able to use the key signatures you make, or quite possibly your entire key. @item --disable-cipher-algo @code{name} +@opindex disable-cipher-algo Never allow the use of @code{name} as cipher algorithm. The given name will not be checked so that a later loaded algorithm will still get disabled. @item --disable-pubkey-algo @code{name} +@opindex disable-pubkey-algo Never allow the use of @code{name} as public key algorithm. The given name will not be checked so that a later loaded algorithm will still get disabled. @item --throw-keyids @itemx --no-throw-keyids +@opindex throw-keyids Do not put the recipient key IDs into encrypted messages. This helps to hide the receivers of the message and is a limited countermeasure against traffic analysis.@footnote{Using a little social engineering @@ -2427,6 +2550,7 @@ is essentially the same as using @option{--hidden-recipient} for all recipients. @item --not-dash-escaped +@opindex not-dash-escaped This option changes the behavior of cleartext signatures so that they can be used for patch files. You should not send such an armored file via email because all spaces @@ -2437,6 +2561,7 @@ line tells GnuPG about this cleartext signature option. @item --escape-from-lines @itemx --no-escape-from-lines +@opindex escape-from-lines Because some mailers change lines starting with "From " to ">From " it is good to handle such lines in a special way when creating cleartext signatures to prevent the mail system from breaking the signature. Note @@ -2444,11 +2569,13 @@ that all other PGP versions do it this way too. Enabled by default. @option{--no-escape-from-lines} disables this option. @item --passphrase-repeat @code{n} +@opindex passphrase-repeat Specify how many times @command{@gpgname} will request a new passphrase be repeated. This is useful for helping memorize a passphrase. Defaults to 1 repetition. @item --passphrase-fd @code{n} +@opindex passphrase-fd Read the passphrase from file descriptor @code{n}. Only the first line will be read from file descriptor @code{n}. If you use 0 for @code{n}, the passphrase will be read from STDIN. This can only be used if only @@ -2459,6 +2586,7 @@ has also been given. This is different from @command{gpg}. @end ifclear @item --passphrase-file @code{file} +@opindex passphrase-file Read the passphrase from file @code{file}. Only the first line will be read from file @code{file}. This can only be used if only one passphrase is supplied. Obviously, a passphrase stored in a file is @@ -2470,6 +2598,7 @@ has also been given. This is different from @command{gpg}. @end ifclear @item --passphrase @code{string} +@opindex passphrase Use @code{string} as the passphrase. This can only be used if only one passphrase is supplied. Obviously, this is of very questionable security on a multi-user system. Don't use this option if you can @@ -2480,6 +2609,7 @@ has also been given. This is different from @command{gpg}. @end ifclear @item --command-fd @code{n} +@opindex command-fd This is a replacement for the deprecated shared-memory IPC mode. If this option is enabled, user input on questions is not expected from the TTY but from the given file descriptor. It should be used @@ -2487,21 +2617,25 @@ together with @option{--status-fd}. See the file doc/DETAILS in the source distribution for details on how to use it. @item --command-file @code{file} +@opindex command-file Same as @option{--command-fd}, except the commands are read out of file @code{file} @item --allow-non-selfsigned-uid @itemx --no-allow-non-selfsigned-uid +@opindex allow-non-selfsigned-uid Allow the import and use of keys with user IDs which are not self-signed. This is not recommended, as a non self-signed user ID is trivial to forge. @option{--no-allow-non-selfsigned-uid} disables. @item --allow-freeform-uid +@opindex allow-freeform-uid Disable all checks on the form of the user ID while generating a new one. This option should only be used in very special environments as it does not ensure the de-facto standard format of user IDs. @item --ignore-time-conflict +@opindex ignore-time-conflict GnuPG normally checks that the timestamps associated with keys and signatures have plausible values. However, sometimes a signature seems to be older than the key due to clock problems. This option @@ -2509,6 +2643,7 @@ makes these checks just a warning. See also @option{--ignore-valid-from} for timestamp issues on subkeys. @item --ignore-valid-from +@opindex ignore-valid-from GnuPG normally does not select and use subkeys created in the future. This option allows the use of such keys and thus exhibits the pre-1.0.7 behaviour. You should not use this option unless there @@ -2516,6 +2651,7 @@ is some clock problem. See also @option{--ignore-time-conflict} for timestamp issues with signatures. @item --ignore-crc-error +@opindex ignore-crc-error The ASCII armor used by OpenPGP is protected by a CRC checksum against transmission errors. Occasionally the CRC gets mangled somewhere on the transmission channel but the actual content (which is protected by @@ -2523,6 +2659,7 @@ the OpenPGP protocol anyway) is still okay. This option allows GnuPG to ignore CRC errors. @item --ignore-mdc-error +@opindex ignore-mdc-error This option changes a MDC integrity protection failure into a warning. This can be useful if a message is partially corrupt, but it is necessary to get as much data as possible out of the corrupt message. @@ -2530,6 +2667,7 @@ However, be aware that a MDC protection failure may also mean that the message was tampered with intentionally by an attacker. @item --no-default-keyring +@opindex no-default-keyring Do not add the default keyrings to the list of keyrings. Note that GnuPG will not operate without any keyrings, so if you use this option and do not provide alternate keyrings via @option{--keyring} or @@ -2537,15 +2675,18 @@ and do not provide alternate keyrings via @option{--keyring} or secret keyrings. @item --skip-verify +@opindex skip-verify Skip the signature verification step. This may be used to make the decryption faster if the signature verification is not needed. @item --with-key-data +@opindex with-key-data Print key listings delimited by colons (like @option{--with-colons}) and print the public key data. @item --fast-list-mode +@opindex fast-list-mode Changes the output of the list commands to work faster; this is achieved by leaving some parts empty. Some applications don't need the user ID and the trust information given in the listings. By using this options @@ -2554,12 +2695,15 @@ change in future versions. If you are missing some information, don't use this option. @item --no-literal +@opindex no-literal This is not for normal use. Use the source to see for what it might be useful. @item --set-filesize +@opindex set-filesize This is not for normal use. Use the source to see for what it might be useful. @item --show-session-key +@opindex show-session-key Display the session key used for one message. See @option{--override-session-key} for the counterpart of this option. @@ -2570,6 +2714,7 @@ encrypted for one secret key. DON'T USE IT UNLESS YOU ARE REALLY FORCED TO DO SO. @item --override-session-key @code{string} +@opindex override-session-key Don't use the public key but the session key @code{string}. The format of this string is the same as the one printed by @option{--show-session-key}. This option is normally not used but comes @@ -2579,12 +2724,14 @@ secret key. @item --ask-sig-expire @itemx --no-ask-sig-expire +@opindex ask-sig-expire When making a data signature, prompt for an expiration time. If this option is not specified, the expiration time set via @option{--default-sig-expire} is used. @option{--no-ask-sig-expire} disables this option. @item --default-sig-expire +@opindex default-sig-expire The default expiration time to use for signature expiration. Valid values are "0" for no expiration, a number followed by the letter d (for days), w (for weeks), m (for months), or y (for years) (for @@ -2593,12 +2740,14 @@ date in the form YYYY-MM-DD. Defaults to "0". @item --ask-cert-expire @itemx --no-ask-cert-expire +@opindex ask-cert-expire When making a key signature, prompt for an expiration time. If this option is not specified, the expiration time set via @option{--default-cert-expire} is used. @option{--no-ask-cert-expire} disables this option. @item --default-cert-expire +@opindex default-cert-expire The default expiration time to use for key signature expiration. Valid values are "0" for no expiration, a number followed by the letter d (for days), w (for weeks), m (for months), or y (for years) @@ -2606,10 +2755,12 @@ letter d (for days), w (for weeks), m (for months), or y (for years) absolute date in the form YYYY-MM-DD. Defaults to "0". @item --allow-secret-key-import +@opindex allow-secret-key-import This is an obsolete option and is not used anywhere. @item --allow-multiple-messages @item --no-allow-multiple-messages +@opindex allow-multiple-messages Allow processing of multiple OpenPGP messages contained in a single file or stream. Some programs that call GPG are not prepared to deal with multiple messages being processed together, so this option defaults to @@ -2621,14 +2772,17 @@ workaround! @item --enable-special-filenames +@opindex enable-special-filenames This options enables a mode in which filenames of the form @file{-&n}, where n is a non-negative decimal number, refer to the file descriptor n and not to a file with that name. @item --no-expensive-trust-checks +@opindex no-expensive-trust-checks Experimental use only. @item --preserve-permissions +@opindex preserve-permissions Don't change the permissions of a secret keyring back to user read/write only. Use this option only if you really know what you are doing. @@ -2676,6 +2830,7 @@ on the configuration file. @ifset gpgone @item --load-extension @code{name} +@opindex load-extension 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 @@ -2684,6 +2839,7 @@ useful anymore, and the use of this option is deprecated. @item --show-photos @itemx --no-show-photos +@opindex show-photos Causes @option{--list-keys}, @option{--list-sigs}, @option{--list-public-keys}, @option{--list-secret-keys}, and verifying a signature to also display the photo ID attached to the key, if @@ -2692,22 +2848,26 @@ any. See also @option{--photo-viewer}. These options are deprecated. Use [no-]show-photos} instead. @item --show-keyring +@opindex show-keyring Display the keyring name at the head of key listings to show which keyring a given key resides on. This option is deprecated: use @option{--list-options [no-]show-keyring} instead. @ifset gpgone @item --ctapi-driver @code{file} +@opindex ctapi-driver Use @code{file} to access the smartcard reader. The current default is `libtowitoko.so'. Note that the use of this interface is deprecated; it may be removed in future releases. @end ifset @item --always-trust +@opindex always-trust Identical to @option{--trust-model always}. This option is deprecated. @item --show-notation @itemx --no-show-notation +@opindex show-notation Show signature notations in the @option{--list-sigs} or @option{--check-sigs} listings as well as when verifying a signature with a notation in it. These options are deprecated. Use @option{--list-options [no-]show-notation} @@ -2715,6 +2875,7 @@ and/or @option{--verify-options [no-]show-notation} instead. @item --show-policy-url @itemx --no-show-policy-url +@opindex show-policy-url Show policy URLs in the @option{--list-sigs} or @option{--check-sigs} listings as well as when verifying a signature with a policy URL in it. These options are deprecated. Use @option{--list-options @@ -2740,13 +2901,13 @@ current home directory (@pxref{option --homedir}). @table @file -@item gpg.conf -@cindex gpg.conf -This is the standard configuration file read by @command{@gpgname} on -startup. It may contain any valid long option; the leading two dashes -may not be entered and the option may not be abbreviated. This default -name may be changed on the command line (@pxref{option --options}). -You should backup this file. + @item gpg.conf + @cindex gpg.conf + This is the standard configuration file read by @command{@gpgname} on + startup. It may contain any valid long option; the leading two dashes + may not be entered and the option may not be abbreviated. This default + name may be changed on the command line (@pxref{option --options}). + You should backup this file. @end table @@ -2765,33 +2926,33 @@ files; They all live in in the current home directory (@pxref{option @table @file -@item ~/.gnupg/secring.gpg -The secret keyring. You should backup this file. + @item ~/.gnupg/secring.gpg + The secret keyring. You should backup this file. -@item ~/.gnupg/secring.gpg.lock -The lock file for the secret keyring. + @item ~/.gnupg/secring.gpg.lock + The lock file for the secret keyring. -@item ~/.gnupg/pubring.gpg -The public keyring. You should backup this file. + @item ~/.gnupg/pubring.gpg + The public keyring. You should backup this file. -@item ~/.gnupg/pubring.gpg.lock -The lock file for the public keyring. + @item ~/.gnupg/pubring.gpg.lock + The lock file for the public keyring. -@item ~/.gnupg/trustdb.gpg -The trust database. There is no need to backup this file; it is better -to backup the ownertrust values (@pxref{option --export-ownertrust}). + @item ~/.gnupg/trustdb.gpg + The trust database. There is no need to backup this file; it is better + to backup the ownertrust values (@pxref{option --export-ownertrust}). -@item ~/.gnupg/trustdb.gpg.lock -The lock file for the trust database. + @item ~/.gnupg/trustdb.gpg.lock + The lock file for the trust database. -@item ~/.gnupg/random_seed -A file used to preserve the state of the internal random pool. + @item ~/.gnupg/random_seed + A file used to preserve the state of the internal random pool. -@item /usr[/local]/share/gnupg/options.skel -The skeleton options file. + @item /usr[/local]/share/gnupg/options.skel + The skeleton options file. -@item /usr[/local]/lib/gnupg/ -Default location for extensions. + @item /usr[/local]/lib/gnupg/ + Default location for extensions. @end table @@ -2800,41 +2961,42 @@ Operation is further controlled by a few environment variables: @table @asis -@item HOME -Used to locate the default home directory. + @item HOME + Used to locate the default home directory. -@item GNUPGHOME -If set directory used instead of "~/.gnupg". + @item GNUPGHOME + If set directory used instead of "~/.gnupg". -@item GPG_AGENT_INFO -Used to locate the gpg-agent. -@ifset gpgone -This is only honored when @option{--use-agent} is set. -@end ifset -The value consists of 3 colon delimited fields: The first is the path -to the Unix Domain Socket, the second the PID of the gpg-agent and the -protocol version which should be set to 1. When starting the gpg-agent -as described in its documentation, this variable is set to the correct -value. The option @option{--gpg-agent-info} can be used to override it. + @item GPG_AGENT_INFO + Used to locate the gpg-agent. + @ifset gpgone + This is only honored when @option{--use-agent} is set. + @end ifset + The value consists of 3 colon delimited fields: The first is the path + to the Unix Domain Socket, the second the PID of the gpg-agent and the + protocol version which should be set to 1. When starting the gpg-agent + as described in its documentation, this variable is set to the correct + value. The option @option{--gpg-agent-info} can be used to override it. -@item PINENTRY_USER_DATA -This value is passed via gpg-agent to pinentry. It is useful to convey -extra information to a custom pinentry. + @item PINENTRY_USER_DATA + This value is passed via gpg-agent to pinentry. It is useful to convey + extra information to a custom pinentry. -@item COLUMNS -@itemx LINES -Used to size some displays to the full size of the screen. + @item COLUMNS + @itemx LINES + Used to size some displays to the full size of the screen. -@item LANGUAGE -Apart from its use by GNU, it is used in the W32 version to override the -language selection done through the Registry. If used and set to a -valid and available language name (@var{langid}), the file with the -translation is loaded from -@code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}. Here @var{gpgdir} is the -directory out of which the gpg binary has been loaded. If it can't be -loaded the Registry is tried and as last resort the native Windows -locale system is used. + @item LANGUAGE + Apart from its use by GNU, it is used in the W32 version to override the + language selection done through the Registry. If used and set to a + valid and available language name (@var{langid}), the file with the + translation is loaded from + + @code{@var{gpgdir}/gnupg.nls/@var{langid}.mo}. Here @var{gpgdir} is the + directory out of which the gpg binary has been loaded. If it can't be + loaded the Registry is tried and as last resort the native Windows + locale system is used. @end table @@ -2993,28 +3155,28 @@ either read from stdin or given as a file on the command line. The format of the parameter file is as follows: @itemize @bullet -@item Text only, line length is limited to about 1000 characters. -@item UTF-8 encoding must be used to specify non-ASCII characters. -@item Empty lines are ignored. -@item Leading and trailing while space is ignored. -@item A hash sign as the first non white space character indicates -a comment line. -@item Control statements are indicated by a leading percent sign, the -arguments are separated by white space from the keyword. -@item Parameters are specified by a keyword, followed by a colon. Arguments -are separated by white space. -@item -The first parameter must be @samp{Key-Type}; control statements may be -placed anywhere. -@item -The order of the parameters does not matter except for @samp{Key-Type} -which must be the first parameter. The parameters are only used for -the generated keyblock (primary and subkeys); parameters from previous -sets are not used. Some syntactically checks may be performed. -@item -Key generation takes place when either the end of the parameter file -is reached, the next @samp{Key-Type} parameter is encountered or at the -control statement @samp{%commit} is encountered. + @item Text only, line length is limited to about 1000 characters. + @item UTF-8 encoding must be used to specify non-ASCII characters. + @item Empty lines are ignored. + @item Leading and trailing while space is ignored. + @item A hash sign as the first non white space character indicates + a comment line. + @item Control statements are indicated by a leading percent sign, the + arguments are separated by white space from the keyword. + @item Parameters are specified by a keyword, followed by a colon. Arguments + are separated by white space. + @item + The first parameter must be @samp{Key-Type}; control statements may be + placed anywhere. + @item + The order of the parameters does not matter except for @samp{Key-Type} + which must be the first parameter. The parameters are only used for + the generated keyblock (primary and subkeys); parameters from previous + sets are not used. Some syntactically checks may be performed. + @item + Key generation takes place when either the end of the parameter file + is reached, the next @samp{Key-Type} parameter is encountered or at the + control statement @samp{%commit} is encountered. @end itemize @noindent diff --git a/doc/gpgsm.texi b/doc/gpgsm.texi index 0de3daf4d..7bfbc9dc6 100644 --- a/doc/gpgsm.texi +++ b/doc/gpgsm.texi @@ -479,7 +479,6 @@ for a reason. @item --armor @itemx -a @opindex armor -@opindex -a Create PEM encoded output. Default is binary output. @item --base64 @@ -523,7 +522,6 @@ set; however @option{--default-key} always overrides this. @item --local-user @var{user_id} @item -u @var{user_id} @opindex local-user -@opindex -u Set the user(s) to be used for signing. The default is the first secret key found in the database. diff --git a/doc/tools.texi b/doc/tools.texi index f530c1ed1..5e9a02487 100644 --- a/doc/tools.texi +++ b/doc/tools.texi @@ -1193,7 +1193,6 @@ Specify the agent program to be started if none is running. @item -S @itemx --raw-socket @var{name} -@opindex S @opindex raw-socket Connect to socket @var{name} assuming this is an Assuan style server. Do not run any special initializations or environment checks. This may