cli: optionally restore message properties from dump file

[notmuch] / doc / man1 / notmuch-restore.rst

diff --git a/doc/man1/notmuch-restore.rst b/doc/man1/notmuch-restore.rst
index d6cf19ab771017b6681ff18ad671a22e2397aac2..c681fa2d18bdf4dcd94a07b83a90005907585b84 100644 (file)
--- a/doc/man1/notmuch-restore.rst
+++ b/doc/man1/notmuch-restore.rst
@@ -50,6 +50,42 @@ Supported options for **restore** include
             format, this heuristic, based the fact that batch-tag format
             contains no parentheses, should be accurate.
 
+    ``--include=(config|properties|tags)``
+
+      Control what kind of metadata is restored.
+
+       **config**
+
+         Restore configuration data to the database. Each configuration 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 more details.
+
+      The default is to restore all available types of data.  The
+      option can be specified multiple times to select some subset.
+
+    ``--input=``\ <filename>
+        Read input from given file instead of stdin.
+
+GZIPPED INPUT
+=============
+
+\ **notmuch restore** will detect if the input is compressed in
+**gzip(1)** format and automatically decompress it while reading. This
+detection does not depend on file naming and in particular works for
+standard input.
+
 SEE ALSO
 ========