[PATCH 2/2] man: document notmuch compact --quiet and --backup=DIRECTORY options

diff --git a/42/62c00e7a13bc8c3868fd57953e63a26f0171f1 b/42/62c00e7a13bc8c3868fd57953e63a26f0171f1
new file mode 100644 (file)
index 0000000..2ce7365
--- /dev/null
+++ b/42/62c00e7a13bc8c3868fd57953e63a26f0171f1
@@ -0,0 +1,129 @@
+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 1A1CB429E5A\r
+       for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:37:31 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\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 4noFgRdAcQKi for <notmuch@notmuchmail.org>;\r
+       Wed,  6 Nov 2013 10:37:23 -0800 (PST)\r
+Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com\r
+ [74.125.83.41])       (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
+ certificate requested)        by olra.theworths.org (Postfix) with ESMTPS id\r
+ 5E3CA429E53   for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:37:23 -0800\r
+ (PST)\r
+Received: by mail-ee0-f41.google.com with SMTP id e53so2767195eek.14\r
+       for <notmuch@notmuchmail.org>; Wed, 06 Nov 2013 10:37: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;\r
+       bh=9ILYd6fY9jf2dvOHLU/FQ9ZIxA/jEuIIrHGXR0cy6g0=;\r
+       b=P204LuiF6qp/9abqUYNxzoxfzLto+S+ecl3McgVbdyqLRXrKL8wd/1oZP8vXTKSvi0\r
+       I/ztfmDpdJF6o4cNHHEOijxqqBjjr+eTWHROwqQrUCzu2/UhpdpQQ/eQ3DD+JzuXWI46\r
+       DUbSW1TeTHchxaoW2tLLsGkc5LxC1GLnuF7VWGwkVsLNB8WAui6OH05gq4K3X3tW3qUt\r
+       687ns7kb9wEiRhC6iexzckBgffkHvIBkFeDTh9gfKBpm8kIwbGP9Lb/wsAy9Lt0PJJ5y\r
+       G/g0tZD+19KbF2zJNbu41lrdpFk/LB4FAo5vvU07T05otwURDZNgkmktXTY3wOpgLZnS\r
+       jmWg==\r
+X-Gm-Message-State:\r
+ ALoCoQklxSiUXoPPg+dJ1y1cCPchhz55w2vy4aZgsmPlc2zFb3nJ8Gm5pBSEkpObi1/Y3lm/NDLL\r
+X-Received: by 10.15.60.197 with SMTP id g45mr1014952eex.103.1383755943252;\r
+       Wed, 06 Nov 2013 08:39:03 -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 s3sm75647659eeo.3.2013.11.06.08.39.01\r
+       for <multiple recipients>\r
+       (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+       Wed, 06 Nov 2013 08:39:02 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/2] man: document notmuch compact --quiet and\r
+       --backup=DIRECTORY options\r
+Date: Wed,  6 Nov 2013 18:38:56 +0200\r
+Message-Id: <1383755936-11862-2-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <1383755936-11862-1-git-send-email-jani@nikula.org>\r
+References:\r
+ <3d33996df44b338847dac930b6cd294c57b6e54b.1383481295.git.jani@nikula.org>\r
+       <1383755936-11862-1-git-send-email-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: Wed, 06 Nov 2013 18:37:31 -0000\r
+\r
+---\r
+\r
+v2: --verbose -> --quiet\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..0c95873 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 "[ --quiet ]"\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 \-\-quiet\r
++\r
++Do not 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