git.cworth.org Git - obsolete/notmuch-wiki/blob - manpages/notmuch-restore-1.mdwn

   1 <h1>NOTMUCH-RESTORE(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-restore  -  restores  the tags from the given file (see notmuch
   6        dump)
   7 </pre>
   8
   9 <h2>SYNOPSIS</h2>
  10 <pre>
  11        <b>notmuch</b>  <b>restore</b>   [<b>--accumulate</b>]   [<b>--format=(auto|batch-tag|sup)</b>]   [
  12        --input=&lt;<u>filename</u>&gt; ]
  13 </pre>
  14
  15 <h2>DESCRIPTION</h2>
  16 <pre>
  17        Restores the tags from the given file (see <b>notmuch</b> <b>dump</b>).
  18
  19        The input is read from the given filename, if any, or from stdin.
  20
  21        Supported options for <b>restore</b> include
  22
  23            <b>--accumulate</b>
  24
  25                The  union  of the existing and new tags is applied, instead of
  26                replacing each message&apos;s tags as they are read in from the dump
  27                file.
  28
  29            <b>--format=(sup|batch-tag|auto)</b>
  30
  31                Notmuch restore supports two plain text dump formats, with each
  32                line specifying a message-id and a set of tags.  For details of
  33                the actual formats, see <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
  34
  35                <b>sup</b>
  36
  37                    The  <b>sup</b> dump file format is specifically chosen to be com-
  38                    patible with the format of files produced by sup-dump.   So
  39                    if you&apos;ve previously been using sup for mail, then the <b>not-</b>
  40                    <b>much</b> <b>restore</b> command provides you a way to  import  all  of
  41                    your tags (or labels as sup calls them).
  42
  43                <b>batch-tag</b>
  44
  45                    The  <b>batch-tag</b>  dump  format  is  intended  to  more robust
  46                    against malformed message-ids and  tags  containing  white-
  47                    space  or non-<b>ascii</b>(7) characters.  See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
  48                    details on this format.
  49
  50                    <b>notmuch</b> <b>restore</b> updates the maildir flags according to  tag
  51                    changes   if  the  <b>maildir.synchronize</b>_<b>flags</b>  configuration
  52                    option is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for details.
  53
  54                <b>auto</b>
  55
  56                    This option (the default) tries to guess  the  format  from
  57                    the  input.  For correctly formed input in either supported
  58                    format, this heuristic, based the fact that batch-tag  for-
  59                    mat contains no parentheses, should be accurate.
  60 </pre>
  61
  62 <h2>SEE ALSO</h2>
  63 <pre>
  64        <a href='../notmuch-1/'>notmuch</a>(1),  <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not-</a>
  65        <a href='../notmuch-hooks-5/'>much-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),   <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
  66        <a href='../notmuch-search-1/'>notmuch-search</a>(1),  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),  <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-</a>
  67        <a href='../notmuch-tag-1/'>tag</a>(1)
  68 </pre>
  69
  70 <h2>Notmuch 0.16</h2>