diff options
author | David Shaw <[email protected]> | 2004-01-30 19:03:22 +0000 |
---|---|---|
committer | David Shaw <[email protected]> | 2004-01-30 19:03:22 +0000 |
commit | bbd5cda569453239b238e4defedf0f929f406721 (patch) | |
tree | 5da57daeb9064457b8691faf6240d1061548eb10 | |
parent | * g10.c (main, rm_group): Add --ungroup command to remove a particular (diff) | |
download | gnupg-bbd5cda569453239b238e4defedf0f929f406721.tar.gz gnupg-bbd5cda569453239b238e4defedf0f929f406721.zip |
* DETAILS: Details for --list-config.
* gpg.sgml: Document --ungroup and --list-config.
-rw-r--r-- | doc/ChangeLog | 6 | ||||
-rw-r--r-- | doc/DETAILS | 49 | ||||
-rw-r--r-- | doc/gpg.sgml | 33 |
3 files changed, 81 insertions, 7 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index 9af161b5d..51ad5da3b 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,9 @@ +2004-01-30 David Shaw <[email protected]> + + * DETAILS: Details for --list-config. + + * gpg.sgml: Document --ungroup and --list-config. + 2004-01-07 David Shaw <[email protected]> * gpg.sgml: Fix a few minor typos. Clarify what --textmode is diff --git a/doc/DETAILS b/doc/DETAILS index 757510aa5..2a117221c 100644 --- a/doc/DETAILS +++ b/doc/DETAILS @@ -522,6 +522,55 @@ attribute defined: All other data after this header is raw image (JPEG) data. +Format of the "--list-config" output +==================================== + +--list-config outputs information about the GnuPG configuration for +the benefit of frontends or other programs that call GnuPG. There are +several list-config items, all colon delimited like the rest of the +--with-colons output. The first field is always "cfg" to indicate +configuration information. The second field is one of (with +examples): + +version: the third field contains the version of GnuPG. + + cfg:version:1.3.5 + +pubkey: the third field contains the public key algorithmdcaiphers + this version of GnuPG supports, separated by semicolons. The + algorithm numbers are as specified in RFC-2440. + + cfg:pubkey:1;2;3;16;17 + +cipher: the third field contains the symmetric ciphers this version of + GnuPG supports, separated by semicolons. The cipher numbers + are as specified in RFC-2440. + + cfg:cipher:2;3;4;7;8;9;10 + +digest: the third field contains the digest (hash) algorithms this + version of GnuPG supports, separated by semicolons. The + digest numbers are as specified in RFC-2440. + + cfg:digest:1;2;3;8;9;10 + +compress: the third field contains the compression algorithms this + version of GnuPG supports, separated by semicolons. The + algorithm numbers are as specified in RFC-2440. + + cfg:compress:0;1;2;3 + +group: the third field contains the name of the group, and the fourth + field contains the values that the group expands to, separated + by semicolons. + +For example, a group of: + group mynames = paige 0x12345678 joe patti + +would result in: + cfg:group:mynames:patti;joe;0x12345678;paige + + Key generation ============== Key generation shows progress by printing different characters to diff --git a/doc/gpg.sgml b/doc/gpg.sgml index 82f4e0552..ed5deaf07 100644 --- a/doc/gpg.sgml +++ b/doc/gpg.sgml @@ -204,7 +204,7 @@ for a quick encryption of multiple files. <term>--decrypt-files <optional><parameter/files/</optional></term> <listitem><para> The same as --encrypt-files with the difference that files will be -decrypted. The syntax or the filenames is the same. +decrypted. The syntax of the filenames is the same. </para></listitem></varlistentry> <!-- @@ -908,15 +908,17 @@ Try to be as quiet as possible. <varlistentry> -<term>-z &ParmN;, --compress-level &ParmN;</term> +<term>-z &ParmN;</term> +<term>--compress-level &ParmN;</term> <term>--bzip2-compress-level &ParmN;</term> <listitem><para> Set compression level to &ParmN; for the ZIP and ZLIB compression algorithms. The default is to use the default compression level of zlib (normally 6). --bzip2-compress-level sets the compression level for the BZIP2 compression algorithm (defaulting to 6 as well). This -is a different option since BZIP2 uses a significant amount of memory -for each additional compression level. -z sets both. +is a different option from --compress-level since BZIP2 uses a +significant amount of memory for each additional compression level. +-z sets both. A value of 0 for &ParmN; disables compression. </para></listitem></varlistentry> <varlistentry> @@ -2439,8 +2441,9 @@ Experimental use only. <term>--group &ParmNameValues;</term> <listitem><para> Sets up a named group, which is similar to aliases in email programs. -Any time the group name is a recipient (-r or --recipient), it will -be expanded to the values specified. +Any time the group name is a recipient (-r or --recipient), it will be +expanded to the values specified. Multiple groups with the same name +are automatically merged into a single group. </para><para> The values are &ParmKeyIDs; or fingerprints, but any key description is accepted. Note that a value with spaces in it will be treated as @@ -2452,9 +2455,15 @@ arguments. </para></listitem></varlistentry> <varlistentry> +<term>--ungroup &ParmName;</term> +<listitem><para> +Remove a given entry from the --group list. +</para></listitem></varlistentry> + +<varlistentry> <term>--no-groups</term> <listitem><para> -Clear the --group list. +Remove all entries from the --group list. </para></listitem></varlistentry> <varlistentry> @@ -2507,6 +2516,16 @@ edit menu. This affects both key generation and "updpref" in the edit menu. </para></listitem></varlistentry> +<varlistentry> +<term>--list-config &OptParmNames;</term> +<listitem><para> +Display various internal configuration parameters of GnuPG. This +option is intended for external programs that call GnuPG to perform +tasks, and is thus not generally useful. See the file +<filename>doc/DETAILS</filename> in the source distribution for the +details of which configuration items may be listed. --list-config is +only useful with --with-colons set. +</para></listitem></varlistentry> </variablelist> </refsect1> |