autoclean.sh: abide by POSIX shebang
[pacman-ng.git] / doc / pacman-key.8.txt
blob3631ec8c19023c6febe315b5dd94e8702a12d92f
1 /////
2 vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
3 /////
4 pacman-key(8)
5 =============
8 Name
9 ----
10 pacman-key - manage pacman's list of trusted keys
13 Synopsis
14 --------
15 'pacman-key' [options]
18 Description
19 -----------
20 'pacman-key' is a wrapper script for GnuPG used to manage pacman's keyring, which
21 is the collection of PGP keys used to check signed packages and databases. It
22 provides the ability to import and export keys, fetch keys from keyservers and
23 update the key trust database.
25 More complex keyring management can be achieved using GnuPG directly combined with
26 the '\--homedir' option pointing at the pacman keyring (located in
27 +{sysconfdir}/pacman.d/gnupg+ by default).
30 Options
31 -------
32 *-a, \--add* [file(s)]::
33         Add the key(s) contained in the specified file or files to pacman's
34         keyring. If a key already exists, update it.
36 *\--config* <file>::
37         Use an alternate config file instead of the +{sysconfdir}/pacman.conf+
38         default.
40 *-d, \--delete* <keyid(s)>::
41         Remove the key(s) identified by the specified keyid(s) from pacman's
42         keyring.
44 *-e, \--export* [keyid(s)]::
45         Export key(s) identified by the specified keyid(s) to 'stdout'. If no keyid
46         is specified, all keys will be exported.
48 *\--edit-key* <keyid(s)>::
49         Present a menu for key management task on the specified keyid(s). Useful
50         for adjusting a keys trust level.
52 *-f, \--finger* [keyid(s)]::
53         List a fingerprint for each specified keyid, or for all known keys if no
54         keyids are specified.
56 *\--gpgdir* <dir>::
57         Set an alternate home directory for GnuPG. If unspecified, the value is
58         read from +{sysconfdir}/pacman.conf+.
60 *-h, \--help*::
61         Output syntax and command line options.
63 *\--import* <dir(s)>::
64         Imports keys from `pubring.gpg` into the public keyring from the specified
65         directories.
67 *\--import-trustdb* <dir(s)> ::
68         Imports ownertrust values from `trustdb.gpg` into the shared trust database
69         from the specified directories.
71 *\--init*::
72         Ensure the keyring is properly initialized and has the required access
73         permissions.
75 *\--keyserver* <keyserver>::
76         Use the specified keyserver if the operation requires one. This will take
77         precedence over any keyserver option specified in a `gpg.conf`
78         configuration file. Running '\--init' with this option will set the default
79         keyserver if one was not already configured.
81 *-l, \--list-keys* [keyid(s)]::
82         Lists all or specified keys from the public keyring.
84 *\--list-sigs* [keyid(s)]::
85         Same as '\--list-keys', but the signatures are listed too.
87 *\--lsign-key* <keyid>::
88         Locally sign the given key. This is primarily used to root the web of trust
89         in the local private key generated by '\--init'.
91 *-r, \--recv-keys* <keyid(s)>::
92         Equivalent to '\--recv-keys' in GnuPG.
94 *\--refresh-keys* [keyid(s)]::
95         Equivalent to '\--refresh-keys' in GnuPG.
97 *\--populate* [keyring(s)]::
98         Reload the default keys from the (optionally provided) keyrings in
99         +{pkgdatadir}/keyrings+. For more information, see
100         <<SC,Providing a Keyring for Import>> below.
102 *-u, \--updatedb*::
103         Equivalent to '\--check-trustdb' in GnuPG.
105 *-v, \--verify* <signature>::
106         Verify the given signature file.
108 *-V, \--version*::
109         Displays the program version.
112 Providing a Keyring for Import
113 ------------------------------
114 A distribution or other repository provided may want to provide a set of
115 PGP keys used in the signing of its packages and repository databases that can
116 be readily imported into the pacman keyring. This is achieved by providing a
117 PGP keyring file `foo.gpg` that contains the keys for the foo keyring in the
118 directory +{pkgdatadir}/keyrings+.
120 Optionally, the file `foo-trusted` can be provided containing a list of trusted
121 key IDs for that keyring. This is a file in a format compatible with 'gpg
122 \--export-ownertrust' output. This file will inform the user which keys a user
123 needs to verify and sign to build a local web of trust, in addition to
124 assigning provided owner trust values.
126 Also optionally, the file `foo-revoked` can be provided containing a list of
127 revoked key IDs for that keyring. Revoked is defined as "no longer valid for
128 any signing", so should be used with prudence. A key being marked as revoked
129 will be disabled in the keyring and no longer treated as valid, so this always
130 takes priority over it's trusted state in any other keyring.
133 See Also
134 --------
135 linkman:pacman[8], linkman:pacman.conf[5]
137 include::footer.txt[]