From: Ben Gamari <bgamari.foss@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 3/3] notmuch-compact: Add man page
Date: Fri, 23 Aug 2013 22:55:23 -0400
Message-Id: <1377312923-32274-4-git-send-email-bgamari.foss@gmail.com>
In-Reply-To: <1377312923-32274-1-git-send-email-bgamari.foss@gmail.com>
References: <1377312923-32274-1-git-send-email-bgamari.foss@gmail.com>
Precedence: list

Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
---
 man/Makefile.local         |  1 +
 man/man1/notmuch-compact.1 | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 34 insertions(+)
 create mode 100644 man/man1/notmuch-compact.1

diff --git a/man/Makefile.local b/man/Makefile.local
index 216aaa0..57910b7 100644
--- a/man/Makefile.local
+++ b/man/Makefile.local
@@ -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 \
diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1
new file mode 100644
index 0000000..48f76c3
--- /dev/null
+++ b/man/man1/notmuch-compact.1
@@ -0,0 +1,33 @@
+.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 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.
+
+.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)
-- 
1.8.1.2