pd.if.org Git - zpackage/blob - doc/zpm-note.8

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