git.notmuchmail.org Git - notmuch/blob - man/man1/notmuch-dump.1

   1 .TH NOTMUCH-DUMP 1 2011-12-04 "Notmuch 0.10.2"
   2 .SH NAME
   3 notmuch-dump \- Creates a plain-text dump of the tags of each message.
   4
   5 .SH SYNOPSIS
   6
   7 .B "notmuch dump"
   8 .RI "[ <" filename "> ] [--]"
   9 .RI "[ <" search-term ">...]"
  10
  11 .SH DESCRIPTION
  12
  13 Dump tags for messages matching the given search terms.
  14
  15 Output is to the given filename, if any, or to stdout.  Note that
  16 using the filename argument is deprecated.
  17
  18 These tags are the only data in the notmuch database that can't be
  19 recreated from the messages themselves.  The output of notmuch dump is
  20 therefore the only critical thing to backup (and much more friendly to
  21 incremental backup than the native database files.)
  22
  23 With no search terms, a dump of all messages in the database will be
  24 generated.  A "--" argument instructs notmuch that the
  25 remaining arguments are search terms.
  26
  27 See \fBnotmuch-search-terms\fR(7)
  28 for details of the supported syntax for <search-terms>.
  29
  30 .RE
  31 .SH SEE ALSO
  32
  33 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
  34 \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
  35 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
  36 \fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
  37 \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)