From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id 1A1CB429E5A for ; Wed, 6 Nov 2013 10:37:31 -0800 (PST) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org 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 4noFgRdAcQKi for ; Wed, 6 Nov 2013 10:37:23 -0800 (PST) Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com [74.125.83.41]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client certificate requested) by olra.theworths.org (Postfix) with ESMTPS id 5E3CA429E53 for ; Wed, 6 Nov 2013 10:37:23 -0800 (PST) Received: by mail-ee0-f41.google.com with SMTP id e53so2767195eek.14 for ; Wed, 06 Nov 2013 10:37: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; bh=9ILYd6fY9jf2dvOHLU/FQ9ZIxA/jEuIIrHGXR0cy6g0=; b=P204LuiF6qp/9abqUYNxzoxfzLto+S+ecl3McgVbdyqLRXrKL8wd/1oZP8vXTKSvi0 I/ztfmDpdJF6o4cNHHEOijxqqBjjr+eTWHROwqQrUCzu2/UhpdpQQ/eQ3DD+JzuXWI46 DUbSW1TeTHchxaoW2tLLsGkc5LxC1GLnuF7VWGwkVsLNB8WAui6OH05gq4K3X3tW3qUt 687ns7kb9wEiRhC6iexzckBgffkHvIBkFeDTh9gfKBpm8kIwbGP9Lb/wsAy9Lt0PJJ5y G/g0tZD+19KbF2zJNbu41lrdpFk/LB4FAo5vvU07T05otwURDZNgkmktXTY3wOpgLZnS jmWg== X-Gm-Message-State: ALoCoQklxSiUXoPPg+dJ1y1cCPchhz55w2vy4aZgsmPlc2zFb3nJ8Gm5pBSEkpObi1/Y3lm/NDLL X-Received: by 10.15.60.197 with SMTP id g45mr1014952eex.103.1383755943252; Wed, 06 Nov 2013 08:39:03 -0800 (PST) Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. [88.195.111.91]) by mx.google.com with ESMTPSA id s3sm75647659eeo.3.2013.11.06.08.39.01 for (version=TLSv1.2 cipher=RC4-SHA bits=128/128); Wed, 06 Nov 2013 08:39:02 -0800 (PST) From: Jani Nikula To: notmuch@notmuchmail.org Subject: [PATCH 2/2] man: document notmuch compact --quiet and --backup=DIRECTORY options Date: Wed, 6 Nov 2013 18:38:56 +0200 Message-Id: <1383755936-11862-2-git-send-email-jani@nikula.org> X-Mailer: git-send-email 1.8.4.rc3 In-Reply-To: <1383755936-11862-1-git-send-email-jani@nikula.org> References: <3d33996df44b338847dac930b6cd294c57b6e54b.1383481295.git.jani@nikula.org> <1383755936-11862-1-git-send-email-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." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 06 Nov 2013 18:37:31 -0000 --- v2: --verbose -> --quiet --- 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..0c95873 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 "[ --quiet ]" +.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=" +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=" + +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 \-\-quiet + +Do not report database compaction progress to stdout. + +.RE + .RE .SH ENVIRONMENT The following environment variables can be used to control the -- 1.8.4.rc3