manpages 0.15

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

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn
index ece18896b2aff95a4332138fda05f1596a441e3c..743be97f87469d3b97431ed42096913432ddb0b0 100644 (file)
--- a/manpages/notmuch-dump-1.mdwn
+++ b/manpages/notmuch-dump-1.mdwn
@@ -2,32 +2,70 @@
 
 <h2>NAME</h2>
 <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>
-       <b>notmuch</b> <b>dump</b> [ &lt;<u>filename</u>&gt; ] [--] [ &lt;<u>search-term</u>&gt;...]
+       <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>
        Dump tags for messages matching the given search terms.
 
-       Output is to the given filename, if any, or to stdout.  Note that using
-       the filename argument is deprecated.
+       Output is to the given filename, if any, or to stdout.
 
        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.)
 
-       With  no  search  terms, a dump of all messages in the database will be
-       generated.  A &quot;--&quot; argument instructs notmuch that the remaining  argu-
-       ments are search terms.
+       <b>--format=(sup|batch-tag)</b>
 
-       See  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7)  for  details  of the supported syntax for
-       &lt;search-terms&gt;.
+           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 whites-
+               pace 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  special
+               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>
@@ -37,4 +75,4 @@
        <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-tag</a>(1)
 </pre>
 
-<h2>Notmuch 0.13.2</h2>
+<h2>Notmuch 0.15</h2>