notmuch/man/man1/notmuch-dump.1
David Bremner 7c5695b439 man/*: fixup page references
- Replace references to section X below with page refences.

- Add SEE ALSO to each page.  This is a bit error prone, because each
  SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-31 15:16:32 -04:00

62 lines
1.9 KiB
Groff

.TH NOTMUCH-DUMP 1 2011-12-04 "Notmuch 0.10.2"
.SH NAME
notmuch-dump \- Creates a plain-text dump of the tags of each message.
.SH SYNOPSIS
.B "notmuch dump"
.RI "[ <" filename "> ] [--]"
.RI "[ <" search-term ">...]"
.B "notmuch restore"
.RB [ "--accumulate" ]
.RI "[ <" filename "> ]"
.SH DESCRIPTION
.SS DUMP
Dump tags for messages matching the given search terms.
Output is to the given filename, if any, or to stdout. Note that
using the filename argument is deprecated.
These tags are the only data in the notmuch database that can't be
recreated from the messages themselves. The output of notmuch dump is
therefore the only critical thing to backup (and much more friendly to
incremental backup than the native database files.)
With no search terms, a dump of all messages in the database will be
generated. A "--" argument instructs notmuch that the
remaining arguments are search terms.
.SS RESTORE
Restores the tags from the given file (see
.BR "notmuch dump" ")."
The input is read from the given filename, if any, or from stdin.
Note: The dump file format is specifically chosen to be
compatible with the format of files produced by sup-dump.
So if you've previously been using sup for mail, then the
.B "notmuch restore"
command provides you a way to import all of your tags (or labels as
sup calls them).
The --accumulate switch causes the union of the existing and new tags to be
applied, instead of replacing each message's tags as they are read in from the
dump file.
.RE
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
.RE
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), \fBnotmuch-part\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)