From 406c9b66b4f2cc54ea59e57de92db6566e59c4e7 Mon Sep 17 00:00:00 2001 From: Florian Pritz Date: Sun, 7 Aug 2016 15:37:23 +0200 Subject: Document contrib/verify-pacman-repo-db.pl Signed-off-by: Florian Pritz --- contrib/doc/.gitignore | 1 + contrib/doc/Makefile.am | 5 ++- contrib/doc/verify-pacman-repo-db.1.txt | 60 +++++++++++++++++++++++++++++++++ 3 files changed, 65 insertions(+), 1 deletion(-) create mode 100644 contrib/doc/.gitignore create mode 100644 contrib/doc/verify-pacman-repo-db.1.txt (limited to 'contrib/doc') 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* :: + 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[] -- cgit v1.2.3-70-g09d2