update rmpackage

[zpackage] / doc / zpm-findpkg.8

diff --git a/doc/zpm-findpkg.8 b/doc/zpm-findpkg.8
new file mode 100644 (file)
index 0000000..9b34258
--- /dev/null
+++ b/doc/zpm-findpkg.8
@@ -0,0 +1,78 @@
+.TH zpm-findpkg 8 2019-02-22 "ZPM 0.3"
+.SH NAME
+zpm-findpkg \- find package ids
+.SH SYNOPSIS
+.B zpm findpkg
+[
+.BI \-f " pkgfile"
+]
+[
+.B \-Imre
+]
+[
+.BI \-s status
+]
+[
+.BI \-S status
+]
+.I package
+[
+.I package
+]
+.SH DESCRIPTION
+\fBzpm-findpkg\fR
+finds packages in package databases.  A package may be specified as
+an incomplete package id.  If found, the full package id will
+be printed to stdout.  Where more than one package matches,
+the latest one (as if by zpm-vercmp) will be found.
+.PP
+If two arguments are given, they form an inclusive range of packages.
+Either may be a partial package id, but both must have the same
+package name.
+.SH OPTIONS
+.TP
+.BI \-f package
+specify the package file to find packages in
+.TP
+.B \-I
+Only find installed packages.  Equivalent to \fB\-s installed\fR.
+.TP
+.B \-m
+This reverses the sense of the arguments.  The first argument is
+taken as the maximum package version to find.  A second argument,
+if given, is taken as the minimum.  Implies \-r.
+.TP
+.B \-r
+Find package within a range, rather than an exact match.  The
+first package argument is the inclusive lower bound.  The second
+argument, if provides, is the inclusive upper bound.  If no
+second argument is given, there is no upper bound.
+This option is implied if two arguments are given.
+.TP
+.B \-l
+Find the earliest package in a range, as if compared by zpm-vercmp.
+Implies \-r.
+.TP
+.BI \-s status
+Add \fIstatus\fR to the set of package statuses to match.  If the
+list is empty, any status will match.
+.TP
+.BI \-S status
+Add \fIstatus\fR to the set of package statuses to exclude from
+matching.  If a given status is listed both in include and exclude,
+the package status will be excluded.
+.SH EXAMPLES
+.TP
+.B zpm findpkg foo
+find the latest version of foo in the default database.
+.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-vercmp (8)