debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 09:24:54 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: document notmuch compact --quiet and --backup=DIRECTORY options

Browse source
This commit is contained in:
Jani Nikula 2013-11-06 18:38:56 +02:00 committed by David Bremner
parent 0e04bda2a9
commit 85e95c0844
1 changed files with 27 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
man/man1/notmuch-compact.1
View file

@ -4,6 +4,8 @@ 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=" <directory>
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=" <directory>
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