]> git.notmuchmail.org Git - notmuch/blobdiff - doc/man1/notmuch-restore.rst
doc: add notmuch-properties(7)
[notmuch] / doc / man1 / notmuch-restore.rst
index 87fa22ef72c11b5457e03288749fb1b415cc2741..b578af1fbf19ca6b5afdb479cac1ecdf2645a214 100644 (file)
@@ -50,23 +50,31 @@ Supported options for **restore** include
             format, this heuristic, based the fact that batch-tag format
             contains no parentheses, should be accurate.
 
-    ``--include=(config|tags)``
+    ``--include=(config|properties|tags)``
 
       Control what kind of metadata is restored.
 
-       **config**
+        **config**
 
-         Restore configuration data to the database. Each configuration line starts
-         with "#@ ", followed by a space seperated key-value pair.
-         Both key and value are hex encoded if needed.
+          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.
 
-       **tags**
+        **properties**
 
-         Output per-message metadata, namely tags. See *format* above
-         for more details.
+          Restore 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.
 
-      The default is to restore both tags and configuration
-      information
+        **tags**
+
+          Restore 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.
@@ -82,7 +90,16 @@ standard input.
 SEE ALSO
 ========
 
-**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
-**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
-**notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-search(1)**,
-**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**
+**notmuch(1)**,
+**notmuch-config(1)**,
+**notmuch-count(1)**,
+**notmuch-dump(1)**,
+**notmuch-hooks(5)**,
+**notmuch-insert(1)**,
+**notmuch-new(1)**,
+**notmuch-properties(7)**,
+**notmuch-reply(1)**,
+**notmuch-search(1)**,
+**notmuch-search-terms(7)**,
+**notmuch-show(1)**,
+**notmuch-tag(1)**