X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-compact.1;h=ea6218fbf55b5c6b009da5a00e0792dff2be18ce;hb=eb61cc78398712dc4cc8a4a3ed861ac074aa007e;hp=1aeed22184664ad39a0b9894b6501d37cdd57806;hpb=1f5ae4e00f011098bfe6816e05c4f6da710cd371;p=notmuch diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1 index 1aeed221..ea6218fb 100644 --- a/man/man1/notmuch-compact.1 +++ b/man/man1/notmuch-compact.1 @@ -1,9 +1,11 @@ -.TH NOTMUCH-COMPACT 1 2013-08-23 "Notmuch 0.16" +.TH NOTMUCH-COMPACT 1 2013-12-30 "Notmuch 0.17" .SH NAME notmuch-compact \- compact the notmuch database .SH SYNOPSIS .B notmuch compact +.RI "[ --quiet ]" +.RI "[ --backup=<" directory "> ]" .SH DESCRIPTION @@ -14,11 +16,35 @@ the space required by the database and improve lookup performance. The compacted database is built in a temporary directory and is later moved into the place of the origin database. The original uncompacted -database is preserved to be deleted by the user as desired. +database is discarded, unless the +.BR "\-\-backup=" +option is used. Note that the database write lock will be held during the compaction process (which may be quite long) to protect data integrity. +Supported options for +.B compact +include + +.RS 4 +.TP 4 +.BR "\-\-backup=" + +Save the current database to the given directory before replacing it +with the compacted database. The backup directory must not exist and +it must reside on the same mounted filesystem as the current database. + +.RE + +.RS 4 +.TP 4 +.BR \-\-quiet + +Do not report database compaction progress to stdout. + +.RE + .RE .SH ENVIRONMENT The following environment variables can be used to control the