diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/gpg.texi | 86 | ||||
| -rw-r--r-- | doc/gpgv.sgml | 22 | ||||
| -rw-r--r-- | doc/gpgv.texi | 22 |
4 files changed, 83 insertions, 51 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 8b39cd134..e4677e843 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2005-10-07 Werner Koch <[email protected]> + + * gpgv.sgml: Small spelling corrections by Mike Dowling. + 2005-09-21 David Shaw <[email protected]> * gpg.sgml: Note that --display-charset is just for display and diff --git a/doc/gpg.texi b/doc/gpg.texi index a9fe10fdd..5dccd70b9 100644 --- a/doc/gpg.texi +++ b/doc/gpg.texi @@ -322,21 +322,15 @@ the preferences in effect by including the implied preferences of are not already included in the preference list. @item setpref @code{string} -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 remove the -preferences. 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. - -@item updpref -Change the preferences of all user IDs (or just of the selected ones -to the current list of preferences. The timestamp of all affected -self-signatures will be advanced by one second. 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. +Set the list of user ID preferences to @code{string} for all (or just +the selected) user IDs. Calling setpref with no arguments sets the +preference list to the default (either built-in or set via +--default-preference-list), and calling setpref with "none" as the +argument sets an empty preference list. Use "gpg --version" to get a +list of available algorithms. Note that while you can change the +preferences on an attribute user ID (aka "photo ID"), GnuPG does not +select keys via attribute user IDs so these preferences will not be +used by GnuPG. @item keyserver Set a preferred keyserver for the specified user ID(s). This allows @@ -506,6 +500,10 @@ keyservers set (see --keyserver-option honor-keyserver-url). Search the keyserver for the given names. Multiple names given here will be joined together to create the search string for the keyserver. Option --keyserver must be used to give the name of this keyserver. +Keyservers that support different search methods allow using the +syntax specified in "How to specify a user ID" below. Note that +different keyserver types support different search methods. Currently +only LDAP supports them all. @item --update-trustdb Do trust database maintenance. This command iterates over all keys @@ -935,6 +933,9 @@ sigs" after import. Defaults to no. After import, compact (remove all signatures from) any user IDs from the new key that are not usable. This is the same as running the --edit-key command "clean uids" after import. Defaults to no. + +@item import-clean +Identical to "import-clean-sigs import-clean-uids". @end table @item --export-options @code{parameters} @@ -975,8 +976,8 @@ the --edit-key command "clean uids" before export. Defaults to no. @item export-reset-subkey-passwd When using the "--export-secret-subkeys" command, this option resets the passphrases for all exported subkeys to empty. This is useful -when the exported subkey is to be used on an unattended amchine where -a passphrase won't make sense. Defaults to no. +when the exported subkey is to be used on an unattended machine where +a passphrase doesn't necessarily make sense. Defaults to no. @end table @item --list-options @code{parameters} @@ -1160,10 +1161,12 @@ found. @item --display-charset @code{name} 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. If this option is not used, the default character set is -determined from the current locale. A verbosity level of 3 shows the -chosen set. Valid values for @code{name} are: +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 +encrypted or signed; GnuPG does not recode user supplied data. If +this option is not used, the default character set is determined from +the current locale. A verbosity level of 3 shows the chosen set. +Valid values for @code{name} are: @table @asis @@ -1231,15 +1234,27 @@ There is a slight performance overhead using it. Write special status strings to the file descriptor @code{n}. See the file DETAILS in the documentation for a listing of them. +@item --status-file @code{file} +Same as --status-fd, except the status data is written to file +@code{file}. + @item --logger-fd @code{n} Write log output to file descriptor @code{n} and not to stderr. +@item --logger-file @code{file} +Same as --logger-fd, except the logger data is written to file +@code{file}. + @item --attribute-fd @code{n} Write attribute subpackets to the file descriptor @code{n}. This is most useful for use with --status-fd, since the status messages are needed to separate out the various subpackets from the stream delivered to the file descriptor. +@item --attribute-file @code{file} +Same as --attribute-fd, except the attribute data is written to file +@code{file}. + @item --comment @code{string} @itemx --no-comments Use @code{string} as a comment string in clear text signatures and @@ -1475,6 +1490,17 @@ Read the passphrase from file descriptor @code{n}. If you use can only be used if only one passphrase is supplied. Don't use this option if you can avoid it. +@item --passphrase-file @code{file} +Read the passphrase from file @code{file}. This can only be used if +only one passphrase is supplied. Obviously, a passphrase stored in a +file is of questionable security. Don't use this option if you can +avoid it. + +@item --passphrase @code{string} +Use @code{string} as the passphrase. This can only be used if only one +passphrase is supplied. Obviously, this is of very questionable +security. Don't use this option if you can avoid it. + @item --command-fd @code{n} This is a replacement for the deprecated shared-memory IPC mode. If this option is enabled, user input on questions is not expected @@ -1482,6 +1508,10 @@ from the TTY but from the given file descriptor. It should be used together with --status-fd. See the file doc/DETAILS in the source distribution for details on how to use it. +@item --command-file @code{file} +Same as --command-fd, except the commands are read out of file +@code{file} + @item --use-agent @itemx --no-use-agent Try to use the GnuPG-Agent. Please note that this agent is still under @@ -1871,10 +1901,9 @@ 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 -be a string similar to the one printed by the command "pref" in the -edit menu. This affects both key generation and "updpref" in the edit -menu. +Set the list of default preferences to @code{string}. This preference +list is used for new keys and becomes the default for "setpref" in the +edit menu. @item --list-config Display various internal configuration parameters of GnuPG. This @@ -1921,10 +1950,9 @@ Using an exact to match string. The equal sign indicates this. Using the email address part which must match exactly. The left angle bracket indicates this email address mode. -@item +Heinrich Heine duesseldorf -All words must match exactly (not case sensitive) but can appear in -any order in the user ID. Words are any sequences of letters, -digits, the underscore and all characters with bit 7 set. +@item @@heinrichh +Match within the <email.address> part of a user ID. The at sign +indicates this email address mode. @item Heine @itemx *Heine diff --git a/doc/gpgv.sgml b/doc/gpgv.sgml index 6b865e013..ee16d0e94 100644 --- a/doc/gpgv.sgml +++ b/doc/gpgv.sgml @@ -70,16 +70,16 @@ <command/gpgv/ is the OpenPGP signature checking tool. </para> <para> -This program is a stripped down version of <command/gpg/ which is only -able -to check signatures. It is somewhat smaller than the full blown -<command/gpg/ and uses a different (and more simple way) to check that -the public keys used to made the signature are trustworth. There is +This program is a stripped down version of <command/gpg/ which is able +only +to check signatures. It is somewhat smaller than the fully blown +<command/gpg/ and uses a different (and simpler) way to check that +the public keys used to make the signature are trustworthy. There are no options files and only very few options are implemented. </para> <para> -<command/gpgv/ assumes that all keys in the keyring are trustworty. -It uses by default a keyring named <filename/trustedkeys.gpg/ which is +<command/gpgv/ assumes that all keys in the keyring are trustworthy. +By default it uses a keyring named <filename/trustedkeys.gpg/ which is assumed to be in the home directory as defined by GnuPG or set by an option or an environment variable. An option may be used to specify another keyring or even multiple keyrings. @@ -98,7 +98,7 @@ another keyring or even multiple keyrings. <varlistentry> <term>-v, --verbose</term> <listitem><para> -Give more information during processing. If used +Gives more information during processing. If used twice, the input data is listed in detail. </para></listitem></varlistentry> @@ -127,8 +127,8 @@ The filename may be prefixed with a scheme:</para> <term>--homedir &ParmDir;</term> <listitem><para> Set the name of the home directory to &ParmDir; If this -option is not used it defaults to "~/.gnupg". It does -not make sense to use this in a options file. This +option is not used, it defaults to "~/.gnupg". It does +not make sense to use this in an options file. This also overrides the environment variable "GNUPGHOME". </para></listitem></varlistentry> @@ -154,7 +154,7 @@ Write log output to file descriptor &ParmN; and not to stderr. GnuPG normally checks that the timestamps associated with keys and signatures have plausible values. However, sometimes a signature seems to be older than the key due to clock problems. This option makes these -checks just a warning. +checks just warnings. </para></listitem></varlistentry> diff --git a/doc/gpgv.texi b/doc/gpgv.texi index 721f2e703..2985a5dbb 100644 --- a/doc/gpgv.texi +++ b/doc/gpgv.texi @@ -22,15 +22,15 @@ gpgv @code{gpgv} is the OpenPGP signature checking tool. -This program is a stripped down version of @code{gpg} which is only -able -to check signatures. It is somewhat smaller than the full blown -@code{gpg} and uses a different (and more simple way) to check that -the public keys used to made the signature are trustworth. There is +This program is a stripped down version of @code{gpg} which is able +only +to check signatures. It is somewhat smaller than the fully blown +@code{gpg} and uses a different (and simpler) way to check that +the public keys used to make the signature are trustworthy. There are no options files and only very few options are implemented. -@code{gpgv} assumes that all keys in the keyring are trustworty. -It uses by default a keyring named @file{trustedkeys.gpg} which is +@code{gpgv} assumes that all keys in the keyring are trustworthy. +By default it uses a keyring named @file{trustedkeys.gpg} which is assumed to be in the home directory as defined by GnuPG or set by an option or an environment variable. An option may be used to specify another keyring or even multiple keyrings. @@ -41,7 +41,7 @@ another keyring or even multiple keyrings. @table @asis @item -v, --verbose -Give more information during processing. If used +Gives more information during processing. If used twice, the input data is listed in detail. @item -q, --quiet @@ -59,8 +59,8 @@ The filename may be prefixed with a scheme: @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 -not make sense to use this in a options file. This +option is not used, it defaults to "~/.gnupg". It does +not make sense to use this in an options file. This also overrides the environment variable "GNUPGHOME". @item --status-fd @code{n} @@ -74,7 +74,7 @@ Write log output to file descriptor @code{n} and not to stderr. GnuPG normally checks that the timestamps associated with keys and signatures have plausible values. However, sometimes a signature seems to be older than the key due to clock problems. This option makes these -checks just a warning. +checks just warnings. @end table @chapheading RETURN VALUE |