mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-22 19:08:09 +01:00
c48797b498
We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
57 lines
1.6 KiB
Groff
57 lines
1.6 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
|
|
|
|
.TP
|
|
.BR dump " [<filename>]"
|
|
|
|
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.
|
|
|
|
.TP
|
|
.BR restore " [--accumulate] [<filename>]"
|
|
|
|
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 the
|
|
.B "SEARCH SYNTAX"
|
|
section below for details of the supported syntax for <search-terms>.
|
|
.RE
|