mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-24 20:08:10 +01:00
f2e2f2aa96
Use the program and option directives to document the subcommand options. This unifies a lot of option documentation throughout. This also makes it possible to reference options with :option:`--foo` (within .. program::) or :option:`subcommand --foo` (globally). This is left for later work. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-program Note: There is a lot of indentation change, but intentionally there is no reflow. Using 'git diff -w' or 'git show -w' to ignore white space changes makes this a very easy change to review.
107 lines
3.3 KiB
ReStructuredText
107 lines
3.3 KiB
ReStructuredText
.. _notmuch-restore(1):
|
|
|
|
===============
|
|
notmuch-restore
|
|
===============
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
**notmuch** **restore** [--accumulate] [--format=(auto|batch-tag|sup)] [--input=<*filename*>]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
Restores the tags from the given file (see :any:`notmuch-dump(1)`).
|
|
|
|
The input is read from the given filename, if any, or from stdin.
|
|
|
|
Supported options for **restore** include
|
|
|
|
.. program:: restore
|
|
|
|
.. option:: --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.
|
|
|
|
.. option:: --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 :any:`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 :any:`notmuch-dump(1)` for
|
|
details on this format.
|
|
|
|
**notmuch restore** updates the maildir flags according to tag
|
|
changes if the **maildir.synchronize\_flags** configuration
|
|
option is enabled. See :any:`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.
|
|
|
|
.. option:: --include=(config|properties|tags)
|
|
|
|
Control what kind of metadata is restored.
|
|
|
|
**config**
|
|
Restore configuration data to the database. Each configuration
|
|
line starts with "#@ ", followed by a space separated
|
|
key-value pair. Both key and value are hex encoded if needed.
|
|
|
|
**properties**
|
|
Restore per-message (key,value) metadata. Each line starts
|
|
with "#= ", followed by a message id, and a space separated
|
|
list of key=value pairs. Ids, keys and values are hex encoded
|
|
if needed. See :any:`notmuch-properties(7)` for more details.
|
|
|
|
**tags**
|
|
Restore per-message metadata, namely tags. See *format* above
|
|
for more details.
|
|
|
|
The default is to restore all available types of data. The option
|
|
can be specified multiple times to select some subset.
|
|
|
|
.. option:: --input=<filename>
|
|
|
|
Read input from given file instead of stdin.
|
|
|
|
GZIPPED INPUT
|
|
=============
|
|
|
|
\ **notmuch restore** will detect if the input is compressed in
|
|
:manpage:`gzip(1)` format and automatically decompress it while
|
|
reading. This detection does not depend on file naming and in
|
|
particular works for standard input.
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
:any:`notmuch(1)`,
|
|
:any:`notmuch-config(1)`,
|
|
:any:`notmuch-count(1)`,
|
|
:any:`notmuch-dump(1)`,
|
|
:any:`notmuch-hooks(5)`,
|
|
:any:`notmuch-insert(1)`,
|
|
:any:`notmuch-new(1)`,
|
|
:any:`notmuch-properties(7)`,
|
|
:any:`notmuch-reply(1)`,
|
|
:any:`notmuch-search(1)`,
|
|
:any:`notmuch-search-terms(7)`,
|
|
:any:`notmuch-show(1)`,
|
|
:any:`notmuch-tag(1)`
|