doc: fix documentation typos and copy/paste-os

[notmuch] / doc / man1 / notmuch-dump.rst

diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index 3a6d0b34f505265d50e7020ceb0a48c28c0e4f4a..1e4468e62507b10c7b356a27dd3678714b187e14 100644 (file)
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -71,6 +71,41 @@ Supported options for **dump** include
             characters. Note also that tags with spaces will not be
             correctly restored with this format.
 
+    ``--include=(config|properties|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.
+
+      **properties**
+
+        Output per-message (key,value) metadata.  Each line starts
+        with "#= ", followed by a message id, and a space separated
+        list of key=value pairs.  Ids, keys and values are hex
+        encoded if needed.
+
+      **tags**
+
+        Output per-message boolean metadata, namely tags. See *format* above
+        for description of the output.
+
+      The default is to include all available types of data.  The
+      option can be specified multiple times to select some subset. As
+      of version 3 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.
 
 SEE ALSO
 ========