summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Pritz <bluewind@xinu.at>2016-08-07 15:37:23 +0200
committerAllan McRae <allan@archlinux.org>2016-08-30 20:08:34 +1000
commit406c9b66b4f2cc54ea59e57de92db6566e59c4e7 (patch)
treeeb3a487dcae513e729b2a8725b6fad0d11a3616b
parent6c15cc4d22e049486a5f773f5d81777b6087510b (diff)
Document contrib/verify-pacman-repo-db.pl
Signed-off-by: Florian Pritz <bluewind@xinu.at>
-rw-r--r--contrib/doc/.gitignore1
-rw-r--r--contrib/doc/Makefile.am5
-rw-r--r--contrib/doc/verify-pacman-repo-db.1.txt60
3 files changed, 65 insertions, 1 deletions
diff --git a/contrib/doc/.gitignore b/contrib/doc/.gitignore
new file mode 100644
index 00000000..c5612bca
--- /dev/null
+++ b/contrib/doc/.gitignore
@@ -0,0 +1 @@
+verify-pacman-repo-db.1
diff --git a/contrib/doc/Makefile.am b/contrib/doc/Makefile.am
index 6417ac5a..4c316bb7 100644
--- a/contrib/doc/Makefile.am
+++ b/contrib/doc/Makefile.am
@@ -3,11 +3,13 @@
# files listed in EXTRA_DIST no matter what. However, we only add them to
# man_MANS if --enable-asciidoc and/or --enable-doxygen are used.
-ASCIIDOC_MANS =
+ASCIIDOC_MANS = \
+ verify-pacman-repo-db.1
EXTRA_DIST = \
asciidoc.conf \
footer.txt \
+ verify-pacman-repo-db.1.txt \
$(ASCIIDOC_MANS)
# Files that should be removed, but which Automake does not know.
@@ -50,5 +52,6 @@ $(ASCIIDOC_MANS): asciidoc.conf footer.txt Makefile.am
$(AM_V_GEN)a2x $(A2X_OPTS) --asciidoc-opts="$(ASCIIDOC_OPTS) --out-file=./$@" $(srcdir)/$@.txt
# Dependency rules
+verify-pacman-repo-db.1: verify-pacman-repo-db.1.txt
# vim:set noet:
diff --git a/contrib/doc/verify-pacman-repo-db.1.txt b/contrib/doc/verify-pacman-repo-db.1.txt
new file mode 100644
index 00000000..62564b8f
--- /dev/null
+++ b/contrib/doc/verify-pacman-repo-db.1.txt
@@ -0,0 +1,60 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+verify-pacman-repo-db(1)
+========================
+
+Name
+----
+verify-pacman-repo-db - package repository verification utility
+
+
+Synopsis
+--------
+'verify-pacman-repo-db' [options]
+
+
+Description
+-----------
+'verify-pacman-repo-db' looks at a pacman repo database and verifies its
+content with the actual package files. The database is expected to be in
+the same directory as the packages (or symlinks to the packages).
+
+The following properties are verified for each package in the database:
+
+ - existence of the package file
+ - file size
+ - MD5 and SHA256 checksum (--checksum)
+
+Options
+-------
+*-h, \--help*::
+ Output a short help message.
+
+*\--debug*::
+ Enable debug output.
+
+*-c, \--checksum*::
+ Verify checksums of packages. Note that this means all packages files will
+ be read from disk. Otherwise only metadata is compared which does not
+ require to read package file contents.
+
+*-t, \--threads* <number>::
+ Use 'number' threads to verify packages. Note that each thread may use up
+ to approximately 128MiB of memory. Default: 1
+
+Notes
+-----
+
+This script does intentionally not use any ALPM libraries. The format is simple
+enough to be parsed and this way we might just detect more problems because the
+libalpm parsing code might also have bugs. We also stay much more portable
+which might be good for people that want to check a db, but don't actually have
+pacman installed.
+
+
+See Also
+--------
+linkman:repo-add[8]
+
+include::footer.txt[]