From: Nathan Wagner <nw@hydaspes.if.org>
Date: Mon, 10 Dec 2018 11:57:57 +0000 (+0000)
Subject: add update man page
X-Git-Tag: v0.4.3~4
X-Git-Url: https://pd.if.org/git/?p=zpackage;a=commitdiff_plain;h=eb29765346e82eb2bf00771b161b75e03055704f

add update man page
---

diff --git a/doc/zpm-update.8 b/doc/zpm-update.8
new file mode 100644
index 0000000..638b06a
--- /dev/null
+++ b/doc/zpm-update.8
@@ -0,0 +1,88 @@
+.TH zpm-update 8 2018-12-10 "ZPM 0.4"
+.SH NAME
+zpm-update \- update set of installed packages
+.SH SYNOPSIS
+.B zpm update
+[
+.BI -f " pkgfile"
+]
+[
+.B -LAOUn
+]
+.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.
+.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
+and version, or name, version, and release).
+.PP
+Packages may have an optional '+' or '-' prefix.  Packages
+marked with '+' are set to be installed, or updated if a package
+with the same name is already installed.  Packages marked with
+a '-' are set to be uninstalled if they are installed.
+By default, unmarked packages are treated as marked with a '+'.
+The default can be changed to uninstall with the \fB-U\fR option.
+.PP
+Once the set of packages to installed or uninstalled is determined and set up,
+zpm-syncfs is called to do the actual file operations.  This is an
+"all-at-once" action in the sense that the whole set of file actions is
+considered and no concern is given to which specific package a file belongs to.
+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.
+.SH OPTIONS
+.TP
+\-f
+specify the package file to find packages in
+.TP
+\-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
+.TP
+\-A
+run zpm-syncfs in accept mode
+.TP
+\-O
+run zpm-syncfs in overwrite mode mode
+.TP
+\-U
+Treat unmarked packages as packages to be uninstalled.
+.SH EXAMPLES
+.TP
+zpm update vim
+Install or update the vim package to the latest package found.
+.TP
+zpm update -- -vim
+Uninstall the vim package if it installed.  The '--' is necessary
+to the system doesn't think you are passing a -v option to zpm update.
+.TP
+zpm update -U vim
+Uninstall the vim package if it installed.
+.TP
+zpm update ed -vim
+Install or update ed to the latest version available, and remove
+the vim package.
+.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-script (8)
+.BR zpm-repo (8)
+.BR zpm-syncfs (8)