expand docs

[zpackage] / doc / zpm-log.8

diff --git a/doc/zpm-log.8 b/doc/zpm-log.8
new file mode 100644 (file)
index 0000000..20b48ff
--- /dev/null
+++ b/doc/zpm-log.8
@@ -0,0 +1,72 @@
+.TH zpm-log 8 2019-02-15 "ZPM 0.3"
+.SH NAME
+zpm-log \- manage the zpm log
+.SH SYNOPSIS
+.B zpm log
+[
+.BI -f " pkgfile"
+]
+[
+.BI -t " target"
+]
+[
+.BI -a " action"
+]
+[
+.BI -T " timestamp"
+]
+[
+.B -ijvr
+]
+.RI [ message ...]
+.SH DESCRIPTION
+\fBzpm-log\fR
+prints or inserts into the zpm log, which is stored in the local database,
+or the database given by the \-f option.
+.SH OPTIONS
+.TP
+.B \-f path
+specify the database file where the log is stored.  Defaults to
+$ZPMDB or /var/lib/zpm/local.db
+.TP
+.B \-t target
+Specify the target of the log.  This is generally a package id.
+When listing, this filters the log to only targets that match.
+.TP
+.B \-a action
+Specify the action taken.  This is intended to be stylized for eazy
+machine readability.
+.TP
+.B \-T timestamp
+Specify the timestamp of the log message.  By default the current timestamp
+is used for an insert.  If this option is given when listing log messages,
+it is used as the earliest time logs are listed from.
+.TP
+.B \-i
+Insert the log message given as arguments.  Non option arguments
+are concatenated with a space separator and inserted into the log.
+list package names only
+.TP
+.B \-j
+Output the log in json format.
+.TP
+.B \-v
+Verbose mode.  On insert, print the log message inserted to stdout.
+.TP
+.B \-r
+When listing messages, output them in reverse timestamp order, newest
+first.
+.SH EXAMPLES
+.TP
+.B zpm log
+Lists all log messages in the default 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)