expand docs

[zpackage] / doc / zpm-rmpackage.8

diff --git a/doc/zpm-rmpackage.8 b/doc/zpm-rmpackage.8
new file mode 100644 (file)
index 0000000..cffd87c
--- /dev/null
+++ b/doc/zpm-rmpackage.8
@@ -0,0 +1,63 @@
+.TH zpm-rmpackage 8 2019-02-15 "ZPM 0.3"
+.SH NAME
+zpm-rmpackage \- remove packages from a database
+.SH SYNOPSIS
+               f) pkgfile="$OPTARG" ;;
+               v) verbose=1 ;;
+               m) message="$OPTARG" ;;
+.B zpm rmpackage
+[
+.BI -f " pkgfile"
+]
+[
+.BI -m " message"
+]
+[
+.B -v
+]
+.RI [ package ...]
+.SH DESCRIPTION
+\fBzpm-rmpackage\fR
+removes packages from a zpm database and logs a message.  This is
+potentially dangerous.  No checking as to the status of the
+package is made, so it is possible to remove a package from the
+database even if it is installed.  This program is intended to
+be run from garbage collection utilities or by package maintainers
+rather than as a normal part of system administration.
+.PP
+Packages to be removed are given as package id arguments, which
+may be abbreviated, and will be looked up via
+.BR zpm-findpkg (8).
+If a package is not found, it is not an error.  A message will
+be printed to stderr in this case if the -v option is given.
+.PP
+A log message will be entered into the zpm log for each package removed with an
+action of 'rmpackage'.
+An optional message to put in the log can be given with the -m option.  
+.SH OPTIONS
+.TP
+.BI \-f path
+specify the package file to find packages in
+.TP
+.BI \-m message
+specify a message for each log message.
+.TP
+.B \-v
+Verbose mode.
+.SH EXAMPLES
+.TP
+.B zpm rmpackage foo
+Removes a foo package as found with zpm-findpkg from the default database.
+.SH EXIT STATUS
+0 on success non zero on failure
+.SH FILES
+/var/lib/zpm/local.db
+.SH ENVIRONMENT
+ZPMDB
+ZPM_PACKAGEFILE
+.SH AUTHOR
+Nathan Wagner
+.SH SEE ALSO
+.BR zpm (8)
+.BR zpm-findpackage (8)
+.BR zpm-log (8)