debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

notmuch-compact: Add man page

Browse source 
Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
This commit is contained in:
Ben Gamari 2013-10-02 16:30:48 -04:00 committed by David Bremner
parent 241a88ce2f
commit 1f5ae4e00f
2 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
man/Makefile.local
View file

@ -8,6 +8,7 @@ MAIN_PAGE := $(dir)/man1/notmuch.1
MAN1 := \
$(MAIN_PAGE) \
$(dir)/man1/notmuch-compact.1 \
$(dir)/man1/notmuch-config.1 \
$(dir)/man1/notmuch-count.1 \
$(dir)/man1/notmuch-dump.1 \

36
man/man1/notmuch-compact.1 Normal file
View file

@ -0,0 +1,36 @@
.TH NOTMUCH-COMPACT 1 2013-08-23 "Notmuch 0.16"
.SH NAME
notmuch-compact \- compact the notmuch database
.SH SYNOPSIS
.B notmuch compact
.SH DESCRIPTION
The
.B compact
command can be used to compact the notmuch database. This can both reduce
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.
Note that the database write lock will be held during the compaction
process (which may be quite long) to protect data integrity.
.RE
.SH ENVIRONMENT
The following environment variables can be used to control the
behavior of notmuch.
.TP
.B NOTMUCH_CONFIG
Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)