X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-dump.rst;h=f3f2b3942fafd82bcd842a067be93f71c205ff63;hb=178d62cf9c9959fe603c9ffef9fa90f65b67dcd5;hp=eda9e07f6cdd00a725fa88521912ed7845b24acc;hpb=e042a25a3fd8706b6e1ee7bdf527bb17ecb74c6a;p=notmuch diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst index eda9e07f..f3f2b394 100644 --- a/doc/man1/notmuch-dump.rst +++ b/doc/man1/notmuch-dump.rst @@ -71,22 +71,38 @@ 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 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*> - The default is to include both tags and configuration information + where <*included*> is a comma separated list of the above + options. ``--output=``\ Write output to given file instead of stdout.