expand docs

[zpackage] / doc / zpm-parse.8

diff --git a/doc/zpm-parse.8 b/doc/zpm-parse.8
new file mode 100644 (file)
index 0000000..be40671
--- /dev/null
+++ b/doc/zpm-parse.8
@@ -0,0 +1,45 @@
+.TH zpm-parse 8 2019-02-14 "ZPM 0.3"
+.SH NAME
+zpm-parse \- parse a package string
+.SH SYNOPSIS
+.B zpm parse
+[
+.B -nvrE
+]
+.I pkgstring
+.SH DESCRIPTION
+\fBzpm-parse\fR
+parses a package string into its components and prints them separated
+by a space to stdout.  By default, it prints the name, version, and
+release.  The default output is equivalent to the -nvr options.
+If a given component is not present, the corresponding field is not
+printed.
+.SH OPTIONS
+.TP
+\-n
+print the name
+.TP
+\-v
+print the version
+.TP
+\-r
+print the release
+.TP
+\-E
+Print the output in a form that can be evaled by a shell.  The
+variable names are "name", "version", and "release".
+.SH EXAMPLES
+.TP
+zpm parse foo-1.0-1
+Prints "foo 1.0 1" to stdout.
+.SH EXIT STATUS
+0 on success non zero if the given string can't be parsed even as
+an incomplete package string.
+.SH FILES
+None.
+.SH ENVIRONMENT
+None.
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+.BR zpm (8)