X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-restore-1.mdwn;h=75d8bf1e4b6b8d63d0ea16f56771ff466114d2f4;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=8164f92cd6c0169174b39871fbf05e756aff60e1;hpb=ad04c8c6b3d8c29a905d9f5f92256fc2bd64be5e;p=notmuch-wiki diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 8164f92..75d8bf1 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -8,63 +8,98 @@

SYNOPSIS

-       notmuch  restore   [--accumulate]   [--format=(auto|batch-tag|sup)]   [
-       --input=<filename> ]
+       notmuch restore [--accumulate]  [--format=(auto|batch-tag|sup)]  [--in‐
+       put=<filename>]

DESCRIPTION

-       Restores the tags from the given file (see notmuch dump).
+       Restores the tags from the given file (see 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 notmuch-dump(1).
-
-               sup
-
-                   The  sup dump file format is specifically chosen to be com-
-                   patible with the format of files produced by sup-dump.   So
-                   if you've previously been using sup for mail, then the not-
-                   much 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  white-
-                   space  or non-ascii(7) characters.  See notmuch-dump(1) for
-                   details on this format.
+       --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  white‐
+                     space or non-ascii(7) characters. See notmuch-dump(1) for
+                     details on this format.
+
+                     notmuch restore updates the maildir  flags  according  to
+                     tag  changes  if the maildir.synchronize_flags configura‐
+                     tion option is enabled.  See  notmuch-config(1)  for  de‐
+                     tails.
+
+              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 configu‐
+                     ration  line starts with "#@ ", followed by a space sepa‐
+                     rated 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 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  op‐
+              tion can be specified multiple times to select some subset.
+
+       --input=<filename>
+              Read input from given file instead of stdin.
+
- 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. +

GZIPPED INPUT

+
+       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.
+
- auto +

SEE ALSO

+
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       much-hooks(5),   notmuch-insert(1),   notmuch-new(1),   notmuch-proper‐
+       ties(7),  notmuch-reply(1), notmuch-search(1), notmuch-search-terms(7),
+       notmuch-show(1), notmuch-tag(1)
+
- 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 for- - mat contains no parentheses, should be accurate. +

AUTHOR

+
+       Carl Worth and many others
-

SEE ALSO

+

COPYRIGHT

-       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), notmuch-
-       tag(1)
+       2009-2022, Carl Worth and many others
-

Notmuch 0.16

+

0.35