remove stray debug fprintf

[zpackage] / doc / zpm-update.8

diff --git a/doc/zpm-update.8 b/doc/zpm-update.8
index 638b06a740eaa3907ca3e5ce946b7feb79409b08..90e6929e6c2eee504543f7e15406ce3859fd7091 100644 (file)
--- a/doc/zpm-update.8
+++ b/doc/zpm-update.8
@@ -1,4 +1,4 @@
-.TH zpm-update 8 2018-12-10 "ZPM 0.4"
+.TH zpm-update 8 2019-02-19 "ZPM 0.4"
 .SH NAME
 zpm-update \- update set of installed packages
 .SH SYNOPSIS
@@ -7,7 +7,7 @@ zpm-update \- update set of installed packages
 .BI -f " pkgfile"
 ]
 [
-.B -LAOUn
+.B -LAOUnzvpSCl
 ]
 .RI [ \fB[+|-]\fIpackage ...]
 .SH DESCRIPTION
@@ -15,7 +15,9 @@ zpm-update \- update 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
@@ -36,27 +38,64 @@ In other words, all of the packages given are updated, removed, installed at
 the same time, rather than taking each package one at a time and installing,
 updating, or removing it.  If the admin wants to do the packages one at a time,
 zpm-update can be run multiple times.
+.PP
+Either the package update process, or package scripts may
+put notes in the database with information for the sysadmin.
+zpm-note should be run after updates to check for these.
+.SS Package Search
+Packages will be searched for in *.repo files, the local database, and
+in individual zpm package files.  These are looked for by default
+in /var/lib/zpm/*.repo /var/lib/zpm/packages/*.zpm and the usual
+location for the local database.
 .SH OPTIONS
 .TP
-\-f
+.B \-f
 specify the package file to find packages in
 .TP
-\-n
+.B \-n
 perform a dry run.  This option calls zpm-syncfs in dry-run mode,
 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
-\-L
-Don't check for library dependencies
+.B \-l
+Just list the computed set of packages to update.
+.TP
+.BI \-R rootdir
+Specify a root directory for the package installs.  Files will be
+installed relative to this directory.
+.TP
+.B \-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
+.B \-C
+Don't run package configure scripts.  Any skipped scripts will have a note
+added.
+.TP
+.B \-v
+Run syncfs in verbose mode.  This flag is passed on to zpm-syncfs.
+.TP
+.B \-p
+Passed to zpm-syncfs to control the type of progress meter.
+.TP
+.B \-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
+.B \-L
+Don't check for library dependencies, passed on to zpm-search.
 .TP
-\-A
+.B \-A
 run zpm-syncfs in accept mode
 .TP
-\-O
+.B \-O
 run zpm-syncfs in overwrite mode mode
 .TP
-\-U
+.B \-U
 Treat unmarked packages as packages to be uninstalled.
 .SH EXAMPLES
 .TP
@@ -78,11 +117,12 @@ the vim package.
 .SH FILES
 /var/lib/zpm/local.db
 .SH ENVIRONMENT
-ZPMDB
+ZPMDB ZPM_ROOT_DIR
 .SH AUTHOR
 Nathan Wagner
 .SH SEE ALSO
 .BR zpm (8)
+.BR zpm-search (8)
 .BR zpm-script (8)
 .BR zpm-repo (8)
 .BR zpm-syncfs (8)