diff options
author | Werner Koch <wk@gnupg.org> | 2003-05-27 10:38:58 +0200 |
---|---|---|
committer | Werner Koch <wk@gnupg.org> | 2003-05-27 10:38:58 +0200 |
commit | 41bfaa5e513bf70632cce8eefc743d7bbbde0b3e (patch) | |
tree | cc2c2451a505994f9f2bb1614026e0e62f3b43d3 /doc/gpg.texi | |
parent | * NEWS: Document --gnupg and the deprecation of --no-openpgp and (diff) | |
download | gnupg2-41bfaa5e513bf70632cce8eefc743d7bbbde0b3e.tar.xz gnupg2-41bfaa5e513bf70632cce8eefc743d7bbbde0b3e.zip |
About to release 1.3.2V1-3-2
Diffstat (limited to 'doc/gpg.texi')
-rw-r--r-- | doc/gpg.texi | 596 |
1 files changed, 371 insertions, 225 deletions
diff --git a/doc/gpg.texi b/doc/gpg.texi index 88cf053f1..038c5dbf1 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -18,7 +18,7 @@ @end menu @majorheading Name -gpg ---- encryption and signing tool +gpg ---- encryption and signing tool</> @majorheading Synopsis @@ -51,8 +51,9 @@ Make a detached signature. Encrypt data. This option may be combined with ---sign. @item -c, ---symmetric -Encrypt with symmetric cipher only. -This command asks for a passphrase. +Encrypt with a symmetric cipher using a passphrase. The default +symmetric cipher used is CAST5, but may be chosen with the +---cipher-algo option. @item ---store Store only (make a simple RFC1991 packet). @@ -104,8 +105,10 @@ List all keys from the public keyrings, or just the ones given on the command line. @item ---list-secret-keys @code{names} -List all keys from the secret keyrings, or just the -ones given on the command line. +List all keys from the secret keyrings, or just the ones given on the +command line. A '#' after the letters 'sec' means that the secret key +is not usable (for example, if it was created via +---export-secret-subkeys). @item ---list-sigs @code{names} Same as ---list-keys, but the signatures are listed too. @@ -163,11 +166,16 @@ Combines the functionality of nrsign and lsign to make a signature that is both non-revocable and non-exportable. +@item 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 revsig -Revoke a signature. GnuPG asks for every -signature which has been done by one of -the secret keys, whether a revocation -certificate should be generated. +Revoke a signature. For every signature which has been generated by +one of the secret keys, GnuPG asks whether a revocation certificate +should be generated. @item trust Change the owner trust value. This updates the @@ -175,18 +183,22 @@ trust-db immediately and no save is required. @item disable @itemx enable -Disable or enable an entire key. A disabled key can normally not be used -for encryption. +Disable or enable an entire key. A disabled key can not normally be +used for encryption. @item adduid Create an alternate user id. @item addphoto -Create a photographic user id. +Create a photographic user id. This will prompt for a JPEG file that +will be embedded into the user ID. @item deluid Delete a user id. +@item revuid +Revoke a user id. + @item addkey Add a subkey to this key. @@ -203,10 +215,9 @@ export-options). Revoke a subkey. @item expire -Change the key expiration time. If a key is -selected, the time of this key will be changed. -With no selection the key expiration of the -primary key is changed. +Change the key expiration time. If a subkey is selected, the +expiration time of this subkey will be changed. With no selection, +the key expiration of the primary key is changed. @item passwd Change the passphrase of the secret key. @@ -248,7 +259,7 @@ are not already included in the preference list. Set the list of user ID preferences to @code{string}, this should be a string similar to the one printed by "pref". Using an empty string will set the default preference string, using "none" will set the -preferences to nil. Use "gpg -v ---version" to get a list of available +preferences to nil. Use "gpg ---version" to get a list of available algorithms. This command just initializes an internal list and does not change anything unless another command (such as "updpref") which changes the self-signatures is used. @@ -337,7 +348,7 @@ a subkey or a signature, use the ---edit command. @item ---desig-revoke Generate a designated revocation certificate for a key. This allows a -user (with the permission of the keyholder) to revoke someone elses +user (with the permission of the keyholder) to revoke someone else's key. @item ---export @code{names} @@ -383,35 +394,42 @@ but does only the merging of new signatures, user-IDs and subkeys. Import the keys with the given key IDs from a keyserver. Option ---keyserver must be used to give the name of this keyserver. +@item ---refresh-keys @code{key IDs} +Request updates from a keyserver for keys that already exist on the +local keyring. This is useful for updating a key with the latest +signatures, user IDs, etc. Option ---keyserver must be used to give +the name of this keyserver. + @item ---search-keys @code{names} Search the keyserver for the given names. Multiple names given here will be joined together to create the search string for the keyserver. Option ---keyserver must be used to give the name of this keyserver. @item ---update-trustdb -Do trust DB maintenance. This command goes over all keys and builds -the Web-of-Trust. This is an interactive command because it may has to -ask for the "ownertrust" values of keys. The user has to give an -estimation in how far she trusts the owner of the displayed key to -correctly certify (sign) other keys. It does only ask for that value -if it has not yet been assigned to a key. Using the edit menu, that -value can be changed at any time later. +Do trust database maintenance. This command iterates over all keys +and builds the Web-of-Trust. This is an interactive command because it +may have to ask for the "ownertrust" values for keys. The user has to +give an estimation of how far she trusts the owner of the displayed +key to correctly certify (sign) other keys. GnuPG only asks for the +ownertrust value if it has not yet been assigned to a key. Using the +---edit-key menu, the assigned value can be changed at any time. @item ---check-trustdb -Do trust DB maintenance without user interaction. Form time to time -the trust database must be updated so that expired keys and resulting -changes in the Web-of-Trust can be tracked. GnuPG tries to figure -when this is required and then does it implicitly; this command can be -used to force such a check. The processing is identically to that of ----update-trustdb but it skips keys with a not yet defined "ownertrust". +Do trust database maintenance without user interaction. From time to +time the trust database must be updated so that expired keys or +signatures and the resulting changes in the Web-of-Trust can be +tracked. Normally, GnuPG will calculate when this is required and do +it automatically unless ---no-auto-check-trustdb is set. This command +can be used to force a trust database check at any time. The +processing is identical to that of ---update-trustdb but it skips keys +with a not yet defined "ownertrust". For use with cron jobs, this command can be used together with ---batch -in which case the check is only done when it is due. To force a run -even in batch mode add the option ---yes. +in which case the trust database check is done only if a check is +needed. To force a run even in batch mode add the option ---yes. -@item ---export-ownertrust @code{file} -Store the ownertrust values into -@code{file} (or stdin if not given). This is useful for backup +@item ---export-ownertrust +Send the ownertrust values to stdout. This is useful for backup purposes as these values are the only ones which can't be re-created from a corrupted trust DB. @@ -420,6 +438,11 @@ Update the trustdb with the ownertrust values stored in @code{files} (or stdin if not given); existing values will be overwritten. +@item ---rebuild-keydb-caches +When updating from version 1.0.6 to 1.0.7 this command should be used +to create signature caches in the keyring. It might be handy in other +situations too. + @item ---print-md @code{algo} @code{files} @itemx ---print-mds @code{files} Print message digest of algorithm ALGO for all given files or stdin. @@ -443,8 +466,8 @@ of supported algorithms. Print warranty information. @item -h, ---help -Print usage information. This is a really long list even though it doesn't list -all options. +Print usage information. This is a really long list even though it +doesn't list all options. For every option, consult this manual. @end table @@ -455,7 +478,8 @@ Long options can be put in an options file (default not write the 2 dashes, but simply the name of the option and any required arguments. Lines with a hash ('#') as the first non-white-space character are ignored. Commands may be put in this -file too, but that does not make sense. +file too, but that is not generally useful as the command will execute +automatically with every execution of gpg. @code{gpg} recognizes these options: @@ -466,6 +490,15 @@ Create ASCII armored output. @item -o, ---output @code{file} Write output to @code{file}. +@item ---mangle-dos-filenames +@itemx ---no-mangle-dos-filenames +The Windows version of GnuPG replaces the extension of an output +filename to avoid problems with filenames containing more than one +dot. This is not necessary for newer Windows versions and so +---no-mangle-dos-filenames can be used to switch this feature off and +have GnuPG append the new extension. This option has no effect on +non-Windows platforms. + @item -u, ---local-user @code{name} Use @code{name} as the user ID to sign. This option is silently ignored for the list commands, @@ -478,8 +511,17 @@ found in the secret keyring. @item -r, ---recipient @code{name} @itemx -Encrypt for user id @code{name}. If this option is not -specified, GnuPG asks for the user-id unless ---default-recipient is given +Encrypt for user id @code{name}. If this option or ---hidden-recipient +is not specified, GnuPG asks for the user-id unless +---default-recipient is given. + +@item -R, ---hidden-recipient @code{name} +@itemx +Encrypt for user id @code{name}, but hide the keyid of the key. This +option hides the receiver of the message and is a countermeasure +against traffic analysis. If this option or ---recipient is not +specified, GnuPG asks for the user-id unless ---default-recipient is +given. @item ---default-recipient @code{name} Use @code{name} as default recipient if option ---recipient is not used and @@ -502,8 +544,16 @@ either by use of ---recipient or by the asked user id. No trust checking is performed for these user ids and even disabled keys can be used. +@item ---hidden-encrypt-to @code{name} +Same as ---hidden-recipient but this one is intended for use in the +options file and may be used with your own user-id as a hidden +"encrypt-to-self". These keys are only used when there are other +recipients given either by use of ---recipient or by the asked user id. +No trust checking is performed for these user ids and even disabled +keys can be used. + @item ---no-encrypt-to -Disable the use of all ---encrypt-to keys. +Disable the use of all ---encrypt-to and --hidden-encrypt-to keys. @item -v, ---verbose Give more information during processing. If used @@ -518,12 +568,12 @@ disables compression. Default is to use the default compression level of zlib (normally 6). @item -t, ---textmode -Use canonical text mode. If -t (but not ----textmode) is used together with armoring -and signing, this enables clearsigned messages. -This kludge is needed for PGP compatibility; -normally you would use ---sign or --clearsign -to selected the type of the signature. +@itemx ---no-textmode +Use canonical text mode. ---no-textmode disables this option. If -t +(but not ---textmode) is used together with armoring and signing, this +enables clearsigned messages. This kludge is needed for command-line +compatibility with command-line versions of PGP; normally you would +use ---sign or --clearsign to select the type of the signature. @item -n, ---dry-run Don't make any changes (this is not completely implemented). @@ -532,18 +582,15 @@ Don't make any changes (this is not completely implemented). Prompt before overwriting any files. @item ---batch -Use batch mode. Never ask, do not allow interactive -commands. +@itemx ---no-batch +Use batch mode. Never ask, do not allow interactive commands. +---no-batch disables this option. @item ---no-tty Make sure that the TTY (terminal) is never used for any output. This option is needed in some cases because GnuPG sometimes prints warnings to the TTY if ---batch is used. -@item ---no-batch -Disable batch mode. This may be of use if ---batch -is enabled from an options file. - @item ---yes Assume "yes" on most questions. @@ -587,12 +634,28 @@ don't want to keep your secret keys (or one of them) online but still want to be able to check the validity of a given recipient's or signator's key. +@item ---trust-model @code{pgp|classic|always} +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. + +@item classic +This is the standard web-of-trust as used in PGP 2.x and earlier. + +@item always +Skip key validation and assume that used keys are always fully +trusted. You won't use this unless you have installed some external +validation scheme. This option also suppresses the "[uncertain]" tag +printed with signature checks when there is no evidence that the user +ID is bound to the key. + +@end table + @item ---always-trust -Skip key validation and assume that used keys are always fully trusted. -You won't use this unless you have installed some external validation -scheme. This option also suppresses the "[uncertain]" tag printed -with signature checks when there is no evidence that the user ID -is bound to the key. +Identical to `---trust-model always' @item ---keyserver @code{name} Use @code{name} as your keyserver. This is the server that ---recv-keys, @@ -602,7 +665,8 @@ from, send keys to, and search for keys on. The format of the the type of keyserver: "hkp" for the Horowitz (or compatible) keyservers, "ldap" for the NAI LDAP keyserver, or "mailto" for the Horowitz email keyserver. Note that your particular installation of -GnuPG may have other keyserver types available as well. +GnuPG may have other keyserver types available as well. Keyserver +schemes are case-insensitive. Most keyservers synchronize with each other, so there is generally no need to send keys to more than one server. Using the command "host -l @@ -621,21 +685,19 @@ keyserver types, some common options are: @table @asis @item include-revoked -When searching for a key, include keys that are marked on the -keyserver as revoked. Note that this option is always set when using -the NAI HKP keyserver, as this keyserver does not differentiate -between revoked and unrevoked keys. When using the LDAP keyserver, -this applies to both searching (---search-keys) and receiving -(---recv-keys). +When searching for a key with ---search-keys, include keys that are +marked on the keyserver as revoked. Note that this option is always +set when using the NAI HKP keyserver, as this keyserver does not +differentiate between revoked and unrevoked keys. @item include-disabled -When receiving or searching for a key, include keys that are marked on -the keyserver as disabled. Note that this option is not used with HKP -keyservers, as they do not support disabling keys. +When searching for a key with ---search-keys, include keys that are +marked on the keyserver as disabled. Note that this option is not +used with HKP keyservers. @item include-subkeys -When receiving a key, include subkeys in the search. Note that this -option is not used with HKP keyservers, as they do not support +When receiving a key, include subkeys as potential targets. Note that +this option is not used with HKP keyservers, as they do not support retrieving keys by subkey id. @item use-temp-files @@ -676,10 +738,11 @@ 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-hkp-subkey-bug -During import, attempt to repair the HKP keyserver mangling multiple -subkeys bug. Note that this cannot completely repair the damaged key -as some crucial data is removed by the keyserver, but it does at least +@item repair-pks-subkey-bug +During import, attempt to repair the damage caused by the PKS +keyserver bug (pre version 0.9.6) that mangles keys with multiple +subkeys. Note that this cannot completely repair the damaged key as +some crucial data is removed by the keyserver, but it does at least give you back one subkey. Defaults to no for regular ---import and to yes for keyserver ---recv-keys. @@ -711,13 +774,11 @@ Include designated revoker information that was marked as @end table @item ---show-photos +@itemx ---no-show-photos Causes ---list-keys, --list-sigs, --list-public-keys, ---list-secret-keys, and verifying a signature to also display the -photo ID attached to the key, if any. -See also ---photo-viewer. - -@item ---no-show-photos -Resets the ---show-photos flag. +photo ID attached to the key, if any. See also ---photo-viewer. +---no-show-photos disables this option. @item ---photo-viewer @code{string} This is the command line that should be run to view a photo ID. "%i" @@ -745,12 +806,11 @@ useful when you're listing a specific key or set of keys. It has no effect when listing all keys. @item ---keyring @code{file} -Add @code{file} to the 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 -home-directory ("~/.gnupg" if ---homedir is not used). -The filename may be prefixed with a scheme: +Add @code{file} to the list of keyrings. If @code{file} begins with a +tilde and a slash, these are replaced by the HOME directory. If the +filename does not contain a slash, it is assumed to be in the GnuPG +home directory ("~/.gnupg" if ---homedir is not used). The filename +may be prefixed with a scheme: "gnupg-ring:" is the default one. @@ -759,6 +819,17 @@ It might make sense to use it together with ---no-default-keyring. @item ---secret-keyring @code{file} Same as ---keyring but for the secret keyrings. +@item ---primary-keyring @code{file} +Designate @code{file} as the primary public keyring. This means that +newly imported keys (via ---import or keyserver --recv-from) will go to +this keyring. + +@item ---trustdb-name @code{file} +Use @code{file} instead of the default trustdb. If @code{file} begins +with a tilde and a slash, these are replaced by the HOME directory. If +the filename does not contain a slash, it is assumed to be in the +GnuPG home directory ("~/.gnupg" if ---homedir is not used). + @item ---homedir @code{directory} Set the name of the home directory to @code{directory} If this option is not used it defaults to "~/.gnupg". It does @@ -812,10 +883,10 @@ Using this option will also prevent the creation of a "~./gnupg" homedir. @item ---load-extension @code{name} -Load an extension module. If @code{name} does not -contain a slash it is searched in "/usr/local/lib/gnupg" -Extension are in gernal not useful anymore; the use of this -option is deprecated. +Load an extension module. If @code{name} does not contain a slash it is +searched for in the directory configured when GnuPG was built +(generally "/usr/local/lib/gnupg"). Extensions are not generally +useful anymore, and the use of this option is deprecated. @item ---debug @code{flags} Set debugging flags. All flags are or-ed and @code{flags} may @@ -824,6 +895,11 @@ be given in C syntax (e.g. 0x0042). @item ---debug-all Set all useful debugging flags. +@item ---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} Write special status strings to the file descriptor @code{n}. See the file DETAILS in the documentation for a listing of them. @@ -838,20 +914,20 @@ needed to separate out the various subpackets from the stream delivered to the file descriptor. @item ---sk-comments +@itemx ---no-sk-comments Include secret key comment packets when exporting secret keys. This is a GnuPG extension to the OpenPGP standard, and is off by default. Please note that this has nothing to do with the comments in clear -text signatures or armor headers. - -@item ---no-sk-comments -Resets the ---sk-comments option. +text signatures or armor headers. ---no-sk-comments disables this +option. @item ---no-comment -See ---sk-comments. This option is deprecated and may be removed soon. +See ---no-sk-comments. This option is deprecated and may be removed +soon. @item ---comment @code{string} -Use @code{string} as comment string in clear text signatures. -The default is not do write a comment string. +Use @code{string} as the comment string in clear text signatures. The +default behavior is not to use a comment string. @item ---default-comment Force to write the standard comment string in clear @@ -859,55 +935,69 @@ text signatures. Use this to overwrite a ---comment from a config file. This option is now obsolete because there is no default comment string anymore. -@item ---no-version -Omit the version string in clear text signatures. - @item ---emit-version -Force to write the version string in clear text -signatures. Use this to overwrite a previous ----no-version from a config file. +@itemx ---no-emit-version +Force inclusion of the version string in ASCII armored output. +---no-emit-version disables this option. -@item -N, ---notation-data @code{name=value} +@item ---sig-notation @code{name=value} +@itemx ---cert-notation @code{name=value} +@itemx -N, ---notation-data @code{name=value} Put the name value pair into the signature as notation data. -@code{name} must consist only of alphanumeric characters, digits -or the underscore; the first character must not be a digit. -@code{value} may be any printable string; it will be encoded in UTF8, -so you should check that your ---charset is set correctly. -If you prefix @code{name} with an exclamation mark, the notation -data will be flagged as critical (rfc2440:5.2.3.15). +@code{name} must consist only of printable characters or spaces, and +must contain a '@@' character. This is to help prevent pollution of +the IETF reserved notation namespace. The ---expert flag overrides the +'@@' check. @code{value} may be any printable string; it will be +encoded in UTF8, so you should check that your ---charset is set +correctly. If you prefix @code{name} with an exclamation mark, the +notation data will be flagged as critical (rfc2440:5.2.3.15). +---sig-notation sets a notation for data signatures. --cert-notation +sets a notation for key signatures (certifications). ---notation-data +sets both. + +There are special codes that may be used in notation names. "%k" will +be expanded into the key ID of the key being signed, "%K" for the long +key ID of the key being signed, "%f" for the key fingerprint of the +key being signed, "%s" for the key ID of the key making the signature, +"%S" for the long key ID of the key making the signature, and "%%" +results in a single "%". %k, %K, and %f are only meaningful when +making a key signature (certification). @item ---show-notation -Show key signature notations in the ---list-sigs or --check-sigs -listings. - -@item ---no-show-notation -Do not show key signature notations in the ---list-sigs or --check-sigs -listings. - -@item ---set-policy-url @code{string} -Use @code{string} as Policy URL for signatures (rfc2440:5.2.3.19). -If you prefix it with an exclamation mark, the policy URL -packet will be flagged as critical. +@itemx ---no-show-notation +Show signature notations in the ---list-sigs or --check-sigs listings +as well as when verifying a signature with a notation in it. +---no-show-notation disables this option. + +@item ---sig-policy-url @code{string} +@itemx ---cert-policy-url @code{string} +@itemx ---set-policy-url @code{string} +Use @code{string} as Policy URL for signatures (rfc2440:5.2.3.19). If +you prefix it with an exclamation mark, the policy URL packet will be +flagged as critical. ---sig-policy-url sets a a policy url for data +signatures. ---cert-policy-url sets a policy url for key signatures +(certifications). ---set-policy-url sets both. + +The same %-expandos used for notation data are available here as well. @item ---show-policy-url -Show any policy URLs set in the ---list-sigs or --check-sigs listings. - -@item ---no-show-policy-url -Do not show any policy URLs set in the ---list-sigs or --check-sigs -listings. +@itemx ---no-show-policy-url +Show policy URLs in the ---list-sigs or --check-sigs listings as well +as when verifying a signature with a policy URL in it. +---no-show-policy-url disables this option. @item ---set-filename @code{string} -Use @code{string} as the name of file which is stored in -messages. +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 Set the `for your eyes only' flag in the message. This causes GnuPG to refuse to save the file unless the ---output option is given, and PGP to use the "secure viewer" with a Tempest-resistant font to display the message. This option overrides ---set-filename. - -@item ---no-for-your-eyes-only -Resets the ---for-your-eyes-only flag. +---no-for-your-eyes-only disables this option. @item ---use-embedded-filename Try to create a file with a name as embedded in the data. @@ -934,6 +1024,16 @@ selected from the preferences stored with the key. Use @code{name} as the message digest algorithm. Running the program with the command ---version yields a list of supported algorithms. +@item ---compress-algo @code{name} +Use compression algorithm @code{name}. "zlib" is RFC1950 ZLIB +compression. "zip" is RFC-1951 ZIP compression which is used by PGP. +"uncompressed" or "none" disables compression. If this option is not +used, the default behavior is to examine the recipient key preferences +to see which algorithms the recipient supports. If all else fails, +ZIP is used for maximum compatibility. Note, however, that ZLIB may +give better compression results if that is more important, as the +compression window size is not limited to 8k. + @item ---cert-digest-algo @code{name} Use @code{name} as the message digest algorithm used when signing a key. Running the program with the command ---version yields a list of @@ -945,21 +1045,19 @@ possibly your entire key. @item ---s2k-cipher-algo @code{name} Use @code{name} as the cipher algorithm used to protect secret keys. The default cipher is CAST5. This cipher is also used for -conventional encryption if ---cipher-algo is not given. +conventional encryption if ---personal-cipher-preferences and +---cipher-algo is not given. @item ---s2k-digest-algo @code{name} -Use @code{name} as the digest algorithm used to mangle the -passphrases. The default algorithm is RIPE-MD-160. -This digest algorithm is also used for conventional -encryption if ---digest-algo is not given. +Use @code{name} as the digest algorithm used to mangle the passphrases. +The default algorithm is SHA-1. @item ---s2k-mode @code{n} -Selects how passphrases are mangled. If @code{n} is 0 -a plain passphrase (which is not recommended) will be used, -a 1 (default) adds a salt to the passphrase and -a 3 iterates the whole process a couple of times. -Unless ---rfc1991 is used, this mode is also used -for conventional encryption. +Selects how passphrases are mangled. If @code{n} is 0 a plain +passphrase (which is not recommended) will be used, a 1 adds a salt to +the passphrase and a 3 (the default) iterates the whole process a +couple of times. Unless ---rfc1991 is used, this mode is also used for +conventional encryption. @item ---simple-sk-checksum Secret keys are integrity protected by using a SHA-1 checksum. This @@ -972,15 +1070,6 @@ when the secret key is encrypted - the simplest way to make this happen is to change the passphrase on the key (even changing it to the same value is acceptable). -@item ---compress-algo @code{n} -Use compression algorithm @code{n}. Default is 2 which is RFC1950 -compression. You may use 1 to use the old zlib version (RFC1951) which -is used by PGP. 0 disables compression. The default algorithm may give -better results because the window size is not limited to 8K. If this -is not used the OpenPGP behavior is used, i.e. the compression -algorithm is selected from the preferences; note, that this can't be -done if you do not encrypt the data. - @item ---disable-cipher-algo @code{name} Never allow the use of @code{name} as cipher algorithm. The given name will not be checked so that a later loaded algorithm @@ -1008,18 +1097,20 @@ However, due to the fact that the signature creation needs manual interaction, this performance penalty does not matter in most settings. @item ---auto-check-trustdb +@itemx ---no-auto-check-trustdb If GnuPG feels that its information about the Web-of-Trust has to be -updated, it automatically runs the ---check-trustdb command -internally. This may be a time consuming process. - -@item ---no-auto-check-trustdb -Resets the ---auto-check-trustdb option. +updated, it automatically runs the ---check-trustdb command internally. +This may be a time consuming process. ---no-auto-check-trustdb +disables this option. @item ---throw-keyid -Do not put the keyid into encrypted packets. This option -hides the receiver of the message and is a countermeasure -against traffic analysis. It may slow down the decryption -process because all available secret keys are tried. +Do not put the keyids into encrypted packets. This option hides the +receiver of the message and is a countermeasure against traffic +analysis. It may slow down the decryption process because all +available secret keys are tried. + +@item ---no-throw-keyid +Resets the ---throw-keyid option. @item ---not-dash-escaped This option changes the behavior of cleartext signatures @@ -1031,11 +1122,12 @@ line, patch files don't have this. A special armor header line tells GnuPG about this cleartext signature option. @item ---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. All other PGP -versions do it this way too. This option is not enabled -by default because it would violate rfc2440. +@itemx ---no-escape-from-lines +Because some mailers change lines starting with "From " to ">From +" it is good to handle such lines in a special way when creating +cleartext signatures to prevent the mail system from breaking the +signature. Note that all other PGP versions do it this way too. +Enabled by default. ---no-escape-from-lines disables this option. @item ---passphrase-fd @code{n} Read the passphrase from file descriptor @code{n}. If you use @@ -1051,16 +1143,40 @@ together with ---status-fd. See the file doc/DETAILS in the source distribution for details on how to use it. @item ---use-agent +@itemx ---no-use-agent Try to use the GnuPG-Agent. Please note that this agent is still under development. With this option, GnuPG first tries to connect to the -agent before it asks for a passphrase. +agent before it asks for a passphrase. ---no-use-agent disables this +option. @item ---gpg-agent-info Override the value of the environment variable @samp{GPG_AGENT_INFO}. This is only used when ---use-agent has been given +@item Compliance options +These options control what GnuPG is compliant to. Only one of these +options may be active at a time. Note that the default setting of +this is nearly always the correct one. See the INTEROPERABILITY WITH +OTHER OPENPGP PROGRAMS section below before using one of these +options. + +@table @asis +@item ---gnupg +Use standard GnuPG behavior. This is essentially OpenPGP behavior +(see ---openpgp), but with some additional workarounds for common +compatibility problems in different versions of PGP. This is the +default option, so it is not generally needed, but it may be useful to +override a different compliance option in the gpg.conf file. + +@item ---openpgp +Reset all packet, cipher and digest options to strict OpenPGP +behavior. Use this option to reset all previous options like +---rfc1991, --force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and +---compress-algo to OpenPGP compliant values. All PGP workarounds are +disabled. + @item ---rfc1991 -Try to be more RFC1991 (PGP 2.x) compliant. +Try to be more RFC-1991 (PGP 2.x) compliant. @item ---pgp2 Set up all options to be as PGP 2.x compliant as possible, and warn if @@ -1069,27 +1185,22 @@ a message that PGP 2.x will not be able to handle. Note that `PGP 2.x' here means `MIT PGP 2.6.2'. There are other versions of PGP 2.x available, but the MIT release is a good common baseline. -This option implies `---rfc1991 --no-openpgp --disable-mdc ----no-force-v4-certs --no-comment --escape-from-lines --force-v3-sigs +This option implies `---rfc1991 --disable-mdc --no-force-v4-certs +---no-sk-comment --escape-from-lines --force-v3-sigs ---no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA ----digest-algo MD5 --compress-algo 1' - -@item ---no-pgp2 -Resets the ---pgp2 option. +---digest-algo MD5 --compress-algo 1'. It also disables --textmode +when encrypting. @item ---pgp6 Set up all options to be as PGP 6 compliant as possible. This restricts you to the ciphers IDEA (if the IDEA plugin is installed), 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160, and the -compression algorithms none and ZIP. This also disables making -signatures with signing subkeys as PGP 6 does not understand -signatures made by signing subkeys. +compression algorithms none and ZIP. This also disables +---throw-keyid, and making signatures with signing subkeys as PGP 6 +does not understand signatures made by signing subkeys. -This option implies `---disable-mdc --no-comment --escape-from-lines ----force-v3-sigs --no-ask-sig-expire --compress-algo 1' - -@item ---no-pgp6 -Resets the ---pgp6 option. +This option implies `---disable-mdc --no-sk-comment --escape-from-lines +---force-v3-sigs --no-ask-sig-expire' @item ---pgp7 Set up all options to be as PGP 7 compliant as possible. This is @@ -1097,45 +1208,46 @@ identical to ---pgp6 except that MDCs are not disabled, and the list of allowable ciphers is expanded to add AES128, AES192, AES256, and TWOFISH. -@item ---no-pgp7 -Resets the ---pgp7 option. +@item ---pgp8 +Set up all options to be as PGP 8 compliant as possible. PGP 8 is a +lot closer to the OpenPGP standard than previous versions of PGP, so +all this does is disable ---throw-keyid and set --escape-from-lines. +The allowed algorithms list is the same as ---pgp7 with the addition of +the SHA-256 digest algorithm. -@item ---openpgp -Reset all packet, cipher and digest options to OpenPGP behavior. Use -this option to reset all previous options like ---rfc1991, ----force-v3-sigs, --s2k-*, --cipher-algo, --digest-algo and ----compress-algo to OpenPGP compliant values. All PGP workarounds are -also disabled. +@end table @item ---force-v3-sigs +@itemx ---no-force-v3-sigs OpenPGP states that an implementation should generate v4 signatures but PGP versions 5 and higher only recognize v4 signatures on key material. This option forces v3 signatures for signatures on data. Note that this option overrides ---ask-sig-expire, as v3 signatures -cannot have expiration dates. - -@item ---no-force-v3-sigs -Reset the ---force-v3-sigs option. +cannot have expiration dates. ---no-force-v3-sigs disables this +option. @item ---force-v4-certs +@itemx ---no-force-v4-certs Always use v4 key signatures even on v3 keys. This option also changes the default hash algorithm for v3 RSA keys from MD5 to SHA-1. - -@item ---no-force-v4-certs -Reset the ---force-v4-certs option. +---no-force-v4-certs disables this option. @item ---force-mdc -Force the use of encryption with appended manipulation code. This is -always used with the newer ciphers (those with a blocksize greater -than 64 bit). +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 +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 ---allow-non-selfsigned-uid +@itemx ---no-allow-non-selfsigned-uid Allow the import and use of keys with user IDs which are not self-signed. This is not recommended, as a non self-signed user ID is -trivial to forge. - -@item ---no-allow-non-selfsigned-uid -Reset the ---allow-non-selfsigned-uid option. +trivial to forge. ---no-allow-non-selfsigned-uid disables. @item ---allow-freeform-uid Disable all checks on the form of the user ID while generating a new @@ -1195,14 +1307,17 @@ slower random generation. Reset verbose level to 0. @item ---no-greeting -Suppress the initial copyright message but do not -enter batch mode. +Suppress the initial copyright message. @item ---no-secmem-warning Suppress the warning about "using insecure memory". @item ---no-permission-warning -Suppress the warning about unsafe file permissions. +Suppress the warning about unsafe file permissions. Note that the +file permission checks that GnuPG performs are not intended to be +authoritative, rather they simply warn about certain common permission +problems. Do not assume that the lack of a warning means that your +system is secure. @item ---no-mdc-warning Suppress the warning about missing MDC integrity protection. @@ -1238,8 +1353,8 @@ can get a faster listing. The exact behaviour of this option may change in future versions. @item ---fixed-list-mode -Do not merge user ID and primary key in ---with-colon listing mode and -print all timestamps as seconds since 1970-01-01. +Do not merge primary user ID and primary key in ---with-colon listing +mode and print all timestamps as seconds since 1970-01-01. @item ---list-only Changes the behaviour of some commands. This is like ---dry-run but @@ -1276,30 +1391,26 @@ content of an encrypted message; using this option you can do this without handing out the secret key. @item ---ask-sig-expire +@itemx ---no-ask-sig-expire When making a data signature, prompt for an expiration time. If this option is not specified, the expiration time is "never". - -@item ---no-ask-sig-expire -Resets the ---ask-sig-expire option. +---no-ask-sig-expire disables this option. @item ---ask-cert-expire +@itemx ---no-ask-cert-expire When making a key signature, prompt for an expiration time. If this option is not specified, the expiration time is "never". - -@item ---no-ask-cert-expire -Resets the ---ask-cert-expire option. +---no-ask-cert-expire disables this option. @item ---expert +@itemx ---no-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 deprecated key types. This also disables certain warning messages about potentially incompatible actions. As the name implies, this option is for experts only. If you don't fully understand the implications of what it allows you to do, leave this -off. - -@item ---no-expert -Resets the ---expert option. +off. ---no-expert disables this option. @item ---merge-only Don't insert new keys into the keyrings while doing an import. @@ -1323,12 +1434,16 @@ Experimental use only. @item ---group @code{name=value1 value2 value3 ...} Sets up a named group, which is similar to aliases in email programs. -Any time the group name is a receipient (-r or ---recipient), it will +Any time the group name is a recipient (-r or ---recipient), it will be expanded to the values specified. + The values are @code{key IDs} or fingerprints, but any key description is accepted. Note that a value with spaces in it will be treated as two different values. Note also there is only one level of expansion -- you cannot make an group that points to another group. +- you cannot make an group that points to another group. When used +from the command line, it may be necessary to quote the argument to +this option to prevent the shell from treating it as multiple +arguments. @item ---preserve-permissions Don't change the permissions of a secret keyring back to user @@ -1339,19 +1454,24 @@ Set the list of personal cipher preferences to @code{string}, this list should be a string similar to the one printed by the command "pref" in the edit menu. This allows the user to factor in their own preferred algorithms when algorithms are chosen via recipient key preferences. +The most highly ranked cipher in this list is also used for the +---symmetric encryption command. @item ---personal-digest-preferences @code{string} Set the list of personal digest preferences to @code{string}, this list should be a string similar to the one printed by the command "pref" in the edit menu. This allows the user to factor in their own preferred algorithms when algorithms are chosen via recipient key preferences. +The most highly ranked digest algorithm in this list is algo used when +signing without encryption (e.g. ---clearsign or --sign). @item ---personal-compress-preferences @code{string} Set the list of personal compression preferences to @code{string}, this list should be a string similar to the one printed by the command "pref" in the edit menu. This allows the user to factor in their own preferred algorithms when algorithms are chosen via recipient key -preferences. +preferences. The most highly ranked algorithm in this list is also +used when there are no recipient keys to consider (e.g. ---symmetric). @item ---default-preference-list @code{string} Set the list of default preferences to @code{string}, this list should @@ -1362,8 +1482,8 @@ menu. @end table @majorheading How to specify a user ID -There are different ways on how to specify a user ID to GnuPG; -here are some examples: +There are different ways to specify a user ID to GnuPG; here are some +examples: @table @asis @item @@ -1460,7 +1580,7 @@ The first is the path to the Unix Domain Socket, the second the PID of the gpg-agent and the protocol version which should be set to 1. When starting the gpg-agent as described in its documentation, this variable is set to the correct value. The option ---gpg-agent-info can -be used to overide it. +be used to override it. @item http_proxy Only honored when the keyserver-option @@ -1518,7 +1638,33 @@ is *very* easy to spy out your passphrase! If you are going to verify detached signatures, make sure that the program knows about it; either be giving both filenames on the -commandline or using @samp{-} to specify stdin. +command line or using @samp{-} to specify stdin. + +@majorheading INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS +GnuPG tries to be a very flexible implementation of the OpenPGP +standard. In particular, GnuPG implements many of the "optional" +parts of the standard, such as the RIPEMD/160 hash, and the ZLIB +compression algorithms. It is important to be aware that not all +OpenPGP programs implement these optional algorithms and that by +forcing their use via the ---cipher-algo, --digest-algo, +---cert-digest-algo, or --compress-algo options in GnuPG, it is +possible to create a perfectly valid OpenPGP message, but one that +cannot be read by the intended recipient. + +For example, as of this writing, no version of official PGP supports +the BLOWFISH cipher algorithm. If you use it, no PGP user will be +able to decrypt your message. The same thing applies to the ZLIB +compression algorithm. By default, GnuPG uses the OpenPGP preferences +system that will always do the right thing and create messages that +are usable by all recipients, regardless of which OpenPGP program they +use. Only override this safe default if you know what you are doing. + +If you absolutely must override the safe default, or if the +preferences on a given key are invalid for some reason, you are far +better off using the ---pgp2, --pgp6, --pgp7, or --pgp8 options. These +options are safe as they do not force any particular algorithms in +violation of OpenPGP, but rather reduce the available algorithms to a +"PGP-safe" list. @majorheading BUGS On many systems this program should be installed as setuid(root). This |