unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob 7be348545c001e038bcb5b33e97d1f6c5309a0ae 3365 bytes (raw)
name: doc/man1/notmuch-restore.rst 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
 
.. _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

``--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 :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.

``--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.

``--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)`

debug log:

solving 7be348545c00 ...
found 7be348545c00 in https://yhetil.org/notmuch.git/

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).