[PATCH 3/3] notmuch-compact: Add man page
authorBen Gamari <bgamari.foss@gmail.com>
Wed, 2 Oct 2013 20:30:48 +0000 (16:30 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:57:14 +0000 (09:57 -0800)
a2/f701068917e331b1f439c8153511f3de70976a [new file with mode: 0644]

diff --git a/a2/f701068917e331b1f439c8153511f3de70976a b/a2/f701068917e331b1f439c8153511f3de70976a
new file mode 100644 (file)
index 0000000..2477ad5
--- /dev/null
@@ -0,0 +1,126 @@
+Return-Path: <bgamari.foss@gmail.com>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id D0C3B431FCF\r
+       for <notmuch@notmuchmail.org>; Wed,  2 Oct 2013 13:31:11 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.799\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5\r
+       tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1,\r
+       FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id hRZThr6dyimi for <notmuch@notmuchmail.org>;\r
+       Wed,  2 Oct 2013 13:31:07 -0700 (PDT)\r
+Received: from mail-qe0-f48.google.com (mail-qe0-f48.google.com\r
+       [209.85.128.48]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id C811B431FD7\r
+       for <notmuch@notmuchmail.org>; Wed,  2 Oct 2013 13:31:03 -0700 (PDT)\r
+Received: by mail-qe0-f48.google.com with SMTP id nd7so996633qeb.21\r
+       for <notmuch@notmuchmail.org>; Wed, 02 Oct 2013 13:31:03 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113;\r
+       h=from:to:cc:subject:date:message-id:in-reply-to:references;\r
+       bh=O4lHm8IoAKHJw90CqgkdKZioy38SEVH1RUAABWfp2xQ=;\r
+       b=IsDpDZqxtVPsWpFvnNgF3/k4NlaDx/BX6md3MpSIchekck98XYfB+BogJxVwxAgoyd\r
+       k0mtFAhhwWY+qfT3cclyQxSpZ3BZtyF1G8pwPJPGhEaiPTfWr6dtNCpKiuhtyreuMLl7\r
+       ZWUR5368nUj3254Ig+I/najdcacP86iTk5tDb3Tvah/PNbzUEkktmN7hJvISt305HAIs\r
+       0n3vIZbimWjY+ve1356qqPBml58JR87KADlyP4LNHU7HLFXFzUtyyTFt45HWVlmftako\r
+       zXnaOMWSFYh7ahvDMBVo1BiFuCbnpjELOicGReGSVxnen1B19Vl/ySlhEj08HPZrggj5\r
+       2+MQ==\r
+X-Received: by 10.224.103.194 with SMTP id l2mr3977626qao.118.1380745863258;\r
+       Wed, 02 Oct 2013 13:31:03 -0700 (PDT)\r
+Received: from ben-laptop.hasb.physics.cns (gamari.physics.umass.edu.\r
+       [128.119.56.223])\r
+       by mx.google.com with ESMTPSA id fx6sm5946200qeb.1.1969.12.31.16.00.00\r
+       (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128);\r
+       Wed, 02 Oct 2013 13:31:02 -0700 (PDT)\r
+From: Ben Gamari <bgamari.foss@gmail.com>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 3/3] notmuch-compact: Add man page\r
+Date: Wed,  2 Oct 2013 16:30:48 -0400\r
+Message-Id: <1380745848-4972-4-git-send-email-bgamari.foss@gmail.com>\r
+X-Mailer: git-send-email 1.8.1.2\r
+In-Reply-To: <1380745848-4972-1-git-send-email-bgamari.foss@gmail.com>\r
+References: <1380745848-4972-1-git-send-email-bgamari.foss@gmail.com>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 02 Oct 2013 20:31:12 -0000\r
+\r
+Signed-off-by: Ben Gamari <bgamari.foss@gmail.com>\r
+---\r
+ man/Makefile.local         |  1 +\r
+ man/man1/notmuch-compact.1 | 36 ++++++++++++++++++++++++++++++++++++\r
+ 2 files changed, 37 insertions(+)\r
+ create mode 100644 man/man1/notmuch-compact.1\r
+\r
+diff --git a/man/Makefile.local b/man/Makefile.local\r
+index 216aaa0..57910b7 100644\r
+--- a/man/Makefile.local\r
++++ b/man/Makefile.local\r
+@@ -8,6 +8,7 @@ MAIN_PAGE := $(dir)/man1/notmuch.1\r
\r
+ MAN1 := \\r
+       $(MAIN_PAGE) \\r
++      $(dir)/man1/notmuch-compact.1 \\r
+       $(dir)/man1/notmuch-config.1 \\r
+       $(dir)/man1/notmuch-count.1 \\r
+       $(dir)/man1/notmuch-dump.1 \\r
+diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
+new file mode 100644\r
+index 0000000..1aeed22\r
+--- /dev/null\r
++++ b/man/man1/notmuch-compact.1\r
+@@ -0,0 +1,36 @@\r
++.TH NOTMUCH-COMPACT 1 2013-08-23 "Notmuch 0.16"\r
++.SH NAME\r
++notmuch-compact \- compact the notmuch database\r
++.SH SYNOPSIS\r
++\r
++.B notmuch compact\r
++\r
++.SH DESCRIPTION\r
++\r
++The\r
++.B compact\r
++command can be used to compact the notmuch database. This can both reduce\r
++the space required by the database and improve lookup performance.\r
++\r
++The compacted database is built in a temporary directory and is later\r
++moved into the place of the origin database. The original uncompacted\r
++database is preserved to be deleted by the user as desired.\r
++\r
++Note that the database write lock will be held during the compaction\r
++process (which may be quite long) to protect data integrity.\r
++\r
++.RE\r
++.SH ENVIRONMENT\r
++The following environment variables can be used to control the\r
++behavior of notmuch.\r
++.TP\r
++.B NOTMUCH_CONFIG\r
++Specifies the location of the notmuch configuration file. Notmuch will\r
++use ${HOME}/.notmuch\-config if this variable is not set.\r
++.SH SEE ALSO\r
++\r
++\fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),\r
++\fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),\r
++\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),\r
++\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),\r
++\fBnotmuch-tag\fR(1)\r
+-- \r
+1.8.1.2\r
+\r