expand docs

[zpackage] / doc / zpm-shell.8

diff --git a/doc/zpm-shell.8 b/doc/zpm-shell.8
new file mode 100644 (file)
index 0000000..01caccc
--- /dev/null
+++ b/doc/zpm-shell.8
@@ -0,0 +1,26 @@
+.TH zpm-shell 8 2019-02-14 "ZPM 0.3"
+.SH NAME
+zpm-shell \- list files in a zpm package
+.SH SYNOPSIS
+.B zpm shell
+.SH DESCRIPTION
+\fBzpm-shell\fR is a custom build sqlite3 shell, with vercmp added
+as a collation functions.  It is indended for zpm scripting, rather
+than general use as it lacks readline and history support.
+.SH OPTIONS
+Any options are passed through to the general sqlite3 shell.
+.SH EXAMPLES
+.TP
+zpm shell $ZPMDB 'select package from packages'
+Will run the given query against an sqlite3 database found in $ZPMDB
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+None.
+.SH ENVIRONMENT
+Same as sqlite3
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+.BR zpm (8)
+.BR sqlite3 (1)