[svn] GnuPG - r5126 - trunk/doc

svn author dshaw cvs at cvs.gnupg.org
Tue Aug 25 00:21:39 CEST 2009


Author: dshaw
Date: 2009-08-25 00:21:39 +0200 (Tue, 25 Aug 2009)
New Revision: 5126

Modified:
   trunk/doc/ChangeLog
   trunk/doc/gpg.texi
Log:
* gpg.text: Suggested new ordering for --edit-key.


Modified: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog	2009-08-20 08:41:15 UTC (rev 5125)
+++ trunk/doc/ChangeLog	2009-08-24 22:21:39 UTC (rev 5126)
@@ -1,3 +1,7 @@
+2009-08-24  David Shaw  <dshaw at jabberwocky.com>
+
+	* gpg.text: Suggested new ordering for --edit-key.
+
 2009-08-17  David Shaw  <dshaw at jabberwocky.com>
 
 	* gpg.texi (OpenPGP Options): Clarify that

Modified: trunk/doc/gpg.texi
===================================================================
--- trunk/doc/gpg.texi	2009-08-20 08:41:15 UTC (rev 5125)
+++ trunk/doc/gpg.texi	2009-08-24 22:21:39 UTC (rev 5126)
@@ -589,6 +589,16 @@
 @c ******** Begin Edit-key Options **********
 @table @asis
 
+ at item uid @code{n}
+ at opindex keyedit:uid
+Toggle selection of user ID or photographic user ID with index @code{n}.
+Use 0 to deselect all.
+
+ at item key @code{n}
+ at opindex keyedit:key
+Toggle selection of subkey with index @code{n}.
+Use 0 to deselect all.
+
 @item sign
 @opindex keyedit:sign
 Make a signature on key of user @code{name} If the key is not yet
@@ -625,107 +635,48 @@
 
 @table @asis
 
+ at item delsig
+ at opindex keyedit:delsig
+Delete a signature. Note that it is not possible to retract a signature,
+once it has been send to the public (i.e. to a keyserver).  In that case
+you better use @code{revsig}.
+
 @item revsig
 @opindex keyedit:revsig
 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.
 
- at item trust
- at opindex keyedit:trust
-Change the owner trust value. This updates the
-trust-db immediately and no save is required.
+ at item check
+ at opindex keyedit:check
+Check the signatures on all selected user IDs.
 
- at item disable
- at itemx enable
- at opindex keyedit:disable
- at opindex keyedit:enable
-Disable or enable an entire key. A disabled key can not normally be
-used for encryption.
-
 @item adduid
 @opindex keyedit:adduid
-Create an alternate user id.
+Create an additional user ID.
 
 @item addphoto
 @opindex keyedit:addphoto
-Create a photographic user id. This will prompt for a JPEG file that
+Create a photographic user ID. This will prompt for a JPEG file that
 will be embedded into the user ID. Note that a very large JPEG will make
 for a very large key. Also note that some programs will display your
 JPEG unchanged (GnuPG), and some programs will scale it to fit in a
 dialog box (PGP).
 
+ at item showphoto
+ at opindex keyedit:showphoto
+Display the selected photographic user ID.
+
 @item deluid
 @opindex keyedit:deluid
-Delete a user id.  Note that it is not possible to retract a user id,
-once it has been send to the public (i.e. to a keyserver).  In that case
-you better use @code{revuid}.
+Delete a user ID or photographic user ID.  Note that it is not
+possible to retract a user id, once it has been send to the public
+(i.e. to a keyserver).  In that case you better use @code{revuid}.
 
- at item delsig
- at opindex keyedit:delsig
-Delete a signature. Note that it is not possible to retract a signature,
-once it has been send to the public (i.e. to a keyserver).  In that case
-you better use @code{revsig}.
-
 @item revuid
 @opindex keyedit:revuid
-Revoke a user id.
+Revoke a user ID or photographic user ID.
 
- at item addkey
- at opindex keyedit:addkey
-Add a subkey to this key.
-
- at item addcardkey
- at opindex keyedit:addcardkey
-Generate a key on a card and add it to this key.
-
- at item keytocard
- at opindex keyedit:keytocard
-Transfer the selected secret key (or the primary key if no key has been
-selected) to a smartcard. The secret key in the keyring will be replaced
-by a stub if the key could be stored successfully on the card and you
-use the save command later. Only certain key types may be transferred to
-the card. A sub menu allows you to select on what card 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.
-
- at item bkuptocard @code{file}
- at opindex keyedit:bkuptocard
-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.
-
- at item delkey
- at opindex keyedit:delkey
-Remove a subkey (secondart key). Note that it is not possible to retract
-a subkey, once it has been send to the public (i.e. to a keyserver).  In
-that case you better use @code{revkey}.
-
- at item addrevoker
- at opindex keyedit:addrevoker
-Add a designated revoker. This takes one optional argument:
-"sensitive". If a designated revoker is marked as sensitive, it will not
-be exported by default (see export-options).
-
- at item revkey
- at opindex keyedit:revkey
-Revoke a subkey.
-
- at item expire
- at opindex keyedit:expire
-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.
-
- at item passwd
- at opindex keyedit:passwd
-Change the passphrase of the secret key.
-
 @item primary
 @opindex keyedit:primary
 Flag the current user id as the primary one, removes the primary user
