Signed-off-by: Jelle van der Waa <jelle@vdwaa.nl> --- doc/Makefile.am | 3 +- doc/meson.build | 1 + doc/pacman-conf.8.asciidoc | 67 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 doc/pacman-conf.8.asciidoc diff --git a/doc/Makefile.am b/doc/Makefile.am index de87c409..f68f4ea0 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -16,7 +16,8 @@ MANPAGES = \ makepkg.conf.5 \ pacman.conf.5 \ libalpm.3 \ - BUILDINFO.5 + BUILDINFO.5 \ + pacman-conf.8 DOXYGEN_MANS = $(wildcard man3/*.3) diff --git a/doc/meson.build b/doc/meson.build index b7514ef7..e4d9b98f 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -12,6 +12,7 @@ manpages = [ { 'name': 'pacman.conf.5' }, { 'name': 'libalpm.3' }, { 'name': 'BUILDINFO.5' }, + { 'name': 'pacman-conf.8' }, ] sitepages = [ diff --git a/doc/pacman-conf.8.asciidoc b/doc/pacman-conf.8.asciidoc new file mode 100644 index 00000000..c067166d --- /dev/null +++ b/doc/pacman-conf.8.asciidoc @@ -0,0 +1,67 @@ +pacman-conf(8) +============== + +Name +---- +pacman-conf - query pacman's configuration file + + +Synopsis +-------- +'pacman-conf' [options] [<directive> ...] + +'pacman-conf' (--repo-list|--help|--version) + + +Description +----------- +'pacman-conf' is a utility for parsing the 'pacman' configuration file +and returning script-friendly output. It is designed to properly handle +non-trivial configuration features such as variable interpolation and +the use of the Include directive, and guarantees that it will return the +same configuration values which 'pacman' itself would use. + +'pacman-conf' will output the fully-resolved contents of the +configuration file by default, or, if provided with the name of a +configuration directive, output the contents of the given directive alone. + + +Options +------- +*-c, \--config* <path>:: + Specify an alternate configuration file. + +*-R, \--rootdir* <path>:: + Specify an alternate installation root (default is `/`). + +*-r, \--repo* <remote>:: + Query options for a specific repository. + +*-v, \--verbose*:: + Always shown directive names. + +*-l, \--repo-list*:: + List configured repositories. + +*-h, \--help*:: + Output syntax and command line options. + +*-V, \--version*:: + Display version and exit. + + +Examples +-------- + +pacman-conf -r core Usage:: + Show the value of the Usage configuration option for core repository. + +pacman-conf HoldPkg:: + Show the value of the HoldPkg configuration option. + + +See Also +-------- +linkman:pacman.conf[5] + +include::footer.asciidoc[] -- 2.20.1