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

   1 .TH NOTMUCH-DUMP 1 2012-08-20 "Notmuch 0.14"
   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 "[ --output=<" 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.
  16
  17 These tags are the only data in the notmuch database that can't be
  18 recreated from the messages themselves.  The output of notmuch dump is
  19 therefore the only critical thing to backup (and much more friendly to
  20 incremental backup than the native database files.)
  21
  22 With no search terms, a dump of all messages in the database will be
  23 generated.  A "--" argument instructs notmuch that the
  24 remaining arguments are search terms.
  25
  26 See \fBnotmuch-search-terms\fR(7)
  27 for details of the supported syntax for <search-terms>.
  28
  29 .RE
  30 .SH SEE ALSO
  31
  32 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
  33 \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-reply\fR(1),
  34 \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
  35 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
  36 \fBnotmuch-tag\fR(1)