Return-Path: <jani@nikula.org>
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 19864431FAF
	for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:26:19 -0800 (PST)
X-Virus-Scanned: Debian amavisd-new at olra.theworths.org
X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"
X-Spam-Flag: NO
X-Spam-Score: -0.7
X-Spam-Level: 
X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5
	tests=[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 ha7AgN77aK+u for <notmuch@notmuchmail.org>;
	Sun,  3 Nov 2013 04:26:11 -0800 (PST)
Received: from mail-ea0-f179.google.com (mail-ea0-f179.google.com
	[209.85.215.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))
	(No client certificate requested)
	by olra.theworths.org (Postfix) with ESMTPS id A8ED3429E4D
	for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:25:23 -0800 (PST)
Received: by mail-ea0-f179.google.com with SMTP id b10so2837979eae.24
	for <notmuch@notmuchmail.org>; Sun, 03 Nov 2013 04:25:22 -0800 (PST)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
	d=1e100.net; s=20130820;
	h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
	:references:in-reply-to:references;
	bh=WeGfvp6a4EP8L1ifomZVo8jwfP5pA0geltsbmHOM2o0=;
	b=LMNuW0WvouORGUKS6nvtfmEEJsfAB+Cxmur0k2eI5HyyCCU8vDddBkP1gIkefio9ZJ
	NbVFm/erRq6WdPcyA0vXd2TVqgR24cs45NFlw7ckuYlyAlPozrz+/UZntAE+ZW98R72s
	JphnrbXjf+qMCBstVyuEnqgzCEJOMGqOMPghCVyiK7EQDX2yEJfJcxxAZplUfBN4Wlpy
	9gn5vBAZpPJ7Qq4zDPACMLmWNxZGKRcB3H+fNSCTGbZyA5YznM9qxlhFQ26uRxrop3Fr
	6+SLJQ6iiU+haqgouWrIg0wuwkiKNtYRdifVrkDkyht/1juoRVgKqq6RgkvTYn6Wy26O
	oiFg==
X-Gm-Message-State:
 ALoCoQnhSuUG7E0xXbdY6unYKfC3ot/qnNcaVDET7InzHKkd0lHjedtFUlg/Agd771qHbPMs7q1r
X-Received: by 10.14.42.6 with SMTP id i6mr153790eeb.65.1383481522523;
	Sun, 03 Nov 2013 04:25:22 -0800 (PST)
Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.
	[88.195.111.91])
	by mx.google.com with ESMTPSA id e13sm32850621eeu.4.2013.11.03.04.25.21
	for <multiple recipients>
	(version=TLSv1.2 cipher=RC4-SHA bits=128/128);
	Sun, 03 Nov 2013 04:25:21 -0800 (PST)
From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 11/11] man: document notmuch compact --verbose and
	--backup=DIRECTORY options
Date: Sun,  3 Nov 2013 14:24:51 +0200
Message-Id:
 <3801222bf725ea36d8d0e9c9cd8ff9f27c043adb.1383481295.git.jani@nikula.org>
X-Mailer: git-send-email 1.8.4.rc3
In-Reply-To: <cover.1383481295.git.jani@nikula.org>
References: <cover.1383481295.git.jani@nikula.org>
In-Reply-To: <cover.1383481295.git.jani@nikula.org>
References: <cover.1383481295.git.jani@nikula.org>
X-BeenThere: notmuch@notmuchmail.org
X-Mailman-Version: 2.1.13
Precedence: list
List-Id: "Use and development of the notmuch mail system."
	<notmuch.notmuchmail.org>
List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>
List-Archive: <http://notmuchmail.org/pipermail/notmuch>
List-Post: <mailto:notmuch@notmuchmail.org>
List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>
List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,
	<mailto:notmuch-request@notmuchmail.org?subject=subscribe>
X-List-Received-Date: Sun, 03 Nov 2013 12:26:19 -0000

---
 man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1
index 1aeed22..dfffccb 100644
--- a/man/man1/notmuch-compact.1
+++ b/man/man1/notmuch-compact.1
@@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database
 .SH SYNOPSIS
 
 .B notmuch compact
+.RI "[ --verbose ]"
+.RI "[ --backup=<" directory "> ]"
 
 .SH DESCRIPTION
 
@@ -14,11 +16,35 @@ 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.
+database is discarded, unless the
+.BR "\-\-backup=" <directory>
+option is used.
 
 Note that the database write lock will be held during the compaction
 process (which may be quite long) to protect data integrity.
 
+Supported options for
+.B compact
+include
+
+.RS 4
+.TP 4
+.BR "\-\-backup=" <directory>
+
+Save the current database to the given directory before replacing it
+with the compacted database. The backup directory must not exist and
+it must reside on the same mounted filesystem as the current database.
+
+.RE
+
+.RS 4
+.TP 4
+.BR \-\-verbose
+
+Report database compaction progress to stdout.
+
+.RE
+
 .RE
 .SH ENVIRONMENT
 The following environment variables can be used to control the
-- 
1.8.4.rc3