]> pd.if.org Git - zpackage/blob - doc/zpm-note.8
initialize variable
[zpackage] / doc / zpm-note.8
1 .TH zpm-note 8 2018-12-09 "ZPM 0.4"
2 .SH NAME
3 zpm-note \- manage zpm admin notes
4 .SH SYNOPSIS
5 .B zpm note
6 [
7 .BI -f " pkgfile"
8 ]
9 [
10 .B -ljseDAa
11 ]
12 .RI [ package ...]
13 .RB [ :
14 .IR glob ...\fR]
15 .SH DESCRIPTION
16 \fBzpm-note\fR lists, shows, creates, or deletes admin notes.
17 .SH OPTIONS
18 .TP
19 \-f
20 specify the package file to find packages in
21 .TP
22 .BI \-n " range"
23 specify the range of notes to be operated on in show, list, ack, and delete
24 modes.  The \fIrange\fR can be in the form of
25 \fIstart\fB-\fIend\fR,
26 \fB-\fIend\fR,
27 \fIstart\fB-\fR, or
28 \fin\fR, where \fIn\fR is a single note, and the other forms
29 specify an inclusive range, if either the start or the end is not
30 given in a range, it is taken to be unbounded.
31 .TP
32 \-a
33 include acknowledged notes in the range
34 \-u
35 suppress unacknowledged notes, i.e. just select acknowledged notes
36 in the range.  Implies \-a.
37 .TP
38 \-l
39 list a range of notes.  The output will be constrained to fit on one
40 line.  Only as many characters from the first line of the note as will fit
41 will be printed.
42 .TP
43 \-s
44 show a range of notes in full format
45 .TP
46 \-j
47 use json output if in show (-s) mode
48 .TP
49 \-D
50 delete a range of notes
51 .TP
52 \-A
53 acknowledge a range of notes
54 .TP
55 \-e
56 when adding a note, print the resulting note to stdout as if the new note were
57 to be listed with -l.  By default, only the new note number is printed to
58 stdout.
59 .TP
60 \-m \fimessage\fR
61 specify the note message
62 .TP
63 \-a
64 operate on all notes in the range.  by default, only un-acknowledged notes
65 are operated on.
66 .TP
67 -F \fIfile\fR
68 Take the note message from the given file.  If the file is "-", the
69 message is taken from standard input.
70 .SH EXAMPLES
71 .TP
72 zpm note -m 'foo'
73 create a new note named foo
74 .TP
75 zpm note -l -n 1-10
76 list unacknowledged notes from 1-10
77 .SH EXIT STATUS
78 0 on success non zero on failure
79 .SH FILES
80 /var/lib/zpm/local.db
81 .SH ENVIRONMENT
82 ZPMDB
83 .SH AUTHOR
84 Nathan Wagner
85 .SH SEE ALSO
86 zpm(8)