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

   1 <h1>NOTMUCH-DUMP(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-dump - creates a plain-text dump of the tags of each message
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>dump</b> [--gzip] [--format=(batch-tag|sup)] [--output=&lt;<u>file</u>&gt;] [--]
  11        [&lt;<u>search-term</u>&gt; ...]
  12 </pre>
  13
  14 <h2>DESCRIPTION</h2>
  15 <pre>
  16        Dump tags for messages matching the given search terms.
  17
  18        Output is to the given filename, if any, or to stdout.
  19
  20        These tags are the only data in the  notmuch  database  that  can&apos;t  be
  21        recreated  from  the messages themselves. The output of notmuch dump is
  22        therefore the only critical thing to backup (and much more friendly  to
  23        incremental backup than the native database files.)
  24
  25        See  <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7)  for  details  of the supported syntax for
  26        &lt;search-terms&gt;. With no search terms, a dump of  all  messages  in  the
  27        database  will be generated. A &quot;--&quot; argument instructs notmuch that the
  28        remaining arguments are search terms.
  29
  30        Supported options for <b>dump</b> include
  31
  32           <b>--gzip</b> Compress the output in a format compatible with <b>gzip</b>(1).
  33
  34           <b>--format=(sup|batch-tag)</b>
  35                  Notmuch restore supports two plain text  dump  formats,  both
  36                  with one message-id per line, followed by a list of tags.
  37
  38                  <b>batch-tag</b>
  39                      The  default  <b>batch-tag</b>  dump  format is intended to more
  40                      robust against malformed message-ids and tags  containing
  41                      whitespace  or non-<b>ascii</b>(7) characters. Each line has the
  42                      form
  43                         +&lt;<u>encoded-tag</u>&gt; +&lt;<u>encoded-tag</u>&gt; ...  --  id:&lt;<u>quoted-mes‐</u>
  44                         <u>sage-id</u>&gt;
  45
  46                      Tags are hex-encoded by replacing every byte not matching
  47                      the regex <b>[A-Za-z0-9@=.,</b>_<b>+-]</b> with <b>%nn</b> where nn is the two
  48                      digit  hex  encoding.  The  message  ID is a valid Xapian
  49                      query, quoted using Xapian boolean term quoting rules: if
  50                      the  ID  contains  whitespace  or a close paren or starts
  51                      with a double quote, it must be enclosed in double quotes
  52                      and  double  quotes  inside  the  ID must be doubled. The
  53                      astute reader will notice this is a special case  of  the
  54                      batch input format for <a href='../notmuch-tag-1/'>notmuch-tag</a>(1); note that the sin‐
  55                      gle message-id query is mandatory for <a href='../notmuch-restore-1/'>notmuch-restore</a>(1).
  56
  57                  <b>sup</b>
  58                      The <b>sup</b> dump file format is  specifically  chosen  to  be
  59                      compatible with the format of files produced by sup-dump.
  60                      So if you&apos;ve previously been using sup for mail, then the
  61                      <b>notmuch</b>  <b>restore</b> command provides you a way to import all
  62                      of your tags (or labels as sup calls them). Each line has
  63                      the following form
  64                         &lt;<u>message-id</u>&gt; <b>(</b> &lt;<u>tag</u>&gt; ... <b>)</b>
  65
  66                      with zero or more tags are separated by spaces. Note that
  67                      (malformed) message-ids may  contain  arbitrary  non-null
  68                      characters.  Note  also that tags with spaces will not be
  69                      correctly restored with this format.
  70
  71           <b>--output=&lt;filename&gt;</b>
  72                  Write output to given file instead of stdout.
  73 </pre>
  74
  75 <h2>SEE ALSO</h2>
  76 <pre>
  77        <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>
  78        <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),
  79        <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>
  80        <a href='../notmuch-tag-1/'>much-tag</a>(1)
  81 </pre>
  82
  83 <h2>AUTHOR</h2>
  84 <pre>
  85        Carl Worth and many others
  86 </pre>
  87
  88 <h2>COPYRIGHT</h2>
  89 <pre>
  90        2014, Carl Worth and many others
  91 </pre>
  92
  93 <h2>0.20.1</h2>