From d9d2d535b376b4eed455b4d5ca864ae00ee0f4a7 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 5 Jun 2016 19:23:58 -0300 Subject: [PATCH] doc: document notmuch-dump header line This was introduced with the libconfig changes, but not documented then. --- doc/man1/notmuch-dump.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) 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=``\ Write output to given file instead of stdout. -- 2.43.0