diff mbox

paccache: add man page

Message ID 20180614172432.24677-1-straubem@gmx.de
State Accepted, archived
Headers show

Commit Message

Michael Straube June 14, 2018, 5:24 p.m. UTC
The main purpose of adding a man page is to document the new
systemd timer. So users are aware it exists.

Signed-off-by: Michael Straube <straubem@gmx.de>
---
 doc/Makefile.am    |  4 +++
 doc/paccache.8.txt | 85 ++++++++++++++++++++++++++++++++++++++++++++++
 src/paccache.sh.in |  2 +-
 3 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 doc/paccache.8.txt

Comments

Johannes Löthberg June 21, 2018, 8:46 p.m. UTC | #1
Quoting Michael Straube (2018-06-14 19:24:32)
> The main purpose of adding a man page is to document the new
> systemd timer. So users are aware it exists.
> 
> Signed-off-by: Michael Straube <straubem@gmx.de>

Merged, thanks!
diff mbox

Patch

diff --git a/doc/Makefile.am b/doc/Makefile.am
index b44319d..cf48bb5 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,9 +4,11 @@ 
 # man_MANS if --enable-asciidoc and/or --enable-doxygen are used.
 
 ASCIIDOC_MANS = \
+	paccache.8 \
 	pactree.8
 
 HTML_MANPAGES = \
+	paccache.8.html \
 	pactree.8.html
 
 HTML_OTHER = \
@@ -19,6 +21,7 @@  HTML_DOCS = \
 EXTRA_DIST = \
 	asciidoc.conf \
 	asciidoc-override.css \
+	paccache.8.txt \
 	pactree.8.txt \
 	footer.txt \
 	$(ASCIIDOC_MANS)
@@ -94,6 +97,7 @@  $(HTML_OTHER): asciidoc.conf Makefile.am
 %.3.html: ASCIIDOC_OPTS += -d manpage
 
 # Dependency rules
+paccache.8 paccache.8.html: paccache.8.txt
 pactree.8 pactree.8.html: pactree.8.txt
 
 # vim:set noet:
diff --git a/doc/paccache.8.txt b/doc/paccache.8.txt
new file mode 100644
index 0000000..db81283
--- /dev/null
+++ b/doc/paccache.8.txt
@@ -0,0 +1,85 @@ 
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+paccache(8)
+=========
+
+Name
+----
+paccache - flexible pacman cache cleaning utility
+
+
+Synopsis
+--------
+'paccache' <operation> [options] [targets...]
+
+
+Description
+-----------
+Paccache removes old packages from the pacman cache directory.
+By default the last three versions of a package are kept.
+
+
+Operations
+----------
+*-d, \--dryrun*::
+	Perform a dry run, only finding candidate packages.
+
+*-m, \--move <dir>*::
+	Move candidate packages from the cache directory to 'dir'.
+
+*-r, \--remove*::
+	Remove candidate packages from the cache directory.
+
+
+Options
+-------
+*-a, \--arch <arch>*::
+	Scan for packages for a specific architecture. Default is to scan for
+	all architectures.
+
+*-c, \--cachedir <dir>*::
+	Specify a different cache directory. This option can be used more than once.
+	Default is to use the cache directory configured in 'pacman.conf'.
+
+*-f, \--force*::
+	Apply force to 'mv' and 'rm' operations.
+
+*-h, \--help*::
+	Display syntax and command line options.
+
+*-i, \--ignore <pkgs>*::
+	Specify packages to ignore, comma-separated. Alternatively "-" can be used
+	to read the package names from stdin, newline-delimited.
+
+*-k, \--keep <num>*::
+	Specify how many versions of each package are kept in the cache directory,
+	default is 3.
+
+*\--nocolor*::
+	Remove color from the output.
+
+*-q, \--quiet*::
+	Minimize the output.
+
+*-u, \--uninstalled*::
+	Target uninstalled packages.
+
+*-v, \--verbose*::
+	Increase verbosity, can be specified up to 3 times.
+
+*-z, \--null*::
+	Use null delimiters for candidate names (only with -v and -vv).
+
+
+Systemd Timer
+-------------
+The package cache can be cleaned periodically using the systemd timer 'paccache.timer'.
+If the timer is enabled the cache will be cleaned weekly with paccache's default options.
+
+
+See Also
+--------
+linkman:pacman[8], linkman:pacman.conf[5], linkman:systemctl[1]
+
+include::footer.txt[]
diff --git a/src/paccache.sh.in b/src/paccache.sh.in
index 135954f..012ba9f 100644
--- a/src/paccache.sh.in
+++ b/src/paccache.sh.in
@@ -1,6 +1,6 @@ 
 #!/bin/bash
 #
-# pacache - flexible pacman cache cleaning
+# paccache - flexible pacman cache cleaning
 #
 # Copyright (C) 2011 Dave Reisner <dreisner@archlinux.org>
 #