man/*: formatting cleanup
[notmuch] / 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 .B "notmuch restore"
12 .RB [ "--accumulate" ]
13 .RI "[ <" filename "> ]"
14
15 .SH DESCRIPTION
16
17 .SS DUMP
18
19 Dump tags for messages matching the given search terms.
20
21 Output is to the given filename, if any, or to stdout.  Note that
22 using the filename argument is deprecated.
23
24 These tags are the only data in the notmuch database that can't be
25 recreated from the messages themselves.  The output of notmuch dump is
26 therefore the only critical thing to backup (and much more friendly to
27 incremental backup than the native database files.)
28
29 With no search terms, a dump of all messages in the database will be
30 generated.  A "--" argument instructs notmuch that the
31 remaining arguments are search terms.
32
33 .SS RESTORE
34
35 Restores the tags from the given file (see
36 .BR "notmuch dump" ")."
37
38 The input is read from the given filename, if any, or from stdin.
39
40 Note: The dump file format is specifically chosen to be
41 compatible with the format of files produced by sup-dump.
42 So if you've previously been using sup for mail, then the
43 .B "notmuch restore"
44 command provides you a way to import all of your tags (or labels as
45 sup calls them).
46
47 The --accumulate switch causes the union of the existing and new tags to be
48 applied, instead of replacing each message's tags as they are read in from the
49 dump file.
50 .RE
51
52 See the
53 .B "SEARCH SYNTAX"
54 section below for details of the supported syntax for <search-terms>.
55 .RE