From: Ben Gamari <bgamari.foss@gmail.com>
To: notmuch@notmuchmail.org
Subject: [PATCH 3/3] notmuch-compact: Add man page
Date: Wed, 2 Oct 2013 16:30:48 -0400 [thread overview]
Message-ID: <1380745848-4972-4-git-send-email-bgamari.foss@gmail.com> (raw)
In-Reply-To: <1380745848-4972-1-git-send-email-bgamari.foss@gmail.com>
Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>
---
man/Makefile.local | 1 +
man/man1/notmuch-compact.1 | 36 ++++++++++++++++++++++++++++++++++++
2 files changed, 37 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..1aeed22
--- /dev/null
+++ b/man/man1/notmuch-compact.1
@@ -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)
--
1.8.1.2
next prev parent reply other threads:[~2013-10-02 20:31 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-02 20:30 [PATCH] notmuch compact support (v4) Ben Gamari
2013-10-02 20:30 ` [PATCH 1/3] database: Add notmuch_database_compact_close Ben Gamari
2013-10-10 15:09 ` Tomi Ollila
2013-10-11 15:15 ` David Bremner
2013-10-20 17:02 ` Tomi Ollila
2013-11-02 18:30 ` Jameson Graef Rollins
2013-10-02 20:30 ` [PATCH 2/3] notmuch-compact: Initial commit of CLI Ben Gamari
2013-10-02 20:30 ` Ben Gamari [this message]
2013-10-10 10:22 ` [PATCH] notmuch compact support (v4) David Bremner
2013-10-10 12:01 ` Ben Gamari
-- strict thread matches above, loose matches on Subject: below --
2013-08-24 2:55 Ben Gamari
2013-08-24 2:55 ` [PATCH 3/3] notmuch-compact: Add man page Ben Gamari
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1380745848-4972-4-git-send-email-bgamari.foss@gmail.com \
--to=bgamari.foss@gmail.com \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).