X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-dump.rst;h=ca048aebf01f99ddb0e3815f9c2a0693fdc69cee;hp=94986a86bba5b6dfaee06b42e2160f8917c1eea3;hb=ef763a9e8bbd832c2034f48bb9112dcc1cf4ef67;hpb=d9d2d535b376b4eed455b4d5ca864ae00ee0f4a7 diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index 94986a86..ca048aeb 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -71,24 +71,32 @@ 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. **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. + Output configuration data stored in the database. Each line + 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 - for description of the output. + 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*>