aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2016-06-12 22:05:54 -0300
committerDavid Bremner <david@tethera.net>2016-09-21 18:14:25 -0300
commitb7345d277ec5f562000c0e740e6515c2a84f9c76 (patch)
tree9d1d9c8faf588e203f0ef1aace5b6ea921e68cf4 /doc
parentf240528095169bf45a88e6790fd6b546cc8f48c5 (diff)
CLI: add properties to dump output
Part of providing extensibility via properties is to make sure that user data is not lost. Thus we need to be able to dump and restore properties.
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/notmuch-dump.rst18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index d56974ed..58570272 100644
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -71,7 +71,7 @@ Supported options for **dump** include
characters. Note also that tags with spaces will not be
correctly restored with this format.
- ``--include=(config|tags)``
+ ``--include=(config|properties|tags)``
Control what kind of metadata is included in the output.
@@ -81,14 +81,22 @@ Supported options for **dump** include
starts with "#@ ", followed by a space separated key-value
pair. Both key and value are hex encoded if needed.
+ **properties**
+
+ Output per-message (key,value) metadata. Each line starts
+ with "#= ", followed by a message id, and a space separated
+ list of key=value pairs. pair. Ids, keys and values are hex
+ encoded if needed.
+
**tags**
- Output per-message metadata, namely tags. See *format* above
+ Output per-message boolean metadata, namely tags. See *format* above
for description of the output.
- 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
+ The default is to include all available types of data. The
+ option can be specified multiple times to select some subset. As
+ of version 2 of the dump format, there is a header line of the
+ following form
|
| #notmuch-dump <*format*>:<*version*> <*included*>