aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar David Bremner <david@tethera.net>2014-03-28 22:14:51 -0300
committerGravatar David Bremner <david@tethera.net>2014-04-12 07:59:44 -0300
commit3c13bc0321baaf340663779d6fce2b1f34c1c2c3 (patch)
tree482e64a162df828622440c1818bf58624bff2435 /doc
parent69867c33fa946514e9de6efff0541762b2755484 (diff)
dump: support gzipped and atomic output
The main goal is to support gzipped output for future internal calls (e.g. from notmuch-new) to notmuch_database_dump. The additional dependency is not very heavy since xapian already pulls in zlib. We want the dump to be "atomic", in the sense that after running the dump file is either present and complete, or not present. This avoids certain classes of mishaps involving overwriting a good backup with a bad or partial one.
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/notmuch-dump.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/man1/notmuch-dump.rst b/doc/man1/notmuch-dump.rst
index 17d1da5c..d94cb4f8 100644
--- a/doc/man1/notmuch-dump.rst
+++ b/doc/man1/notmuch-dump.rst
@@ -19,6 +19,9 @@ recreated from the messages themselves. The output of notmuch dump is
therefore the only critical thing to backup (and much more friendly to
incremental backup than the native database files.)
+``--gzip``
+ Compress the output in a format compatible with **gzip(1)**.
+
``--format=(sup|batch-tag)``
Notmuch restore supports two plain text dump formats, both with one
message-id per line, followed by a list of tags.