From 482da2ecebaccd520a2934f853ed632d8a648b94 Mon Sep 17 00:00:00 2001 From: Guillaume Alaux Date: Sat, 20 Nov 2010 23:15:05 +1000 Subject: Add man-page for pacman-key Signed-off-by: Allan McRae --- doc/.gitignore | 1 + doc/Makefile.am | 4 +++ doc/pacman-key.8.txt | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+) create mode 100644 doc/pacman-key.8.txt (limited to 'doc') diff --git a/doc/.gitignore b/doc/.gitignore index a6f4df7f..4c4e158d 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -3,6 +3,7 @@ libalpm.3 makepkg.8 makepkg.conf.5 pacman.8 +pacman-key.8 pacman.conf.5 repo-add.8 repo-remove.8 diff --git a/doc/Makefile.am b/doc/Makefile.am index 00a0e88d..ed9bb000 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -8,6 +8,7 @@ ASCIIDOC_MANS = \ makepkg.8 \ repo-add.8 \ vercmp.8 \ + pacman-key.8 \ PKGBUILD.5 \ makepkg.conf.5 \ pacman.conf.5 \ @@ -20,6 +21,7 @@ HTML_MANPAGES = \ makepkg.8.html \ repo-add.8.html \ vercmp.8.html \ + pacman-key.8.html \ PKGBUILD.5.html \ makepkg.conf.5.html \ pacman.conf.5.html \ @@ -41,6 +43,7 @@ EXTRA_DIST = \ makepkg.8.txt \ repo-add.8.txt \ vercmp.8.txt \ + pacman-key.8.txt \ PKGBUILD.5.txt \ PKGBUILD-example.txt \ makepkg.conf.5.txt \ @@ -133,6 +136,7 @@ pacman.8 pacman.8.html: pacman.8.txt makepkg.8 makepkg.8.html: makepkg.8.txt repo-add.8 repo-add.8.html: repo-add.8.txt vercmp.8 vercmp.8.html: vercmp.8.txt +pacman-key.8 pacman-key.8.html: pacman-key.8.txt PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt pacman.conf.5 pacman.conf.5.html: pacman.conf.5.txt diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt new file mode 100644 index 00000000..5ebbd0a2 --- /dev/null +++ b/doc/pacman-key.8.txt @@ -0,0 +1,76 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet: +///// +pacman-key(8) +============= + + +Name +---- +pacman-key - manage pacman's list of trusted keys + + +Synopsis +-------- +*pacman-key* [options] *command* ['arguments'] + + +Description +----------- +The script *pacman-key* 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. + + +Options +------- +*\--config* 'file':: + Set an alternative configuration file to use (default is {sysconfdir}/pacman.conf) + +*\--gpgdir* 'directory':: + Set an alternative home directory for GnuPG (default is set in {sysconfdir}/pacman.conf) + + +Commands +------- +*-a*, *\--add* 'file ...':: + Add the key(s) contained in 'file'(s) 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. + +*-d*, *\--del* 'keyid ...':: + Remove the key(s) identified by 'keyid'(s) from pacman's keyring + +*-e*, *\--export* ['keyid ...']:: + Export key(s) identified by 'keyid'(s) to STDOUT or all keys if no 'keyid' is specified + +*-f*, *\--finger* ['keyid ...']:: + List fingerprint(s) for specified 'keyid'(s) or for all if none is specified + +*\--help*:: + Display short usage instructions + +*-l*, *\--list*:: + Equivalent to --list-sigs from GnuPG + +*-r*, *\--receive* 'keyserver' 'keyid ...':: + Fetch the 'keyid'(s) from the specified 'keyserver' 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 + +*-v*, *\--version*:: + Displays the current version + + +See Also +-------- +linkman:pacman.conf[5] + +include::footer.txt[] -- cgit v1.2.3-24-g4f1b From b625d03dd689faa598b1427677f9308f516d6946 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Wed, 23 Mar 2011 01:53:44 -0500 Subject: pacman-key manpage updates Make consistent in formatting, syntax, and prose with the rest of our documentation. Signed-off-by: Dan McGee --- doc/index.txt | 1 + doc/pacman-key.8.txt | 71 +++++++++++++++++++++++++++++----------------------- 2 files changed, 41 insertions(+), 31 deletions(-) (limited to 'doc') diff --git a/doc/index.txt b/doc/index.txt index 0d855bdf..3703421c 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -41,6 +41,7 @@ configuration files dealing with pacman. * linkman:makepkg[8] * linkman:makepkg.conf[5] * linkman:pacman[8] +* linkman:pacman-key[8] * linkman:pacman.conf[5] * linkman:repo-add[8] * linkman:vercmp[8] diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 5ebbd0a2..9bd135ce 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -12,65 +12,74 @@ pacman-key - manage pacman's list of trusted keys Synopsis -------- -*pacman-key* [options] *command* ['arguments'] +'pacman-key' [options] [arguments] Description ----------- -The script *pacman-key* 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 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. Options ------- -*\--config* 'file':: - Set an alternative configuration file to use (default is {sysconfdir}/pacman.conf) +*\--config* :: + Use an alternate config file instead of the `{sysconfdir}/pacman.conf` + default. -*\--gpgdir* 'directory':: - Set an alternative home directory for GnuPG (default is set in {sysconfdir}/pacman.conf) +*\--gpgdir* :: + Set an alternate home directory for GnuPG. If unspecified, the value is + read from `{sysconfdir}/pacman.conf`. Commands ------- -*-a*, *\--add* 'file ...':: - Add the key(s) contained in 'file'(s) to pacman's keyring. If a key already exists, update it. +*-a, \--add* file ...:: + 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. +*\--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. -*-d*, *\--del* 'keyid ...':: - Remove the key(s) identified by 'keyid'(s) from pacman's keyring +*-d, \--del* keyid ...:: + Remove the key(s) identified by the specified keyid or keyids from pacman's + keyring. -*-e*, *\--export* ['keyid ...']:: - Export key(s) identified by 'keyid'(s) to STDOUT or all keys if no 'keyid' is specified +*-e, \--export* [keyid ...]:: + Export key(s) identified by the specified keyid to 'stdout'. If no keyid is + specified, all keys will be exported. -*-f*, *\--finger* ['keyid ...']:: - List fingerprint(s) for specified 'keyid'(s) or for all if none is specified +*-f, \--finger* [keyid ...]:: + List a fingerprint for each specified keyid, or for all known keys if no + keyids are specified. -*\--help*:: - Display short usage instructions +*-h, \--help*:: + Output syntax and command line options. -*-l*, *\--list*:: - Equivalent to --list-sigs from GnuPG +*-l, \--list*:: + Equivalent to --list-sigs from GnuPG. -*-r*, *\--receive* 'keyserver' 'keyid ...':: - Fetch the 'keyid'(s) from the specified 'keyserver' URL +*-r, \--receive* keyserver keyid ...:: + Fetch the specified keyids from the specified key server URL. *\--reload*:: - Reloads the keys from the keyring package + Reloads the keys from the keyring package. -*-t*, *\--trust* 'keyid':: - Set the trust level of the given key +*-t, \--trust* keyid:: + Set the trust level of the given key. -*-u*, *\--updatedb*:: - Equivalent to \--check-trustdb in GnuPG +*-u, \--updatedb*:: + Equivalent to \--check-trustdb in GnuPG. -*-v*, *\--version*:: - Displays the current version +*-v, \--version*:: + Displays the program version. See Also -------- -linkman:pacman.conf[5] +linkman:pacman[8], linkman:pacman.conf[5] include::footer.txt[] -- cgit v1.2.3-24-g4f1b