Update news & manpages to notmuch version 0.16

[obsolete/notmuch-wiki] / manpages / notmuch-dump-1.mdwn

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn
index 521107c17f2a52916d4bae2ed6e176816e13e1c7..76eac67748a6e6c5d9eac7e5d97cde86dfbb40cb 100644 (file)
--- a/manpages/notmuch-dump-1.mdwn
+++ b/manpages/notmuch-dump-1.mdwn
@@ -1,52 +1,81 @@
 <h1>NOTMUCH-DUMP(1)</h1>
 
 <h2>NAME</h2>
 <h1>NOTMUCH-DUMP(1)</h1>
 
 <h2>NAME</h2>

-

 <pre>
 <pre>

-       notmuch-dump - Creates a plain-text dump of the tags of each message.
+       notmuch-dump - creates a plain-text dump of the tags of each message

 </pre>
 
 <h2>SYNOPSIS</h2>
 </pre>
 
 <h2>SYNOPSIS</h2>

-

 <pre>
 <pre>

-       <b>notmuch</b> <b>dump</b> [ <<u>filename</u>> ] [--] [ <<u>search-term</u>>...]
+       <b>notmuch</b>  <b>dump</b>  [<b>--format=(sup|batch-tag)</b>]  [--] [ --output=&lt;<u>filename</u>&gt; ]
+       [--] [ &lt;<u>search-term</u>&gt;...]

 </pre>
 
 <h2>DESCRIPTION</h2>
 </pre>
 
 <h2>DESCRIPTION</h2>

-

 <pre>
        Dump tags for messages matching the given search terms.
 <pre>
        Dump tags for messages matching the given search terms.

-</pre>

 
 

-<pre>
-       Output is to the given filename, if any, or to stdout.  Note that using
-       the filename argument is deprecated.
-</pre>
+       Output is to the given filename, if any, or to stdout.

 
 

-<pre>
-       These tags are the only data in the  notmuch  database  that  can't  be
+       These tags are the only data in the  notmuch  database  that  can&apos;t  be

        recreated  from the messages themselves.  The output of notmuch dump is
        therefore the only critical thing to backup (and much more friendly  to
        incremental backup than the native database files.)
        recreated  from the messages themselves.  The output of notmuch dump is
        therefore the only critical thing to backup (and much more friendly  to
        incremental backup than the native database files.)

-</pre>

 
 

-<pre>
-       With  no  search  terms, a dump of all messages in the database will be
-       generated.  A "--" argument instructs notmuch that the remaining  argu-
-       ments are search terms.
-</pre>
+       <b>--format=(sup|batch-tag)</b>

 
 

-<pre>
-       See  <b>notmuch-search-terms</b>(7)  for  details  of the supported syntax for
-       <search-terms>.
+           Notmuch restore supports two plain text dump formats, both with one
+           message-id per line, followed by a list of tags.
+
+           <b>sup</b>
+
+               The <b>sup</b> dump file format is specifically chosen to be  compati-
+               ble  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).  Each  line  has  the  following
+               form
+
+               &lt;<u>message-id</u>&gt; <b>(</b> &lt;<u>tag</u>&gt; ...  <b>)</b>
+
+               with zero or more tags are separated by spaces. Note that (mal-
+               formed) message-ids may contain arbitrary non-null  characters.
+               Note  also that tags with spaces will not be correctly restored
+               with this format.
+
+           <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.  Each line has the form
+
+               +&lt;<u>encoded-tag</u>&gt; +&lt;<u>encoded-tag</u>&gt; ... --  id:&lt;<u>quoted-message-id</u>&gt;
+
+               Tags are hex-encoded by replacing every byte not  matching  the
+               regex <b>[A-Za-z0-9@=.,</b>_<b>+-]</b> with <b>%nn</b> where nn is the two digit hex
+               encoding.  The message ID is a valid Xapian query, quoted using
+               Xapian  boolean  term  quoting rules: if the ID contains white-
+               space or a close paren or starts with a double quote,  it  must
+               be  enclosed  in  double quotes and double quotes inside the ID
+               must be doubled.  The astute reader will notice this is a  spe-
+               cial  case  of  the batch input format for <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note
+               that the single message-id  query  is  mandatory  for  <a href='../notmuch-restore-1/'>notmuch-</a>
+               <a href='../notmuch-restore-1/'>restore</a>(1).
+
+           With  no  search terms, a dump of all messages in the database will
+           be generated.  A &quot;--&quot; argument instructs notmuch that the remaining
+           arguments are search terms.
+
+           See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
+           &lt;search-terms&gt;.

 </pre>
 
 <h2>SEE ALSO</h2>
 </pre>
 
 <h2>SEE ALSO</h2>

-

 <pre>
 <pre>

-       <b>notmuch</b>(1), <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-hooks</b>(5), <b>not-</b>
-       <b>much-new</b>(1),  <b>notmuch-reply</b>(1),  <b>notmuch-restore</b>(1), <b>notmuch-search</b>(1),
-       <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1)
+       <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-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not-</a>
+       <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</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)

 </pre>
 
 </pre>
 

-<h2>Notmuch 0.13.2</h2>
+<h2>Notmuch 0.16</h2>