diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/.gitignore | 1 | ||||
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/index.txt | 1 | ||||
| -rw-r--r-- | doc/makepkg.8.txt | 9 | ||||
| -rw-r--r-- | doc/pacman-key.8.txt | 85 | ||||
| -rw-r--r-- | doc/pacman.8.txt | 38 | ||||
| -rw-r--r-- | doc/pacman.conf.5.txt | 8 |
7 files changed, 119 insertions, 27 deletions
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/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/makepkg.8.txt b/doc/makepkg.8.txt index 3b83015e..c59800c6 100644 --- a/doc/makepkg.8.txt +++ b/doc/makepkg.8.txt @@ -52,8 +52,9 @@ Options Removes all cached source files from the directory specified in `SRCDEST` in linkman:makepkg.conf[5]. -*--config* <`/path/to/config`>:: - Use an alternate config file instead of the `{sysconfdir}/makepkg.conf` default; +*\--config* <file>:: + Use an alternate config file instead of the `{sysconfdir}/makepkg.conf` + default. *-d, \--nodeps*:: Do not perform any dependency checks. This will let you override and @@ -117,7 +118,7 @@ Options `\--noextract` option if you wish to tweak the files in src/ before building. -*-p* <`buildscript`>:: +*-p* <buildscript>:: Read the package script `buildscript` instead of the `PKGBUILD` default; see linkman:PKGBUILD[5]. @@ -149,7 +150,7 @@ Options remote builder, or a tarball upload. Because integrity checks are verified, all source files of the package need to be present or downloadable. -*\--pkg <`list`>*:: +*\--pkg <list>*:: Only build listed packages from a split package. The use of quotes is necessary when specifying multiple packages. e.g. `--pkg "pkg1 pkg3"` diff --git a/doc/pacman-key.8.txt b/doc/pacman-key.8.txt new file mode 100644 index 00000000..9bd135ce --- /dev/null +++ b/doc/pacman-key.8.txt @@ -0,0 +1,85 @@ +///// +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 +----------- +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>:: + 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 +------- +*-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. + +*-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 the specified keyid to 'stdout'. If no keyid is + specified, all keys will be exported. + +*-f, \--finger* [keyid ...]:: + List a fingerprint for each specified keyid, or for all known keys if no + keyids are specified. + +*-h, \--help*:: + Output syntax and command line options. + +*-l, \--list*:: + Equivalent to --list-sigs from GnuPG. + +*-r, \--receive* keyserver keyid ...:: + 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. + +*-v, \--version*:: + Displays the program version. + + +See Also +-------- +linkman:pacman[8], linkman:pacman.conf[5] + +include::footer.txt[] diff --git a/doc/pacman.8.txt b/doc/pacman.8.txt index 249c774e..b727269b 100644 --- a/doc/pacman.8.txt +++ b/doc/pacman.8.txt @@ -55,7 +55,7 @@ Operations removed, in which case every package in that group will be removed. Files belonging to the specified package will be deleted, and the database will be updated. Most configuration files will be saved - with a `.pacsave` extension unless the '\--nosave' option is used. + with a '.pacsave' extension unless the '\--nosave' option is used. See <<RO,Remove Options>> below. *-S, \--sync*:: @@ -115,16 +115,16 @@ greater than `1:3.6-1`. Options ------- -*-b, \--dbpath* <'path'>:: +*-b, \--dbpath* <path>:: Specify an alternative database location (a typical default is - ``{localstatedir}/lib/pacman''). This should not be used unless you know what you are + `{localstatedir}/lib/pacman`). This should not be used unless you know what you are doing. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. -*-r, \--root* <'path'>:: - Specify an alternative installation root (default is ``/''). This should - not be used as a way to install software into ``/usr/local'' instead of - ``/usr''. This option is used if you want to install a package on a +*-r, \--root* <path>:: + Specify an alternative installation root (default is `/`). This should + not be used as a way to install software into `/usr/local` instead of + `/usr`. This option is used if you want to install a package on a temporary mounted partition which is "owned" by another system. *NOTE*: if database path or logfile are not specified on either the command line or in linkman:pacman.conf[5], their default location will @@ -133,23 +133,23 @@ Options *-v, \--verbose*:: Output paths such as as the Root, Conf File, DB Path, Cache Dirs, etc. -*\--arch* <'arch'>:: +*\--arch* <arch>:: Specify an alternate architecture. -*\--cachedir* <'dir'>:: +*\--cachedir* <dir>:: Specify an alternative package cache location (a typical default is - ``{localstatedir}/cache/pacman/pkg''). Multiple cache directories can be specified, + `{localstatedir}/cache/pacman/pkg`). Multiple cache directories can be specified, and they are tried in the order they are passed to pacman. *NOTE*: this is an absolute path, the root path is not automatically prepended. -*\--config* <'file'>:: +*\--config* <file>:: Specify an alternate configuration file. *\--debug*:: Display debug messages. When reporting bugs, this option is recommended to be used. -*\--logfile* <'file'>:: +*\--logfile* <file>:: Specify an alternate log file. This is an absolute path, regardless of the installation root setting. @@ -182,7 +182,7 @@ Transaction Options (apply to '-S', '-R' and '-U') displayed. The default format string is "%l", which displays URLs with '-S', filenames with '-U' and pkgname-pkgver with '-R'. -*\--print-format* <'format'>:: +*\--print-format* <format>:: Specify a printf-like format to control the output of the '\--print' operation. The possible attributes are: %n for pkgname, %v for pkgver, %l for location, %r for repo and %s for size. @@ -207,12 +207,12 @@ Upgrade Options (apply to '-S' and '-U')[[UO]] as explicitly installed so it will not be removed by the '\--recursive' remove operation. -*\--ignore* <'package'>:: +*\--ignore* <package>:: Directs pacman to ignore upgrades of package even if there is one available. Multiple packages can be specified by separating them with a comma. -*\--ignoregroup* <'group'>:: +*\--ignoregroup* <group>:: Directs pacman to ignore upgrades of all packages in 'group' even if there is one available. Multiple groups can be specified by separating them with a comma. @@ -257,7 +257,7 @@ Query Options[[QO]] database(s). Typically these are packages that were downloaded manually and installed with '\--upgrade'. -*-o, \--owns* <'file'>:: +*-o, \--owns* <file>:: Search for packages that own the specified file(s). The path can be relative or absolute and one or more files can be specified. @@ -276,7 +276,7 @@ Query Options[[QO]] and missing files; a bare query will only show package names rather than names and versions. -*-s, \--search* <'regexp'>:: +*-s, \--search* <regexp>:: Search each locally-installed package for names or descriptions that match `regexp`. When including multiple search terms, only packages with descriptions matching ALL of those terms are returned. @@ -302,7 +302,7 @@ Remove Options[[RO]] *-n, \--nosave*:: Instructs pacman to ignore file backup designations. Normally, when a file is removed from the system the database is checked to see if the - file should be renamed with a ``.pacsave'' extension. + file should be renamed with a '.pacsave' extension. *-s, \--recursive*:: Remove each target specified including all of their dependencies, provided @@ -354,7 +354,7 @@ linkman:pacman.conf[5]. will only show package names and omit databases and versions; group will only show package names and omit group names. -*-s, \--search* <'regexp'>:: +*-s, \--search* <regexp>:: This will search each package in the sync databases for names or descriptions that match `regexp`. When you include multiple search terms, only packages with descriptions matching ALL of those terms will diff --git a/doc/pacman.conf.5.txt b/doc/pacman.conf.5.txt index cb4c5898..bfa07458 100644 --- a/doc/pacman.conf.5.txt +++ b/doc/pacman.conf.5.txt @@ -57,13 +57,13 @@ Options *DBPath =* path/to/db/dir:: Overrides the default location of the toplevel database directory. A - typical default is ``{localstatedir}/lib/pacman/''. Most users will not need to set + typical default is `{localstatedir}/lib/pacman/`. Most users will not need to set this option. *NOTE*: if specified, this is an absolute path and the root path is not automatically prepended. *CacheDir =* path/to/cache/dir:: Overrides the default location of the package cache directory. A typical - default is ``{localstatedir}/cache/pacman/pkg/''. Multiple cache directories can be + default is `{localstatedir}/cache/pacman/pkg/`. Multiple cache directories can be specified, and they are tried in the order they are listed in the config file. If a file is not found in any cache directory, it will be downloaded to the first cache directory with write access. *NOTE*: this is an absolute @@ -72,7 +72,7 @@ Options *LogFile =* '/path/to/file':: Overrides the default location of the pacman log file. A typical default - is ``{localstatedir}/log/pacman.log''. This is an absolute path and the root directory + is `{localstatedir}/log/pacman.log`. This is an absolute path and the root directory is not prepended. *HoldPkg =* package ...:: @@ -149,7 +149,7 @@ Options *UseSyslog*:: Log action messages through syslog(). This will insert log entries into - ``{localstatedir}/log/messages'' or equivalent. + `{localstatedir}/log/messages` or equivalent. *ShowSize*:: Display the size of individual packages for '\--sync' and '\--query' modes. |