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 eda9e07f6cdd00a725fa88521912ed7845b24acc..1e4468e62507b10c7b356a27dd3678714b187e14 100644 (file)
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -71,22 +71,38 @@ Supported options for **dump** include
             characters. Note also that tags with spaces will not be
             correctly restored with this format.
 
             characters. Note also that tags with spaces will not be
             correctly restored with this format.
 

-    ``--include=(config|tags)``
+    ``--include=(config|properties|tags)``

 
     Control what kind of metadata is included in the output.
 
       **config**
 
 
     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 seperated key-value
-       pair.  Both key and value are hex encoded if needed.
+        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**
 
 
       **tags**
 

-       Output per-message metadata, namely tags. See *format* above
-       for description of the output.
+        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*>

 
 

-      The default is to include both tags and configuration information
+      where <*included*> is a comma separated list of the above
+      options.

 
     ``--output=``\ <filename>
         Write output to given file instead of stdout.
 
     ``--output=``\ <filename>
         Write output to given file instead of stdout.