aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2016-03-22 07:54:50 -0300
committerDavid Bremner <david@tethera.net>2016-05-25 07:07:56 -0300
commite042a25a3fd8706b6e1ee7bdf527bb17ecb74c6a (patch)
tree9db7e61d5efce86c2c8e6fdece0d132d7c9eef9e /doc
parent92e59568fa4eec466db78af6c21c39ca5826b0d7 (diff)
CLI: add optional config data to dump output.
Note that it changes the default dump output format, but doesn't break existing notmuch-restore. It might break user scripts though.
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/notmuch-dump.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index a37c337c..eda9e07f 100644
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -71,6 +71,23 @@ Supported options for **dump** include
characters. Note also that tags with spaces will not be
correctly restored with this format.
+ ``--include=(config|tags)``
+
+ 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.
+
+ **tags**
+
+ Output per-message metadata, namely tags. See *format* above
+ for description of the output.
+
+ The default is to include both tags and configuration information
+
``--output=``\ <filename>
Write output to given file instead of stdout.