update search

[zpackage] / doc / zpm-search.8

diff --git a/doc/zpm-search.8 b/doc/zpm-search.8
new file mode 100644 (file)
index 0000000..d711e1d
--- /dev/null
+++ b/doc/zpm-search.8
@@ -0,0 +1,98 @@
+.TH zpm-search 8 2019-02-16 "ZPM 0.5"
+.SH NAME
+zpm-search \- search repositories for packages
+.SH SYNOPSIS
+.B zpm search
+[
+.B -ljqiIOfPRDMvn
+]
+[
+.BI -d " localdb"
+]
+[
+.BI -p " packagedir"
+]
+[
+.BI -r " repodir"
+]
+.RI [ package ...]
+.SH DESCRIPTION
+\fBzpm-search\fR
+searches for packages in repositories, the local database, and
+a directory of package files.  Packages needed for library
+dependencies will be recursively searched for.
+.SH OPTIONS
+.TP
+.BI \-d localdb
+Specify the local database, if other than the default local database.
+.TP
+.BI \-p packagedir
+Specify a directory to search for packages in.  Defaults to
+/var/lib/zpm/packages
+.TP
+.BI \-r repodir
+Specify the directory to find repository information in.  Defaults
+to /var/lib/zpm/repo
+.TP
+.B \-i
+Match against installed packages.  Normally, packages are searched
+for against the local database, but the output omits packages that
+are already installed.  This option adds found but installed packages
+to the output.
+.TP
+.B \-l
+In addition to finding packages, also find packages supplying libraries
+needed by found packages.
+.TP
+.B \-I
+Suppress installed.
+.TP
+.B \-O
+Only local installed.
+.TP
+.B \-j
+Output results in json format.  You will get a list with the \-n option,
+or an object of package id to location without the \-n option.  A list
+of object is always output, even if empty.
+.TP
+.B \-f
+Only output found packages.  Normally it is an error if a package
+can't be found.  This option makes that not an error, and suppresses
+printing unfound packages to stderr.
+.TP
+.B \-q
+Suppress output.  The exit status is the same as it would otherwise be.
+.TP
+.B \-v
+Increase verbosity.  May be given multiple times.
+.TP
+.B \-M
+Match all package files.  Normally when looking at files ending in .zpm,
+packages will only be searched for if the filename has the package id
+as a prefix.  This is an optimization to speed up the search.
+.TP
+.B \-P
+Don't look in the package directory.
+.TP
+.B \-R
+Don't search repositories.
+.TP
+.B \-D
+Don't search the local database.
+.TP
+.B \-n
+list package names only, not name and location found.
+.SH EXAMPLES
+.TP
+.B zpm search
+lists all files in the local 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)