aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2016-06-05 19:23:58 -0300
committerDavid Bremner <david@tethera.net>2016-06-07 07:52:34 -0300
commitd9d2d535b376b4eed455b4d5ca864ae00ee0f4a7 (patch)
treea075130f2994a23d6098011ebd4b693f1141643e
parentba0b95f846820b1d71f67731a8c38ac2866c921a (diff)
doc: document notmuch-dump header line
This was introduced with the libconfig changes, but not documented then.
-rw-r--r--doc/man1/notmuch-dump.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index eda9e07f..94986a86 100644
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -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.