@@ -735,25 +686,22 @@
 regular user ID as primary makes it primary over other regular user
 IDs.
 
- at item uid @code{n}
- at opindex keyedit:uid
-Toggle selection of user id with index @code{n}.
-Use 0 to deselect all.
+ at item keyserver
+ at opindex keyedit:keyserver
+Set a preferred keyserver for the specified user ID(s). This allows
+other users to know where you prefer they get your key from. See
+ at option{--keyserver-options honor-keyserver-url} for more on how this
+works.  Setting a value of "none" removes an existing preferred
+keyserver.
 
- at item key @code{n}
- at opindex keyedit:key
-Toggle selection of subkey with index @code{n}.
-Use 0 to deselect all.
+ at item notation
+ at opindex keyedit:notation
+Set a name=value notation for the specified user ID(s). See
+ at option{--cert-notation} for more on how this works. Setting a value of
+"none" removes all notations, setting a notation prefixed with a minus
+sign (-) removes that notation, and setting a notation name (without the
+=value) prefixed with a minus sign removes all notations with that name.
 
- at item check
- at opindex keyedit:check
-Check all selected user ids.
-
- at item showphoto
- at opindex keyedit:showphoto
-Display the selected photographic user
-id.
-
 @item pref
 @opindex keyedit:pref
 List preferences from the selected user ID. This shows the actual
@@ -790,22 +738,73 @@
 on the preference list of every recipient key.  See also the
 INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS section below.
 
- at item keyserver
- at opindex keyedit:keyserver
-Set a preferred keyserver for the specified user ID(s). This allows
-other users to know where you prefer they get your key from. See
- at option{--keyserver-options honor-keyserver-url} for more on how this
-works.  Setting a value of "none" removes an existing preferred
-keyserver.
+ at item addkey
+ at opindex keyedit:addkey
+Add a subkey to this key.
 
- at item notation
- at opindex keyedit:notation
-Set a name=value notation for the specified user ID(s). See
- at option{--cert-notation} for more on how this works. Setting a value of
-"none" removes all notations, setting a notation prefixed with a minus
-sign (-) removes that notation, and setting a notation name (without the
-=value) prefixed with a minus sign removes all notations with that name.
+ at item addcardkey
+ at opindex keyedit:addcardkey
+Generate a subkey on a card and add it to this key.
 
+ at item keytocard
+ at opindex keyedit:keytocard
+Transfer the selected secret subkey (or the primary key if no subkey
+has been selected) to a smartcard. The secret key in the keyring will
+be replaced by a stub if the key could be stored successfully on the
+card and you use the save command later. Only certain key types may be
+transferred to the card. A sub menu allows you to select on what card
+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.
+
+ at item bkuptocard @code{file}
+ at opindex keyedit:bkuptocard
+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.
+
+ at item delkey
+ at opindex keyedit:delkey
+Remove a subkey (secondart key). Note that it is not possible to retract
+a subkey, once it has been send to the public (i.e. to a keyserver).  In
+that case you better use @code{revkey}.
+
+ at item revkey
+ at opindex keyedit:revkey
+Revoke a subkey.
+
+ at item expire
+ at opindex keyedit:expire
+Change the key or subkey 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.
+
+ at item trust
+ at opindex keyedit:trust
+Change the owner trust value for the key. This updates the trust-db
+immediately and no save is required.
+
+ at item disable
+ at itemx enable
+ at opindex keyedit:disable
+ at opindex keyedit:enable
+Disable or enable an entire key. A disabled key can not normally be
+used for encryption.
+
+ at item addrevoker
+ at opindex keyedit:addrevoker
+Add a designated revoker to the key. This takes one optional argument:
+"sensitive". If a designated revoker is marked as sensitive, it will
+not be exported by default (see export-options).
+
+ at item passwd
+ at opindex keyedit:passwd
+Change the passphrase of the secret key.
+
 @item toggle
 @opindex keyedit:toggle
 Toggle between public and secret key listing.
@@ -829,7 +828,9 @@
 Add cross-certification signatures to signing subkeys that may not
 currently have them. Cross-certification signatures protect against a
 subtle attack against signing subkeys. See
- at option{--require-cross-certification}.
+ at option{--require-cross-certification}.  All new keys generated have
+this signature by default, so this option is only useful to bring
+older keys up to date.
 
 @item save
 @opindex keyedit:save




More information about the Gnupg-commits mailing list