expand docs

[zpackage] / doc / zpm-test.8

diff --git a/doc/zpm-test.8 b/doc/zpm-test.8
new file mode 100644 (file)
index 0000000..5ca373f
--- /dev/null
+++ b/doc/zpm-test.8
@@ -0,0 +1,34 @@
+.TH zpm-test 8 2019-02-14 "ZPM 0.3"
+.SH NAME
+zpm-test \- check whether files are zpm databases
+.SH SYNOPSIS
+.B zpm test
+[
+.B -v
+]
+.RI [ path ...]
+.SH DESCRIPTION
+\fBzpm-test\fR
+checks its arguments and returns success if all arguments are zpm databases.
+No check on the schema is performed, a file is considered valid if it is an
+sqlite3 database file with an application id of 0x5A504442 (decimal
+1515209794).
+.SH OPTIONS
+.TP
+\-v
+prints an error message to stderr if a package is not a zpm
+database file.
+.SH EXAMPLES
+.TP
+zpm test foo-1.0-1.zpm
+checks foo-1.0-1.zpm for validity.
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+None.
+.SH ENVIRONMENT
+None.
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+.BR zpm (8)