summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJelle van der Waa <jelle@vdwaa.nl>2019-02-21 13:20:19 +0100
committerAllan McRae <allan@archlinux.org>2019-03-07 11:12:12 +1000
commit377d47142f7aaa01ca782e6587f2d4caf663865b (patch)
tree4dd199a59568d1da9dc50c6e30dd4c7fd680d0fe
parent298bcf7986ca5500c8891ec412d65d8a8f5b9a4f (diff)
downloadpacman-377d47142f7aaa01ca782e6587f2d4caf663865b.tar.gz
pacman-377d47142f7aaa01ca782e6587f2d4caf663865b.zip
doc: add man page for pacman-conf
Signed-off-by: Jelle van der Waa <jelle@vdwaa.nl> Signed-off-by: Allan McRae <allan@archlinux.org>
-rw-r--r--doc/Makefile.am3
-rw-r--r--doc/meson.build1
-rw-r--r--doc/pacman-conf.8.asciidoc67
3 files changed, 70 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index e03d6ab8..d6eaa67d 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 d6403bae..774a5c0b 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[]