X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-restore.rst;h=c0f47f261372fdf6f9afb2b7fa6ab5b9ba7b0d23;hp=cb68bc8a72b2dd4e673934c4c196c75760dd7238;hb=HEAD;hpb=32065e79090ce27c609db6a2fc07e134f1d3d4df diff --git a/doc/man1/notmuch-restore.rst b/doc/man1/notmuch-restore.rst index cb68bc8a..ac6b4245 100644 --- a/doc/man1/notmuch-restore.rst +++ b/doc/man1/notmuch-restore.rst @@ -1,3 +1,5 @@ +.. _notmuch-restore(1): + =============== notmuch-restore =============== @@ -10,86 +12,96 @@ SYNOPSIS DESCRIPTION =========== -Restores the tags from the given file (see **notmuch dump**). +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. +.. program:: restore + +.. option:: --accumulate - ``--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)**. + 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. - **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). +.. option:: --format=(sup|batch-tag|auto) - **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 **notmuch-dump(1)** - for details on this format. + 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)`. - **notmuch restore** updates the maildir flags according to - tag changes if the **maildir.synchronize\_flags** - configuration option is enabled. See **notmuch-config(1)** - for details. + 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). - **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. + 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. - ``--include=(config|properties|tags)`` + **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. - Control what kind of metadata is restored. + 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. - **config** +.. option:: --include=(config|properties|tags) - 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. + Control what kind of metadata is restored. - **properties** + 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. - Output per-message (key,value) metadata. Each line starts - with "#= ", followed by a message id, and a space separated - list of key=value pairs. pair. Ids, keys and values 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** + tags + Restore per-message metadata, namely tags. See *format* above + for more details. - Output 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. - The default is to restore all available types of data. The - option can be specified multiple times to select some subset. +.. option:: --input= - ``--input=``\ - Read input from given file instead of stdin. + Read input from given file instead of stdin. GZIPPED INPUT ============= \ **notmuch restore** will detect if the input is compressed in -**gzip(1)** format and automatically decompress it while reading. This -detection does not depend on file naming and in particular works for -standard input. +: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 ======== -**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**, -**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**, -**notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-search(1)**, -**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)** +: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)`