From: Ben Gamari Date: Wed, 2 Oct 2013 20:30:48 +0000 (+2000) Subject: [PATCH 3/3] notmuch-compact: Add man page X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=7ddadbeae871b0a4ee2918de40ce9572281111f9;p=notmuch-archives.git [PATCH 3/3] notmuch-compact: Add man page --- diff --git a/a2/f701068917e331b1f439c8153511f3de70976a b/a2/f701068917e331b1f439c8153511f3de70976a new file mode 100644 index 000000000..2477ad5ed --- /dev/null +++ b/a2/f701068917e331b1f439c8153511f3de70976a @@ -0,0 +1,126 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id D0C3B431FCF + for ; Wed, 2 Oct 2013 13:31:11 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.799 +X-Spam-Level: +X-Spam-Status: No, score=-0.799 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id hRZThr6dyimi for ; + Wed, 2 Oct 2013 13:31:07 -0700 (PDT) +Received: from mail-qe0-f48.google.com (mail-qe0-f48.google.com + [209.85.128.48]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id C811B431FD7 + for ; Wed, 2 Oct 2013 13:31:03 -0700 (PDT) +Received: by mail-qe0-f48.google.com with SMTP id nd7so996633qeb.21 + for ; Wed, 02 Oct 2013 13:31:03 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:in-reply-to:references; + bh=O4lHm8IoAKHJw90CqgkdKZioy38SEVH1RUAABWfp2xQ=; + b=IsDpDZqxtVPsWpFvnNgF3/k4NlaDx/BX6md3MpSIchekck98XYfB+BogJxVwxAgoyd + k0mtFAhhwWY+qfT3cclyQxSpZ3BZtyF1G8pwPJPGhEaiPTfWr6dtNCpKiuhtyreuMLl7 + ZWUR5368nUj3254Ig+I/najdcacP86iTk5tDb3Tvah/PNbzUEkktmN7hJvISt305HAIs + 0n3vIZbimWjY+ve1356qqPBml58JR87KADlyP4LNHU7HLFXFzUtyyTFt45HWVlmftako + zXnaOMWSFYh7ahvDMBVo1BiFuCbnpjELOicGReGSVxnen1B19Vl/ySlhEj08HPZrggj5 + 2+MQ== +X-Received: by 10.224.103.194 with SMTP id l2mr3977626qao.118.1380745863258; + Wed, 02 Oct 2013 13:31:03 -0700 (PDT) +Received: from ben-laptop.hasb.physics.cns (gamari.physics.umass.edu. + [128.119.56.223]) + by mx.google.com with ESMTPSA id fx6sm5946200qeb.1.1969.12.31.16.00.00 + (version=TLSv1.1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); + Wed, 02 Oct 2013 13:31:02 -0700 (PDT) +From: Ben Gamari +To: notmuch@notmuchmail.org +Subject: [PATCH 3/3] notmuch-compact: Add man page +Date: Wed, 2 Oct 2013 16:30:48 -0400 +Message-Id: <1380745848-4972-4-git-send-email-bgamari.foss@gmail.com> +X-Mailer: git-send-email 1.8.1.2 +In-Reply-To: <1380745848-4972-1-git-send-email-bgamari.foss@gmail.com> +References: <1380745848-4972-1-git-send-email-bgamari.foss@gmail.com> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Wed, 02 Oct 2013 20:31:12 -0000 + +Signed-off-by: Ben Gamari +--- + 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 +