aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorkitsunyan2018-03-10 21:10:43 +0000
committerkitsunyan2018-03-10 21:10:43 +0000
commitfd397b356e9be1d3572ace965ead57120803a0ac (patch)
treed9e6fe9f903ab935fa6df2e6862a97515caf926c /doc
Initial commitv0.1
Diffstat (limited to 'doc')
-rw-r--r--doc/asciidoc.conf8
-rw-r--r--doc/pakku.8.txt46
-rw-r--r--doc/pakku.conf.5.txt41
3 files changed, 95 insertions, 0 deletions
diff --git a/doc/asciidoc.conf b/doc/asciidoc.conf
new file mode 100644
index 0000000..1872c0d
--- /dev/null
+++ b/doc/asciidoc.conf
@@ -0,0 +1,8 @@
+[macros]
+(?su)[\\]?(?P<name>linkman):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
+
+[linkman-inlinemacro]
+{0%{target}}
+{0#<citerefentry>}
+{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
+{0#</citerefentry>}
diff --git a/doc/pakku.8.txt b/doc/pakku.8.txt
new file mode 100644
index 0000000..5f183db
--- /dev/null
+++ b/doc/pakku.8.txt
@@ -0,0 +1,46 @@
+pakku(8)
+========
+
+Name
+----
+pakku - package manager utility wrapper
+
+Synopsis
+--------
+'pakku' <operation> [options] [targets]
+
+Description
+-----------
+Pakku is a pacman wrapper with additional features, such as AUR support.
+
+Operations and Options
+----------------------
+Pakku provides all operations and options from pacman. This page will focus
+on pakku-specific options only. See linkman:pacman[8] for additional
+information.
+
+Query Options (apply to '-Q')[[QO]]
+-----------------------------------
+*-t, \--unrequired*::
+ Specify this option thrice combining with '-d' to list dependencies
+ which are not required by any explicitly installed package.
+
+Sync Options (apply to '-S')[[SO]]
+----------------------------------
+*\--build*::
+ Build packages from source. Building is supported for directly specified
+ packages only, so it will not work for package groups or virtual packages.
+
+*\--noaur*::
+ Disable AUR support. This option is assumed when you use non-standard
+ root path, allow downgrading using twice specified '-u', skip dependency
+ checking using '-d', or run the program from root.
+
+Configuration
+-------------
+See linkman:pacman.conf[5] and linkman:pakku.conf[5] for details on configuring
+the program.
+
+See Also
+--------
+linkman:pacman[8], linkman:pacman.conf[5], linkman:pakku.conf[5]
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]