aboutsummaryrefslogtreecommitdiff
path: root/doc/pakku.conf.5.txt
diff options
context:
space:
mode:
authorkitsunyan2018-03-10 21:10:43 +0000
committerkitsunyan2018-03-10 21:10:43 +0000
commitfd397b356e9be1d3572ace965ead57120803a0ac (patch)
treed9e6fe9f903ab935fa6df2e6862a97515caf926c /doc/pakku.conf.5.txt
Initial commitv0.1
Diffstat (limited to 'doc/pakku.conf.5.txt')
-rw-r--r--doc/pakku.conf.5.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/doc/pakku.conf.5.txt b/doc/pakku.conf.5.txt
new file mode 100644
index 0000000..5ea2460
--- /dev/null
+++ b/doc/pakku.conf.5.txt
@@ -0,0 +1,41 @@
+pakku.conf(5)
+=============
+
+Name
+----
+pakku.conf - pakku configuration file
+
+Synopsis
+--------
+\{sysconfdir\}/pakku.conf
+
+Description
+-----------
+This configuration file uses a similar format to pacman.conf. The file is
+divided into sections. Only options section is used.
+
+Options
+-------
+*TmpDir =* path/to/tmp/dir::
+ Set the temporary directory in which pakku will perform all
+ building operations. The default value is +/tmp/pakku-$\{USER\}+.
+
+*AurComments*::
+ Download and display comments for AUR packages.
+
+*CheckIgnored*::
+ Check ignored packages for updates in AUR. Pakku will be able to warn
+ about ignored package upgrade.
+
+*PrintAurNotFound*::
+ Print warnings during upgrade operation when foreign packages were not
+ found in AUR.
+
+*ViewNoDefault*::
+ When building from AUR, pakku will ask whether you want to view the
+ content of PKGBUILD and other files. Pressing enter key will give the
+ positive answer unless this option is specified.
+
+See Also
+--------
+linkman:pacman.conf[5], linkman:pakku[8]