1
0
mirror of git://git.gnupg.org/gnupg.git synced 2024-12-23 10:29:58 +01:00

* gpg.sgml: Clarify "xxxxx-clean" and "clean". Document

"xxxxx-minimal", and "minimize".
This commit is contained in:
David Shaw 2005-11-18 04:50:15 +00:00
parent 3349715ebb
commit 092bae80a9
2 changed files with 46 additions and 61 deletions

View File

@ -1,3 +1,8 @@
2005-11-17 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: Clarify "xxxxx-clean" and "clean". Document
"xxxxx-minimal", and "minimize".
2005-11-02 David Shaw <dshaw@jabberwocky.com> 2005-11-02 David Shaw <dshaw@jabberwocky.com>
* gpg.sgml: Clarify what is and isn't included in a "clean sigs". * gpg.sgml: Clarify what is and isn't included in a "clean sigs".

View File

@ -539,30 +539,19 @@ Toggle between public and secret key listing.</para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>clean</term> <term>clean</term>
<listitem><para> <listitem><para>
Cleans keys by removing unusable pieces. This command can be used to Compact (by removing all signatures except the selfsig) any user ID
keep keys neat and clean, and it has no effect aside from that. that is no longer usable (e.g. revoked, or expired). Then, remove any
signatures that are not usable by the trust calculations.
<variablelist>
<varlistentry>
<term>sigs</term>
<listitem><para>
Remove any signatures that are not usable by the trust calculations.
Specifically, this removes any signature that does not validate, any Specifically, this removes any signature that does not validate, any
signature that is superceded by a later signature, revoked signatures, signature that is superceded by a later signature, revoked signatures,
and signatures issued by keys that are not present on the keyring. and signatures issued by keys that are not present on the keyring.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>uids</term> <term>minimize</term>
<listitem><para> <listitem><para>
Compact (by removing all signatures except the selfsig) any user ID Make the key as small as possible. This removes all signatures from
that is no longer usable (e.g. revoked, or expired). each user ID except for the most recent self-signature.
</para></listitem></varlistentry>
</variablelist>
If invoked with no arguments, both `sigs' and `uids' are cleaned.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
@ -1398,27 +1387,22 @@ During import, allow key updates to existing keys, but do not allow
any new keys to be imported. Defaults to no. any new keys to be imported. Defaults to no.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry>
<term>import-clean-sigs</term>
<listitem><para>
After import, remove any signatures from the new key that are not
usable. This includes signatures that were issued by keys that are
not present on the keyring. This option is the same as running the
--edit-key command "clean sigs" after import. Defaults to no.
</para></listitem></varlistentry>
<varlistentry>
<term>import-clean-uids</term>
<listitem><para>
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.
</para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>import-clean</term> <term>import-clean</term>
<listitem><para> <listitem><para>
Identical to "import-clean-sigs import-clean-uids". After import, compact (remove all signatures except the
self-signature) any user IDs from the new key that are not usable.
Then, remove any signatures from the new key that are not usable.
This includes signatures that were issued by keys that are not present
on the keyring. This option is the same as running the --edit-key
command "clean" after import. Defaults to no.
</para></listitem></varlistentry>
<varlistentry>
<term>import-minimal</term>
<listitem><para>
Import the smallest key possible. This removes all signatures except
the most recent self-signature on each user ID. Defaults to no.
</para></listitem></varlistentry> </para></listitem></varlistentry>
</variablelist> </variablelist>
@ -1455,30 +1439,6 @@ Include designated revoker information that was marked as
"sensitive". Defaults to no. "sensitive". Defaults to no.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry>
<term>export-minimal</term>
<listitem><para>
Export the smallest key possible. Currently this is done by leaving
out any signatures that are not self-signatures. Defaults to no.
</para></listitem></varlistentry>
<varlistentry>
<term>export-clean-sigs</term>
<listitem><para>
Do not export any signatures that are not usable. This includes
signatures that were issued by keys that are not present on the
keyring. This option is the same as running the --edit-key command
"clean sigs" before export. Defaults to no.
</para></listitem></varlistentry>
<varlistentry>
<term>export-clean-uids</term>
<listitem><para>
Compact (remove all signatures from) user IDs on the key being
exported if the user IDs are not usable. This is the same as running
the --edit-key command "clean uids" before export. Defaults to no.
</para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>export-reset-subkey-passwd</term> <term>export-reset-subkey-passwd</term>
<listitem><para> <listitem><para>
@ -1488,6 +1448,24 @@ when the exported subkey is to be used on an unattended machine where
a passphrase doesn't necessarily make sense. Defaults to no. a passphrase doesn't necessarily make sense. Defaults to no.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry>
<term>export-clean</term>
<listitem><para>
Compact (remove all signatures from) user IDs on the key being
exported if the user IDs are not usable. Also, do not export any
signatures that are not usable. This includes signatures that were
issued by keys that are not present on the keyring. This option is
the same as running the --edit-key command "clean" before export.
Defaults to no.
</para></listitem></varlistentry>
<varlistentry>
<term>export-minimal</term>
<listitem><para>
Export the smallest key possible. This removes all signatures except
the most recent self-signature on each user ID. Defaults to no.
</para></listitem></varlistentry>
</variablelist> </variablelist>
</para></listitem></varlistentry> </para></listitem></varlistentry>
@ -2713,7 +2691,7 @@ FORCED TO DO SO.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>
<term>--override-session-key &ParmString; </term> <term>--override-session-key &ParmString;</term>
<listitem><para> <listitem><para>
Don't use the public key but the session key &ParmString;. The format of this Don't use the public key but the session key &ParmString;. The format of this
string is the same as the one printed by --show-session-key. This option string is the same as the one printed by --show-session-key. This option
@ -2740,7 +2718,9 @@ the future.
When making a data signature, prompt for an expiration time. If this When making a data signature, prompt for an expiration time. If this
option is not specified, the expiration time set via option is not specified, the expiration time set via
--default-sig-expire is used. --no-ask-sig-expire disables this --default-sig-expire is used. --no-ask-sig-expire disables this
option. option. Note that by default, --force-v3-sigs is set which also
disables this option. If you want signature expiration, you must set
--no-force-v3-sigs as well as turning --ask-sig-expire on.
</para></listitem></varlistentry> </para></listitem></varlistentry>
<varlistentry> <varlistentry>