doc: document notmuch-dump header line

This was introduced with the libconfig changes, but not documented then.
This commit is contained in:
David Bremner 2016-06-05 19:23:58 -03:00
parent ba0b95f846
commit d9d2d535b3

View file

@ -86,7 +86,15 @@ Supported options for **dump** include
Output per-message metadata, namely tags. See *format* above Output per-message metadata, namely tags. See *format* above
for description of the output. 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> ``--output=``\ <filename>
Write output to given file instead of stdout. Write output to given file instead of stdout.