From: Nathan Wagner <nw@hydaspes.if.org>
Date: Wed, 6 Feb 2019 02:41:22 +0000 (+0000)
Subject: documentation improvements
X-Git-Tag: v0.5.0~27
X-Git-Url: https://pd.if.org/git/?p=zpackage;a=commitdiff_plain;h=5f0b43957752b1f5a3d91a6cb9b6c56cbd64efb8

documentation improvements
---

diff --git a/doc/zpm-update.8 b/doc/zpm-update.8
index 96e700b..301ef60 100644
--- a/doc/zpm-update.8
+++ b/doc/zpm-update.8
@@ -7,15 +7,25 @@ zpm-update \- update set of installed packages
 .BI -f " pkgfile"
 ]
 [
-.B -LAOUn
+.B -LAOUnzvpSC
 ]
+		d) localdb="$OPTARG" ;;
+		P) packagepath="$OPTARG" ;;
+		D) packagepath="$OPTARG:$packagepath" ;;
+		R) rootdir="$OPTARG" ;;
+
+		b) backup=1 ;;
+		B) backup=0 ;;
+		l) justlist=1 ;;
 .RI [ \fB[+|-]\fIpackage ...]
 .SH DESCRIPTION
 \fBzpm-update\fR changes the set of installed packages.
 It can install, remove, or update a set of packages as given on the command
 line.  It will search defined repositories for packages, and download, merge,
 and prepare the packages and the local database.  By itself, zpm-update just
-prepares the system for the file operations and runs package scripts.
+prepares the system for the file operations and runs package scripts.  Actual
+filesystem actions (i.e. removing or installing of files in the file system)
+is delegated to zpm-syncfs.
 .PP
 Packages may be specified by a full package id triple, or any
 shortened version of one (i.e. a package may be given by name, name
@@ -52,6 +62,31 @@ and doesn't run any package scripts.  Since scripts aren't run
 and no files are changed, this can only detect and report some
 types of errors.
 .TP
+\-R \fIrootdir\fR
+Specify a root directory for the package installs.  Files will be
+installed relative to this directory.
+.TP
+\-S
+Don't run any package pre or post scripts.  Normally zpm-update will run
+package pre and post scripts associated with packages being removed, updated,
+or installed.  See zpm-script(8) for details.  If any scripts are skipped due
+to the option, a note will be added.
+.TP
+\-C
+Don't run package configure scripts.  Any skipped scripts will have a note
+added.
+.TP
+\-v
+Run syncfs in verbose mode.  This flag is passed on to zpm-syncfs.
+.TP
+\-p
+Passed to zpm-syncfs to control the type of progress meter.
+.TP
+\-z
+Don't pull remote repositories before searching for packages, by
+default all remote repos are refreshed with repo pull before
+commencing a search for new packages.
+.TP
 \-L
 Don't check for library dependencies, passed on to zpm-search.
 .TP
@@ -83,7 +118,7 @@ the vim package.
 .SH FILES
 /var/lib/zpm/local.db
 .SH ENVIRONMENT
-ZPMDB
+ZPMDB ZPM_ROOT_DIR
 .SH AUTHOR
 Nathan Wagner
 .SH SEE ALSO