[pacman-dev] [PATCH] pacman-key: update man page
Update man page to reflect current options. Also add a description on how to manually interact with the pacman keyring with gpg. Signed-off-by: Allan McRae <allan@archlinux.org> --- doc/pacman-key.8.txt | 57 +++++++++++++++++++++++-------------------------- 1 files changed, 27 insertions(+), 30 deletions(-) diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 892f14d..c024923 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -12,65 +12,62 @@ pacman-key - manage pacman's list of trusted keys Synopsis -------- -'pacman-key' [options] <command> [arguments] +'pacman-key' [options] Description ----------- -'pacman-key' is a script used to manage pacman's keyring, which is the collection -of GnuPG keys used to check signed packages. It provides the ability to import -and export keys, fetch keys from keyservers and update the key trust database. +'pacman-key' is a wrapper script for GnuPG used to manage pacman's keyring, which +is the collection of PGP keys used to check signed packages and databases. It +provides the ability to import and export keys, fetch keys from keyservers and +update the key trust database. +More complex keyring management can be achieved using GnuPG directly combined with +the `--homedir` option pointing at the pacman keyring (located in ++{sysconfdir}/pacman.d/gnupg+ by default). -Options -------- -*\--config* <file>:: - Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ - default. -*\--gpgdir* <dir>:: - Set an alternate home directory for GnuPG. If unspecified, the value is - read from +{sysconfdir}/pacman.conf+. - - -Commands +Options ------- -*-a, \--add* file ...:: +*-a, \--add* [file(s)]:: Add the key(s) contained in the specified file or files to pacman's keyring. If a key already exists, update it. -*\--adv* param ...:: - Use this option to issue particular GnuPG actions to pacman's keyring. This - option should be used with care as it can modify pacman's trust in - packages' signatures. +*\--config* <file>:: + Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ + default. -*-d, \--del* keyid ...:: - Remove the key(s) identified by the specified keyid or keyids from pacman's +*-d, \--del* <keyid(s)>:: + Remove the key(s) identified by the specified keyid(s) from pacman's keyring. -*-e, \--export* [keyid ...]:: - Export key(s) identified by the specified keyid to 'stdout'. If no keyid is - specified, all keys will be exported. +*-e, \--export* [keyid(s)]:: + Export key(s) identified by the specified keyid(s) to 'stdout'. If no keyid + is specified, all keys will be exported. -*-f, \--finger* [keyid ...]:: +*\--edit-key * <keyid(s)>:: + Set the trust level of the given key. + +*-f, \--finger* [keyid(s)]:: List a fingerprint for each specified keyid, or for all known keys if no keyids are specified. +*\--gpgdir* <dir>:: + Set an alternate home directory for GnuPG. If unspecified, the value is + read from +{sysconfdir}/pacman.conf+. + *-h, \--help*:: Output syntax and command line options. *-l, \--list*:: Equivalent to --list-sigs from GnuPG. -*-r, \--receive* keyserver keyid ...:: +*-r, \--receive* <keyserver> <keyid(s)>:: Fetch the specified keyids from the specified key server URL. *\--reload*:: Reloads the keys from the keyring package. -*-t, \--trust* keyid:: - Set the trust level of the given key. - *-u, \--updatedb*:: Equivalent to \--check-trustdb in GnuPG. -- 1.7.6
On Fri, Jul 8, 2011 at 8:31 AM, Allan McRae <allan@archlinux.org> wrote:
Update man page to reflect current options. Also add a description on how to manually interact with the pacman keyring with gpg.
Signed-off-by: Allan McRae <allan@archlinux.org> --- doc/pacman-key.8.txt | 57 +++++++++++++++++++++++-------------------------- 1 files changed, 27 insertions(+), 30 deletions(-)
diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 892f14d..c024923 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -12,65 +12,62 @@ pacman-key - manage pacman's list of trusted keys
Synopsis -------- -'pacman-key' [options] <command> [arguments] +'pacman-key' [options]
Description ----------- -'pacman-key' is a script used to manage pacman's keyring, which is the collection -of GnuPG keys used to check signed packages. It provides the ability to import -and export keys, fetch keys from keyservers and update the key trust database. +'pacman-key' is a wrapper script for GnuPG used to manage pacman's keyring, which +is the collection of PGP keys used to check signed packages and databases. It +provides the ability to import and export keys, fetch keys from keyservers and +update the key trust database.
+More complex keyring management can be achieved using GnuPG directly combined with +the `--homedir` option pointing at the pacman keyring (located in ++{sysconfdir}/pacman.d/gnupg+ by default).
-Options -------- -*\--config* <file>:: - Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ - default.
-*\--gpgdir* <dir>:: - Set an alternate home directory for GnuPG. If unspecified, the value is - read from +{sysconfdir}/pacman.conf+. - - -Commands +Options ------- -*-a, \--add* file ...:: +*-a, \--add* [file(s)]:: Add the key(s) contained in the specified file or files to pacman's keyring. If a key already exists, update it.
-*\--adv* param ...:: - Use this option to issue particular GnuPG actions to pacman's keyring. This - option should be used with care as it can modify pacman's trust in - packages' signatures. +*\--config* <file>:: + Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ + default.
-*-d, \--del* keyid ...:: - Remove the key(s) identified by the specified keyid or keyids from pacman's +*-d, \--del* <keyid(s)>:: + Remove the key(s) identified by the specified keyid(s) from pacman's keyring.
Should be --delete instead of --del
On 09/07/11 05:05, Eric Bélanger wrote:
On Fri, Jul 8, 2011 at 8:31 AM, Allan McRae<allan@archlinux.org> wrote:
Update man page to reflect current options. Also add a description on how to manually interact with the pacman keyring with gpg.
Signed-off-by: Allan McRae<allan@archlinux.org> --- doc/pacman-key.8.txt | 57 +++++++++++++++++++++++-------------------------- 1 files changed, 27 insertions(+), 30 deletions(-)
diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 892f14d..c024923 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -12,65 +12,62 @@ pacman-key - manage pacman's list of trusted keys
Synopsis -------- -'pacman-key' [options]<command> [arguments] +'pacman-key' [options]
Description ----------- -'pacman-key' is a script used to manage pacman's keyring, which is the collection -of GnuPG keys used to check signed packages. It provides the ability to import -and export keys, fetch keys from keyservers and update the key trust database. +'pacman-key' is a wrapper script for GnuPG used to manage pacman's keyring, which +is the collection of PGP keys used to check signed packages and databases. It +provides the ability to import and export keys, fetch keys from keyservers and +update the key trust database.
+More complex keyring management can be achieved using GnuPG directly combined with +the `--homedir` option pointing at the pacman keyring (located in ++{sysconfdir}/pacman.d/gnupg+ by default).
-Options -------- -*\--config*<file>:: - Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ - default.
-*\--gpgdir*<dir>:: - Set an alternate home directory for GnuPG. If unspecified, the value is - read from +{sysconfdir}/pacman.conf+. - - -Commands +Options ------- -*-a, \--add* file ...:: +*-a, \--add* [file(s)]:: Add the key(s) contained in the specified file or files to pacman's keyring. If a key already exists, update it.
-*\--adv* param ...:: - Use this option to issue particular GnuPG actions to pacman's keyring. This - option should be used with care as it can modify pacman's trust in - packages' signatures. +*\--config*<file>:: + Use an alternate config file instead of the +{sysconfdir}/pacman.conf+ + default.
-*-d, \--del* keyid ...:: - Remove the key(s) identified by the specified keyid or keyids from pacman's +*-d, \--del*<keyid(s)>:: + Remove the key(s) identified by the specified keyid(s) from pacman's keyring.
Should be --delete instead of --del
Yes - good spotting. Fixed. Allan
participants (2)
-
Allan McRae
-
Eric Bélanger