]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-restore-1.mdwn
0.20.1 manpages update
[notmuch-wiki] / manpages / notmuch-restore-1.mdwn
index 2224911865f0ef6330e92f5d44840202a5a6002b..1d7bdd9decd2f4f60b565dc1593514ec694792db 100644 (file)
@@ -8,8 +8,8 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b>  <b>restore</b>   [<b>--accumulate</b>]   [<b>--format=(auto|batch-tag|sup)</b>]   [
-       --input=&lt;<u>filename</u>&gt; ]
+       <b>notmuch</b>    <b>restore</b>    [--accumulate]    [--format=(auto|batch-tag|sup)]
+       [--input=&lt;<u>filename</u>&gt;]
 </pre>
 
 <h2>DESCRIPTION</h2>
 
        Supported options for <b>restore</b> include
 
-           <b>--accumulate</b>
-
-               The  union  of the existing and new tags is applied, instead of
-               replacing each message&apos;s tags as they are read in from the dump
-               file.
-
-           <b>--format=(sup|batch-tag|auto)</b>
-
-               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 <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
-
-               <b>sup</b>  The <b>sup</b> dump file format is specifically chosen to be com-
-                   patible with the format of files produced by sup-dump.   So
-                   if you&apos;ve previously been using sup for mail, then the <b>not-</b>
-                   <b>much</b> <b>restore</b> command provides you a way to  import  all  of
-                   your tags (or labels as sup calls them).
-
-               <b>batch-tag</b>
-
-                   The  <b>batch-tag</b>  dump  format  is  intended  to  more robust
-                   against malformed message-ids and tags  containing  whites-
-                   pace  or  non-<b>ascii</b>(7) characters.  See <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) for
-                   details on this format.
+          <b>--accumulate</b>
+                 The union of the existing and new tags is applied, instead of
+                 replacing each message&apos;s tags as they are read  in  from  the
+                 dump file.
+
+          <b>--format=(sup|batch-tag|auto)</b>
+                 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 <a href='../notmuch-dump-1/'>notmuch-dump</a>(1).
+
+                 <b>sup</b>    The  <b>sup</b> dump file format is specifically chosen to be
+                        compatible  with  the  format  of  files  produced  by
+                        sup-dump.  So  if you&apos;ve previously been using sup for
+                        mail, then the <b>notmuch</b> <b>restore</b> command provides you  a
+                        way to import all of your tags (or labels as sup calls
+                        them).
+
+                 <b>batch-tag</b>
+                        The <b>batch-tag</b> dump format is intended to  more  robust
+                        against  malformed  message-ids  and  tags  containing
+                        whitespace  or  non-<b>ascii</b>(7)  characters.   See   <a href='../notmuch-dump-1/'>not‐</a>
+                        <a href='../notmuch-dump-1/'>much-dump</a>(1) for details on this format.
+
+                        <b>notmuch</b> <b>restore</b> updates the maildir flags according to
+                        tag changes if the <b>maildir.synchronize</b>_<b>flags</b>  configu‐
+                        ration  option  is  enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for
+                        details.
+
+                 <b>auto</b>   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.
+
+          <b>--input=&lt;filename&gt;</b>
+                 Read input from given file instead of stdin.
+</pre>
 
-                   <b>notmuch</b> <b>restore</b> updates the maildir flags according to  tag
-                   changes   if  the  <b>maildir.synchronize</b>_<b>flags</b>  configuration
-                   option is enabled. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for details.
+<h2>GZIPPED INPUT</h2>
+<pre>
+       <b>notmuch</b> <b>restore</b> will detect if the input is compressed in <b>gzip</b>(1)  for‐
+       mat  and automatically decompress it while reading. This detection does
+       not depend on file naming and in particular works for standard input.
+</pre>
 
-               <b>auto</b>
+<h2>SEE ALSO</h2>
+<pre>
+       <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>
+       <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),
+       <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>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
 
-                   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.
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
 </pre>
 
-<h2>SEE ALSO</h2>
+<h2>COPYRIGHT</h2>
 <pre>
-       <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>
-       <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),
-       <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>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.20.1</h2>