support for package dependencies

[zpackage] / doc / zpm-pkgdeps.8

diff --git a/doc/zpm-pkgdeps.8 b/doc/zpm-pkgdeps.8
new file mode 100644 (file)
index 0000000..cdda376
--- /dev/null
+++ b/doc/zpm-pkgdeps.8
@@ -0,0 +1,77 @@
+.TH zpm-pkgdeps 8 2019-02-22 "ZPM 0.3"
+.SH NAME
+zpm-pkgdeps \- run pkgdeps
+.SH SYNOPSIS
+               f) pkgfile="$OPTARG" ;;
+               s) setlist="$setlist $OPTARG"; clearlist=1 ;;
+               a) add="$add $OPTARG"; ;;
+               r) remove="$remove $OPTARG" ;;
+               q) quiet=1 ;;
+               c) clearlist=1 ;;
+.B zpm pkgdeps
+[
+.BI \-f " pkgfile"
+]
+[
+.B \-qc
+]
+[
+.BI \-s " dep"
+]
+[
+.BI \-a " dep"
+]
+[
+.BI \-r " dep"
+]
+.RI [ package ...]
+.SH DESCRIPTION
+\fBzpm-pkgdeps\fR
+manipulates and prints the set of package dependencies of a package.
+The non-argument \fIpackage\fR is a full or partial package id,
+and will be looked as if by zpm-findpkg.  A package dependency
+is a full or partial package id, which is taken as a minimum package
+version.  After any updates are made, the (new) set of dependencies
+is printed to stdout on one line.
+.PP
+Actions to set, add, or remove dependencies are done in the order
+of clearing the set, adding dependencies, and then removing dependencies.
+It is not an error if a dependency to remove is not present.
+.PP
+Dependencies are package ids, and thus can't have whitespace or illegal
+characters.  Illegal characters are not checked for, and whitespace
+will be interpreted as separating dependencies.
+.SH OPTIONS
+.TP
+.BI \-f package
+specify the package file to find packages in
+.TP
+.B \-q
+Suppress printing the set of package deps.
+.TP
+.B \-c
+Clear the set of dependencies.
+.TP
+.BI \-s " dep"
+Add a dependency to the set of dependencies to set.  Implies \-c.
+.TP
+.BI \-a " dep"
+Add a dependency to the package.
+.TP
+.BI \-r " dep"
+Remove a dependency from the package.
+.SH EXAMPLES
+.TP
+.B zpm pkgdeps vim
+List dependencies of the vim package.
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+/var/lib/zpm/local.db
+.SH ENVIRONMENT
+ZPMDB
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+.BR zpm (8)
+.BR zpm-findpkg (8)