1 <h1>NOTMUCH-RESTORE(1)</h1>
5 notmuch-restore - restores the tags from the given file (see notmuch
11 <b>notmuch</b> <b>restore</b> [--accumulate] [--format=(auto|batch-tag|sup)]
12 [--input=<<u>filename</u>>]
17 Restores the tags from the given file (see <b>notmuch</b> <b>dump</b>).
19 The input is read from the given filename, if any, or from stdin.
21 Supported options for <b>restore</b> include
24 The union of the existing and new tags is applied, instead of
25 replacing each message's tags as they are read in from the
28 <b>--format=(sup|batch-tag|auto)</b>
29 Notmuch restore supports two plain text dump formats, with
30 each line specifying a message-id and a set of tags. For
31 details of the actual formats, see <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
33 <b>sup</b> The <b>sup</b> dump file format is specifically chosen to be
34 compatible with the format of files produced by
35 sup-dump. So if you've previously been using sup for
36 mail, then the <b>notmuch</b> <b>restore</b> command provides you a
37 way to import all of your tags (or labels as sup calls
41 The <b>batch-tag</b> dump format is intended to more robust
42 against malformed message-ids and tags containing
43 whitespace or non-<b>ascii</b>(7) characters. See <a href='../notmuch-dump-1/'>not‐</a>
44 <a href='../notmuch-dump-1/'>much-dump</a>(1) for details on this format.
46 <b>notmuch</b> <b>restore</b> updates the maildir flags according to
47 tag changes if the <b>maildir.synchronize</b>_<b>flags</b> configu‐
48 ration option is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for
51 <b>auto</b> This option (the default) tries to guess the format
52 from the input. For correctly formed input in either
53 supported format, this heuristic, based the fact that
54 batch-tag format contains no parentheses, should be
57 <b>--include=(config|properties|tags)</b>
58 Control what kind of metadata is restored.
60 Restore configuration data to the database. Each configu‐
61 ration line starts with "#@ ", followed by a space sepa‐
62 rated key-value pair. Both key and value are hex encoded
66 Output per-message (key,value) metadata. Each line
67 starts with "#= ", followed by a message id, and a space
68 separated list of key=value pairs. pair. Ids, keys and
69 values are hex encoded if needed.
72 Output per-message metadata, namely tags. See <u>format</u>
73 above for more details.
75 The default is to restore all available types of data. The
76 option can be specified multiple times to select some subset.
78 <b>--input=<filename></b>
79 Read input from given file instead of stdin.
82 <h2>GZIPPED INPUT</h2>
84 <b>notmuch</b> <b>restore</b> will detect if the input is compressed in <b>gzip</b>(1) for‐
85 mat and automatically decompress it while reading. This detection does
86 not depend on file naming and in particular works for standard input.
91 <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not‐</a>
92 <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
93 <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
94 <a href='../notmuch-tag-1/'>much-tag</a>(1)
99 Carl Worth and many others
104 2009-2017, Carl Worth and many others