doc: document notmuch-dump header line
authorDavid Bremner <david@tethera.net>
Sun, 5 Jun 2016 22:23:58 +0000 (19:23 -0300)
committerDavid Bremner <david@tethera.net>
Tue, 7 Jun 2016 10:52:34 +0000 (07:52 -0300)
This was introduced with the libconfig changes, but not documented then.

doc/man1/notmuch-dump.rst

index eda9e07f6cdd00a725fa88521912ed7845b24acc..94986a86bba5b6dfaee06b42e2160f8917c1eea3 100644 (file)
@@ -86,7 +86,15 @@ Supported options for **dump** include
        Output per-message metadata, namely tags. See *format* above
        for description of the output.
 
-      The default is to include both tags and configuration information
+      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.