rework zpm-note

[zpackage] / doc / zpm-note.8

diff --git a/doc/zpm-note.8 b/doc/zpm-note.8
new file mode 100644 (file)
index 0000000..29650db
--- /dev/null
+++ b/doc/zpm-note.8
@@ -0,0 +1,86 @@
+.TH zpm-note 8 2018-12-09 "ZPM 0.4"
+.SH NAME
+zpm-note \- manage zpm admin notes
+.SH SYNOPSIS
+.B zpm note
+[
+.BI -f " pkgfile"
+]
+[
+.B -ljseDAa
+]
+.RI [ package ...]
+.RB [ :
+.IR glob ...\fR]
+.SH DESCRIPTION
+\fBzpm-note\fR lists, shows, creates, or deletes admin notes.
+.SH OPTIONS
+.TP
+\-f
+specify the package file to find packages in
+.TP
+.BI \-n " range"
+specify the range of notes to be operated on in show, list, ack, and delete
+modes.  The \fIrange\fR can be in the form of
+\fIstart\fB-\fIend\fR,
+\fB-\fIend\fR,
+\fIstart\fB-\fR, or
+\fin\fR, where \fIn\fR is a single note, and the other forms
+specify an inclusive range, if either the start or the end is not
+given in a range, it is taken to be unbounded.
+.TP
+\-a
+include acknowledged notes in the range
+\-u
+suppress unacknowledged notes, i.e. just select acknowledged notes
+in the range.  Implies \-a.
+.TP
+\-l
+list a range of notes.  The output will be constrained to fit on one
+line.  Only as many characters from the first line of the note as will fit
+will be printed.
+.TP
+\-s
+show a range of notes in full format
+.TP
+\-j
+use json output if in show (-s) mode
+.TP
+\-D
+delete a range of notes
+.TP
+\-A
+acknowledge a range of notes
+.TP
+\-e
+when adding a note, print the resulting note to stdout as if the new note were
+to be listed with -l.  By default, only the new note number is printed to
+stdout.
+.TP
+\-m \fimessage\fR
+specify the note message
+.TP
+\-a
+operate on all notes in the range.  by default, only un-acknowledged notes
+are operated on.
+.TP
+-F \fIfile\fR
+Take the note message from the given file.  If the file is "-", the
+message is taken from standard input.
+.SH EXAMPLES
+.TP
+zpm note -m 'foo'
+create a new note named foo
+.TP
+zpm note -l -n 1-10
+list unacknowledged notes from 1-10
+.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
+zpm(8)