add quote and hash man pages

[zpackage] / doc / zpm-quote.8

diff --git a/doc/zpm-quote.8 b/doc/zpm-quote.8
new file mode 100644 (file)
index 0000000..7c77eb0
--- /dev/null
+++ b/doc/zpm-quote.8
@@ -0,0 +1,48 @@
+.TH zpm-quote 8 2018-12-08 "ZPM 0.3"
+.SH NAME
+zpm-quote \- list files in a zpm package
+.SH SYNOPSIS
+.B zpm quote
+[
+.B -qsi
+]
+[\fB-d \fIdelimiter\fR]
+.SH DESCRIPTION
+\fBzpm-quote\fR quotes its arguments so the result can
+be safely interpolated in sql statements or shell scripts.
+By default the arguments are quoted as a sql string literal.
+.SH OPTIONS
+.TP
+\-q
+add quotes around the result.
+.TP
+\-s
+quote for the shell instead of sql
+.TP
+\-i
+quote as an sql identifier
+.TP
+\-d \fIdelimiter\fR
+separate arguments with the given delimiter string.  If
+not specified, results are separated with a newline
+.SH EXAMPLES
+.Pp
+zpm quote foo -> foo
+.PP
+zpm quote -q foo -> 'foo' 
+.PP
+zpm quote -qi foo -> "foo"
+.PP
+zpm quote -q 'foo bar' -> 'foo bar'
+.PP
+zpm quote -qs "foo'bar" -> 'foo'\\''bar'
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+None
+.SH ENVIRONMENT
+None
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+zpm(8)