- stretch 0.23.7-3
- testing 0.28.4-1
- stretch-backports 0.28.1-1~bpo9+1
- unstable 0.28.4-1
- experimental 0.29.1-1
NOTMUCH-DUMP(1) | notmuch | NOTMUCH-DUMP(1) |
NAME¶
notmuch-dump - creates a plain-text dump of the tags of each messageSYNOPSIS¶
notmuch dump [--gzip] [--format=(batch-tag|sup)] [--output=<file>] [--] [<search-term> ...]DESCRIPTION¶
Dump tags for messages matching the given search terms.Output is to the given filename, if any, or to stdout.
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.)
See notmuch-search-terms(7) for details of the supported syntax for <search-terms>. 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.
Supported options for dump include
- --gzip
- Compress the output in a format compatible with gzip(1).
- --format=(sup|batch-tag)
- Notmuch restore supports two plain text dump formats, both with one
message-id per line, followed by a list of tags.
batch-tag
Tags are hex-encoded by replacing every byte not matching the regex [A-Za-z0-9@=.,_+-] with %nn where nn is the two digit hex encoding. The message ID is a valid Xapian query, quoted using Xapian boolean term quoting rules: if the ID contains whitespace or a close paren or starts with a double quote, it must be enclosed in double quotes and double quotes inside the ID must be doubled. The astute reader will notice this is a special case of the batch input format for notmuch-tag(1); note that the single message-id query is mandatory for notmuch-restore(1).
sup
with zero or more tags are separated by spaces. Note that (malformed) message-ids may contain arbitrary non-null characters. Note also that tags with spaces will not be correctly restored with this format.
--include=(config|properties|tags)
Control what kind of metadata is included in the output.
properties
tags
The default is to include all available types of data. The option can be specified multiple times to select some subset. As of version 3 of the dump format, there is a header line of the following form
#notmuch-dump <format>:<version> <included>
where <included> is a comma separated list of the above options.
- --output=<filename>
- Write output to given file instead of stdout.
SEE ALSO¶
notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1)AUTHOR¶
Carl Worth and many othersCOPYRIGHT¶
2009-2017, Carl Worth and many othersApril 2, 2017 | 0.23.7 |