X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-restore-1.mdwn;h=7d4eed242b9c0658fc2f94c0ff73a546e0a9ba25;hb=39aab76514c6f6f2b6769b9fd45fd9570664fa49;hp=39c583eff5a871672d2880975b7ba13c9ef4155a;hpb=33b367e699bbcc8fecd001fab8033a4e91b13450;p=notmuch-wiki diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 39c583e..7d4eed2 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -1,58 +1,101 @@
- notmuch-restore - Restores the tags from the given file (see notmuch - dump). + notmuch-restore - restores the tags from the given file (see notmuch + dump)
- notmuch restore [--accumulate] [ <filename> ] + notmuch restore [--accumulate] [--format=(auto|batch-tag|sup)] + [--input=<filename>]
Restores the tags from the given file (see 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 notmuch restore command provides you a way - to import all of your tags (or labels as sup calls them). + Supported options for restore include + + --accumulate + The union of the existing and new tags is applied, instead of + replacing each message's tags as they are read in from the + dump file. + + --format=(sup|batch-tag|auto) + Notmuch restore supports two plain text dump formats, with + each line specifying a message-id and a set of tags. For + details of the actual formats, see notmuch-dump(1). + + sup The sup 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 notmuch restore command provides you a + way to import all of your tags (or labels as sup calls + them). + + batch-tag + The batch-tag dump format is intended to more robust + against malformed message-ids and tags containing + whitespace or non-ascii(7) characters. See notâ + much-dump(1) for details on this format. + + notmuch restore updates the maildir flags according to + tag changes if the maildir.synchronize_flags configuâ + ration option is enabled. See notmuch-config(1) for + details. + + auto This option (the default) tries to guess the format + from the input. For correctly formed input in either + supported format, this heuristic, based the fact that + batch-tag format contains no parentheses, should be + accurate. + + --include=(config|tags) + Control what kind of metadata is restored. + config + Restore configuration data to the database. Each configuâ + ration line starts with "#@ ", followed by a space seperâ + ated key-value pair. Both key and value are hex encoded + if needed. + + tags + Output per-message metadata, namely tags. See format + above for more details. + + The default is to restore both tags and configuration informaâ + tion + + --input=<filename> + Read input from given file instead of stdin.+
- 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. + notmuch restore will detect if the input is compressed in gzip(1) forâ + mat and automatically decompress it while reading. This detection does + not depend on file naming and in particular works for standard input.+
- See notmuch-search-terms(7) for details of the supported syntax for -+. + notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notâ + much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), + notmuch-search(1), notmuch-search-terms(7), notmuch-show(1), notâ + much-tag(1)
- notmuch restore updates the maildir flags according to tag changes if - the maildir.synchronize_flags configuration option is enabled. See not- - much-config(1) for details. + Carl Worth and many others-
- notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), not- - much-hooks(5), notmuch-new(1), notmuch-reply(1), notmuch-search(1), - notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) + 2009-2016, Carl Worth and many others-