[PATCH v2 11/11] man: document notmuch compact --verbose and --backup=DIRECTORY options

diff --git a/7c/06f401c8e0041245db4b4cbcf512ea8ecb922d b/7c/06f401c8e0041245db4b4cbcf512ea8ecb922d
new file mode 100644 (file)
index 0000000..d0027bf
--- /dev/null
+++ b/7c/06f401c8e0041245db4b4cbcf512ea8ecb922d
@@ -0,0 +1,128 @@
+Return-Path: <jani@nikula.org>\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 19864431FAF\r
+       for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:26:19 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[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 ha7AgN77aK+u for <notmuch@notmuchmail.org>;\r
+       Sun,  3 Nov 2013 04:26:11 -0800 (PST)\r
+Received: from mail-ea0-f179.google.com (mail-ea0-f179.google.com\r
+       [209.85.215.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id A8ED3429E4D\r
+       for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:25:23 -0800 (PST)\r
+Received: by mail-ea0-f179.google.com with SMTP id b10so2837979eae.24\r
+       for <notmuch@notmuchmail.org>; Sun, 03 Nov 2013 04:25:22 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=1e100.net; s=20130820;\r
+       h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
+       :references:in-reply-to:references;\r
+       bh=WeGfvp6a4EP8L1ifomZVo8jwfP5pA0geltsbmHOM2o0=;\r
+       b=LMNuW0WvouORGUKS6nvtfmEEJsfAB+Cxmur0k2eI5HyyCCU8vDddBkP1gIkefio9ZJ\r
+       NbVFm/erRq6WdPcyA0vXd2TVqgR24cs45NFlw7ckuYlyAlPozrz+/UZntAE+ZW98R72s\r
+       JphnrbXjf+qMCBstVyuEnqgzCEJOMGqOMPghCVyiK7EQDX2yEJfJcxxAZplUfBN4Wlpy\r
+       9gn5vBAZpPJ7Qq4zDPACMLmWNxZGKRcB3H+fNSCTGbZyA5YznM9qxlhFQ26uRxrop3Fr\r
+       6+SLJQ6iiU+haqgouWrIg0wuwkiKNtYRdifVrkDkyht/1juoRVgKqq6RgkvTYn6Wy26O\r
+       oiFg==\r
+X-Gm-Message-State:\r
+ ALoCoQnhSuUG7E0xXbdY6unYKfC3ot/qnNcaVDET7InzHKkd0lHjedtFUlg/Agd771qHbPMs7q1r\r
+X-Received: by 10.14.42.6 with SMTP id i6mr153790eeb.65.1383481522523;\r
+       Sun, 03 Nov 2013 04:25:22 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+       [88.195.111.91])\r
+       by mx.google.com with ESMTPSA id e13sm32850621eeu.4.2013.11.03.04.25.21\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Sun, 03 Nov 2013 04:25:21 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 11/11] man: document notmuch compact --verbose and\r
+       --backup=DIRECTORY options\r
+Date: Sun,  3 Nov 2013 14:24:51 +0200\r
+Message-Id:\r
+ <3801222bf725ea36d8d0e9c9cd8ff9f27c043adb.1383481295.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
+References: <cover.1383481295.git.jani@nikula.org>\r
+In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
+References: <cover.1383481295.git.jani@nikula.org>\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: Sun, 03 Nov 2013 12:26:19 -0000\r
+\r
+---\r
+ man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-\r
+ 1 file changed, 27 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
+index 1aeed22..dfffccb 100644\r
+--- a/man/man1/notmuch-compact.1\r
++++ b/man/man1/notmuch-compact.1\r
+@@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database\r
+ .SH SYNOPSIS\r
+ \r
+ .B notmuch compact\r
++.RI "[ --verbose ]"\r
++.RI "[ --backup=<" directory "> ]"\r
+ \r
+ .SH DESCRIPTION\r
+ \r
+@@ -14,11 +16,35 @@ 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
++database is discarded, unless the\r
++.BR "\-\-backup=" <directory>\r
++option is used.\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
++Supported options for\r
++.B compact\r
++include\r
++\r
++.RS 4\r
++.TP 4\r
++.BR "\-\-backup=" <directory>\r
++\r
++Save the current database to the given directory before replacing it\r
++with the compacted database. The backup directory must not exist and\r
++it must reside on the same mounted filesystem as the current database.\r
++\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
++.BR \-\-verbose\r
++\r
++Report database compaction progress to stdout.\r
++\r
++.RE\r
++\r
+ .RE\r
+ .SH ENVIRONMENT\r
+ The following environment variables can be used to control the\r
+-- \r
+1.8.4.rc3\r
+\r