]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-dump.rst
clean up spelling
[notmuch] / doc / man1 / notmuch-dump.rst
index a37c337c72e6a9e3189704006ca332546d3772b1..d56974ed0ba01aea71b34014e9a081aa52ad46da 100644 (file)
@@ -71,6 +71,31 @@ Supported options for **dump** include
             characters. Note also that tags with spaces will not be
             correctly restored with this format.
 
+    ``--include=(config|tags)``
+
+    Control what kind of metadata is included in the output.
+
+      **config**
+
+       Output configuration data stored in the database. Each line
+       starts with "#@ ", followed by a space separated key-value
+       pair.  Both key and value are hex encoded if needed.
+
+      **tags**
+
+       Output per-message metadata, namely tags. See *format* above
+       for description of the output.
+
+      The default is to include both tags and configuration
+      information. As of version 2 of the dump format, there is a
+      header line of the following form
+
+      |
+      |  #notmuch-dump <*format*>:<*version*> <*included*>
+
+      where <*included*> is a comma separated list of the above
+      options.
+
     ``--output=``\ <filename>
         Write output to given file instead of stdout.