From 5a9b07b0e7fc73dc85f07bbab5cba007efe8d8aa Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Thu, 1 Sep 2011 15:04:28 -0500 Subject: pacman-key help and documentation cleanup We were using the mystical [] options which is some sort of cross between a argument and an [optional] one. Remove this madness and do some other general cleanup/consistency work in the manpage. Signed-off-by: Dan McGee --- doc/pacman-key.8.txt | 26 +++++++++++++------------- scripts/pacman-key.sh.in | 12 ++++++------ 2 files changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt index 4201107f..7481ce5b 100644 --- a/doc/pacman-key.8.txt +++ b/doc/pacman-key.8.txt @@ -23,7 +23,7 @@ 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 +the '\--homedir' option pointing at the pacman keyring (located in +{sysconfdir}/pacman.d/gnupg+ by default). @@ -46,8 +46,8 @@ Options is specified, all keys will be exported. *\--edit-key* :: - Present a menu for key management task on the specified keyids. Useful for - adjusting a keys trust level. + Present a menu for key management task on the specified keyid(s). Useful + for adjusting a keys trust level. *-f, \--finger* [keyid(s)]:: List a fingerprint for each specified keyid, or for all known keys if no @@ -60,37 +60,37 @@ Options *-h, \--help*:: Output syntax and command line options. -*--import* :: +*\--import* :: Adds keys from pubring.gpg into pacman's keyring and imports ownertrust values from trustdb.gpg in the specified directories. -*--import-dirs* :: +*\--import-dirs* :: Imports ownertrust values from trustdb.gpg in the specified directories. -*--init*:: +*\--init*:: Ensure the keyring is properly initialized and has the required access permissions. *-l, \--list-keys* [keyid(s)]:: Lists all or specified keys from the public keyring. -*--list-sigs* [keyid(s)]:: - Same as --list-keys, but the signatures are listed too. +*\--list-sigs* [keyid(s)]:: + Same as '\--list-keys', but the signatures are listed too. *\--lsign-key* :: Locally sign the given key. This is primarily used to root the web of trust - in the local private key generated by \--init. + in the local private key generated by '\--init'. *-r, \--receive* :: - Fetch the specified keyids from the specified key server URL. + Fetch the specified keyid(s) from the specified key server URL. -*\--populate* []:: +*\--populate* [keyring(s)]:: Reload the default keys from the (optionally provided) keyrings in +{pkgdatadir}/keyrings+. For more information, see <> below. *-u, \--updatedb*:: - Equivalent to \--check-trustdb in GnuPG. + Equivalent to '\--check-trustdb' in GnuPG. *-v, \--verify* :: Verify the given signature file. @@ -113,7 +113,7 @@ repository adding keys to the pacman keyring without the users knowledge. A key being marked as revoked always takes priority over the key being added to the pacman keyring, regardless of the keyring it is provided in. To prevent a -key from being revoked when using --populate, its ID can be listed in +key from being revoked when using '\--populate', its ID can be listed in +{sysconfdir}/pacman.d/gnupg/holdkeys+. See Also diff --git a/scripts/pacman-key.sh.in b/scripts/pacman-key.sh.in index b469fd3a..9bb8182a 100644 --- a/scripts/pacman-key.sh.in +++ b/scripts/pacman-key.sh.in @@ -55,12 +55,12 @@ usage() { printf "$(gettext "Manage pacman\'s list of trusted keys")\n" echo echo "$(gettext "Options:")" - echo "$(gettext " -a, --add [] Add the specified keys (empty for stdin)")" + echo "$(gettext " -a, --add [file(s)] Add the specified keys (empty for stdin)")" echo "$(gettext " -d, --delete Remove the specified keyids")" - echo "$(gettext " -e, --export [] Export the specified or all keyids")" - echo "$(gettext " -f, --finger [] List fingerprint for specified or all keyids")" + echo "$(gettext " -e, --export [keyid(s)] Export the specified or all keyids")" + echo "$(gettext " -f, --finger [keyid(s)] List fingerprint for specified or all keyids")" echo "$(gettext " -h, --help Show this help message and exit")" - echo "$(gettext " -l, --list-keys [] List the specified or all keys")" + echo "$(gettext " -l, --list-keys [keyid(s)] List the specified or all keys")" echo "$(gettext " -r, --receive Fetch the specified keyids")" echo "$(gettext " -u, --updatedb Update the trustdb of pacman")" echo "$(gettext " -v, --verify Verify the file specified by the signature")" @@ -73,9 +73,9 @@ usage() { echo "$(gettext " --import Imports pubring.gpg and trustdb.gpg from dir(s)")" echo "$(gettext " --import-trustdb Imports ownertrust values from trustdb.gpg in dir(s)")" echo "$(gettext " --init Ensure the keyring is properly initialized")" - echo "$(gettext " --list-sigs [] List keys and their signatures")" + echo "$(gettext " --list-sigs [keyid(s)] List keys and their signatures")" echo "$(gettext " --lsign-key Locally sign the specified keyid")" - printf "$(gettext " --populate [