X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-dump.rst;h=7bc57d29468250e9a11e51ea5e7ce49a5ecde7d7;hp=94986a86bba5b6dfaee06b42e2160f8917c1eea3;hb=c5356b9ed56e42d36ca18206155b62c94cfbd79d;hpb=92d8eae8f182e4eebc87d76f8d4f37e6c018883a diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index 94986a86..7bc57d29 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. Ids, keys and values are hex encoded + if needed. See **notmuch-properties(7)** for more details. **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 3 of the dump format, there is a header line of the + following form | | #notmuch-dump <*format*>:<*version*> <*included*> @@ -102,7 +110,16 @@ Supported options for **dump** include SEE ALSO ======== -**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**, -**notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**, -**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**, -**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)** +**notmuch(1)**, +**notmuch-config(1)**, +**notmuch-count(1)**, +**notmuch-hooks(5)**, +**notmuch-insert(1)**, +**notmuch-new(1)**, +**notmuch-properties(7)**, +**notmuch-reply(1)**, +**notmuch-restore(1)**, +**notmuch-search(1)**, +**notmuch-search-terms(7)**, +**notmuch-show(1)**, +**notmuch-tag(1)**