* cardglue.c (pin_cb): Disable debug output.
[gnupg.git] / doc / gpg.sgml
index ff28ffe..805f4f8 100644 (file)
@@ -1,6 +1,6 @@
 <!-- gpg.sgml - the man page for GnuPG
     Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
-                  2004 Free Software Foundation, Inc.
+                  2004, 2005 Free Software Foundation, Inc.
 
     This file is part of GnuPG.
 
@@ -271,11 +271,12 @@ For each signature listed, there are several flags in between the
 each signature.  From left to right, they are the numbers 1-3 for
 certificate check level (see --ask-cert-level), "L" for a local or
 non-exportable signature (see --lsign-key), "R" for a nonRevocable
-signature (see --nrsign-key), "P" for a signature that contains a
-policy URL (see --cert-policy-url), "N" for a signature that contains
-a notation (see --cert-notation), "X" for an eXpired signature (see
---ask-cert-expire), and the numbers 1-9 or "T" for 10 and above to
-indicate trust signature levels (see the --edit-key command "tsign").
+signature (see the --edit-key command "nrsign"), "P" for a signature
+that contains a policy URL (see --cert-policy-url), "N" for a
+signature that contains a notation (see --cert-notation), "X" for an
+eXpired signature (see --ask-cert-expire), and the numbers 1-9 or "T"
+for 10 and above to indicate trust signature levels (see the
+--edit-key command "tsign").
 </para></listitem></varlistentry>
 
 
@@ -328,33 +329,24 @@ related tasks:</para>
     <varlistentry>
     <term>sign</term>
     <listitem><para>
-Make a signature on key of user &ParmName;
-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.</para></listitem></varlistentry>
+Make a signature on key of user &ParmName; 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.</para></listitem></varlistentry>
     <varlistentry>
     <term>lsign</term>
     <listitem><para>
-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.</para></listitem></varlistentry>
+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.</para></listitem></varlistentry>
     <varlistentry>
     <term>nrsign</term>
     <listitem><para>
-Same as --sign but the signature is marked as non-revocable and can
+Same as "sign" but the signature is marked as non-revocable and can
 therefore never be revoked.</para></listitem></varlistentry>
     <varlistentry>
-    <term>nrlsign</term>
-    <listitem><para>
-Combines the functionality of nrsign and lsign to make a signature
-that is both non-revocable and
-non-exportable.</para></listitem></varlistentry>
-    <varlistentry>
     <term>tsign</term>
     <listitem><para>
 Make a trust signature.  This is a signature that combines the notions
@@ -362,6 +354,15 @@ of certification (like a regular signature), and trust (like the
 "trust" command).  It is generally only useful in distinct communities
 or groups.
 </para></listitem></varlistentry>
+</variablelist>
+
+<para>
+Note that "l" (for local / non-exportable), "nr" (for non-revocable,
+and "t" (for trust) may be freely mixed and prefixed to "sign" to
+create a signature of any type desired.
+</para>
+
+<variablelist>
     <varlistentry>
     <term>revsig</term>
     <listitem><para>
@@ -426,6 +427,18 @@ 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.</para></listitem></varlistentry>
     <varlistentry>
+    <term>bkuptocard &ParmFile;</term>
+    <listitem><para>
+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.</para></listitem></varlistentry>
+    <varlistentry>
     <term>delkey</term>
     <listitem><para>
 Remove a subkey.</para></listitem></varlistentry>
@@ -574,13 +587,6 @@ from --edit.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>--nrsign-key &ParmName;</term>
-<listitem><para>
-Signs a public key with your secret key but marks it as non-revocable.
-This is a shortcut version of the subcommand "nrsign" from --edit.
-</para></listitem></varlistentry>
-
-<varlistentry>
 <term>--delete-key &ParmName;</term>
 <listitem><para>
 Remove key from the public keyring.  In batch mode either --yes is
@@ -1069,13 +1075,6 @@ specific levels and how they are used. --no-ask-cert-level disables
 this option.  This option defaults to no.
 </para></listitem></varlistentry>
 
-<varlistentry>
-<term>--min-cert-level</term>
-<listitem><para>
-When building the trust database, disregard any signatures with a
-certification level below this.  Defaults to 2, which disregards level
-1 signatures.
-</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--default-cert-level &ParmN;</term>
@@ -1111,6 +1110,16 @@ This option defaults to 0 (no particular claim).
 
 
 <varlistentry>
+<term>--min-cert-level</term>
+<listitem><para>
+When building the trust database, disregard any signatures with a
+certification level below this.  Defaults to 2, which disregards level
+1 signatures.  Note that level 0 "no particular claim" signatures are
+always accepted.
+</para></listitem></varlistentry>
+
+
+<varlistentry>
 <term>--trusted-key <parameter>long key ID</parameter></term>
 <listitem><para>
 Assume that the specified key (which must be given
@@ -1307,7 +1316,7 @@ opposite meaning.  The options are:
 <variablelist>
 
 <varlistentry>
-<term>allow-local-sigs</term>
+<term>import-local-sigs</term>
 <listitem><para>
 Allow importing key signatures marked as "local".  This is not
 generally useful unless a shared keyring scheme is being used.
@@ -1344,7 +1353,7 @@ opposite meaning.  The options are:
 <variablelist>
 
 <varlistentry>
-<term>include-local-sigs</term>
+<term>export-local-sigs</term>
 <listitem><para>
 Allow exporting key signatures marked as "local".  This is not
 generally useful unless a shared keyring scheme is being used.
@@ -1352,7 +1361,7 @@ Defaults to no.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>include-attributes</term>
+<term>export-attributes</term>
 <listitem><para>
 Include attribute user IDs (photo IDs) while exporting.  This is
 useful to export keys if they are going to be used by an OpenPGP
@@ -1360,12 +1369,19 @@ program that does not accept attribute user IDs.  Defaults to yes.
 </para></listitem></varlistentry>
 
 <varlistentry>
-<term>include-sensitive-revkeys</term>
+<term>export-sensitive-revkeys</term>
 <listitem><para>
 Include designated revoker information that was marked as
 "sensitive".  Defaults to no.
 </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>
+
 </variablelist>
 </para></listitem></varlistentry>
 
@@ -1753,6 +1769,10 @@ Use &ParmString; as a comment string in clear text signatures and
 ASCII armored messages or keys (see --armor).  The default behavior is
 not to use a comment string.  --comment may be repeated multiple times
 to get multiple comment strings.  --no-comments removes all comments.
+It is a good idea to keep the length of a single comment below 60
+characters to avoid problems with mail programs wrapping such lines.
+Note, that those comment lines, like all other header lines, are not
+protected by the signature.
 </para></listitem></varlistentry>
 
 
@@ -2375,6 +2395,13 @@ supressed on the command line.
 Suppress the warning about missing MDC integrity protection.
 </para></listitem></varlistentry>
 
+<varlistentry>
+<term>--require-secmem</term>
+<term>--no-require-secmem</term>
+<listitem><para>
+Refuse to run if GnuPG cannot get secure memory.  Defaults to no
+(i.e. run, but give a warning).
+</para></listitem></varlistentry>
 
 <varlistentry>
 <term>--no-armor</term>