summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDan McGee <dan@archlinux.org>2011-03-23 01:53:44 -0500
committerDan McGee <dan@archlinux.org>2011-03-23 01:59:43 -0500
commitb625d03dd689faa598b1427677f9308f516d6946 (patch)
treea7074e1a7c6a283f334448c0953512aec4f94415 /doc
parent964e8c5bf231fb42a0de97108c0134d0079099ba (diff)
pacman-key manpage updates
Make consistent in formatting, syntax, and prose with the rest of our documentation. Signed-off-by: Dan McGee <dan@archlinux.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.txt1
-rw-r--r--doc/pacman-key.8.txt71
2 files changed, 41 insertions, 31 deletions
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] <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.
+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* <file>::
+ 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* <dir>::
+ 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[]