.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "NOTMUCH-COMPACT" "1" "Dec 01, 2023" "0.38.2" "notmuch"
.SH NAME
notmuch-compact \- compact the notmuch database
.SH SYNOPSIS
.sp
\fBnotmuch\fP \fBcompact\fP [\-\-quiet] [\-\-backup=<\fIdirectory\fP>]
.SH DESCRIPTION
.sp
The \fBcompact\fP command can be used to compact the notmuch database.
This can both reduce the space required by the database and improve
lookup performance.
.sp
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 discarded, unless the \fB\-\-backup=\fP<directory> option is
used.
.sp
Note that the database write lock will be held during the compaction
process (which may be quite long) to protect data integrity.
.sp
Supported options for \fBcompact\fP include
.INDENT 0.0
.TP
.B \-\-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.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-quiet
Do not report database compaction progress to stdout.
.UNINDENT
.SH SEE ALSO
.sp
\fI\%notmuch\fP,
\fI\%notmuch\-count\fP,
\fI\%notmuch\-dump\fP,
\fI\%notmuch\-hooks\fP,
\fI\%notmuch\-insert\fP,
\fI\%notmuch\-new\fP,
\fI\%notmuch\-reply\fP,
\fI\%notmuch\-restore\fP,
\fI\%notmuch\-search\fP,
\fI\%notmuch\-search\-terms\fP,
\fI\%notmuch\-show\fP,
\fI\%notmuch\-tag\fP
.SH AUTHOR
Carl Worth and many others
.SH COPYRIGHT
2009-2023, Carl Worth and many others
.\" Generated by docutils manpage writer.
.