git.cworth.org Git - 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>    [--accumulate]    [--format=(auto|batch-tag|sup)]
  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
  26                   of replacing each message&apos;s tags as they are  read  in  from
  27                   the dump file.
  28
  29            <b>--format=(sup|batch-tag|auto)</b>
  30
  31                   Notmuch  restore  supports two plain text dump formats, with
  32                   each line specifying a message-id and a  set  of  tags.  For
  33                   details of 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
  38                          compatible with  the  format  of  files  produced  by
  39                          sup-dump.  So if you&apos;ve previously been using sup for
  40                          mail, then the <b>notmuch</b> <b>restore</b> command provides you a
  41                          way  to  import  all  of  your tags (or labels as sup
  42                          calls them).
  43
  44                   <b>batch-tag</b>
  45
  46                          The <b>batch-tag</b> dump format is intended to more  robust
  47                          against  malformed  message-ids  and  tags containing
  48                          whitespace  or  non-<b>ascii</b>(7)  characters.  See   <a href='../notmuch-dump-1/'>not-</a>
  49                          <a href='../notmuch-dump-1/'>much-dump</a>(1) for details on this format.
  50
  51                          <b>notmuch</b>  <b>restore</b>  updates the maildir flags according
  52                          to tag changes if the <b>maildir.synchronize</b>_<b>flags</b>  con-
  53                          figuration  option  is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1)
  54                          for details.
  55
  56                   <b>auto</b>
  57
  58                          This option (the default) tries to guess  the  format
  59                          from  the input. For correctly formed input in either
  60                          supported format, this heuristic, based the fact that
  61                          batch-tag  format  contains no parentheses, should be
  62                          accurate.
  63 </pre>
  64
  65 <h2>GZIPPED INPUT</h2>
  66 <pre>
  67        <b>notmuch</b> <b>restore</b> will detect if the input is compressed in <b>gzip</b>(1)  for-
  68        mat  and automatically decompress it while reading. This detection does
  69        not depend on file naming and in particular works for standard input.
  70 </pre>
  71
  72 <h2>SEE ALSO</h2>
  73 <pre>
  74        <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>
  75        <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),
  76        <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/'>not-</a>
  77        <a href='../notmuch-tag-1/'>much-tag</a>(1)
  78 </pre>
  79
  80 <h2>AUTHOR</h2>
  81 <pre>
  82        Carl Worth and many others
  83 </pre>
  84
  85 <h2>COPYRIGHT</h2>
  86 <pre>
  87        2014, Carl Worth and many others
  88 </pre>
  89
  90 <h2>0.18</h2>