42/62c00e7a13bc8c3868fd57953e63a26f0171f1

   1 Return-Path: <jani@nikula.org>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 1A1CB429E5A\r
   6         for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:37:31 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: -0.7\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  12         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  13 Received: from olra.theworths.org ([127.0.0.1])\r
  14         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  15         with ESMTP id 4noFgRdAcQKi for <notmuch@notmuchmail.org>;\r
  16         Wed,  6 Nov 2013 10:37:23 -0800 (PST)\r
  17 Received: from mail-ee0-f41.google.com (mail-ee0-f41.google.com\r
  18  [74.125.83.41])        (using TLSv1 with cipher RC4-SHA (128/128 bits))        (No client\r
  19  certificate requested) by olra.theworths.org (Postfix) with ESMTPS id\r
  20  5E3CA429E53    for <notmuch@notmuchmail.org>; Wed,  6 Nov 2013 10:37:23 -0800\r
  21  (PST)\r
  22 Received: by mail-ee0-f41.google.com with SMTP id e53so2767195eek.14\r
  23         for <notmuch@notmuchmail.org>; Wed, 06 Nov 2013 10:37:22 -0800 (PST)\r
  24 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
  25         d=1e100.net; s=20130820;\r
  26         h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
  27         :references;\r
  28         bh=9ILYd6fY9jf2dvOHLU/FQ9ZIxA/jEuIIrHGXR0cy6g0=;\r
  29         b=P204LuiF6qp/9abqUYNxzoxfzLto+S+ecl3McgVbdyqLRXrKL8wd/1oZP8vXTKSvi0\r
  30         I/ztfmDpdJF6o4cNHHEOijxqqBjjr+eTWHROwqQrUCzu2/UhpdpQQ/eQ3DD+JzuXWI46\r
  31         DUbSW1TeTHchxaoW2tLLsGkc5LxC1GLnuF7VWGwkVsLNB8WAui6OH05gq4K3X3tW3qUt\r
  32         687ns7kb9wEiRhC6iexzckBgffkHvIBkFeDTh9gfKBpm8kIwbGP9Lb/wsAy9Lt0PJJ5y\r
  33         G/g0tZD+19KbF2zJNbu41lrdpFk/LB4FAo5vvU07T05otwURDZNgkmktXTY3wOpgLZnS\r
  34         jmWg==\r
  35 X-Gm-Message-State:\r
  36  ALoCoQklxSiUXoPPg+dJ1y1cCPchhz55w2vy4aZgsmPlc2zFb3nJ8Gm5pBSEkpObi1/Y3lm/NDLL\r
  37 X-Received: by 10.15.60.197 with SMTP id g45mr1014952eex.103.1383755943252;\r
  38         Wed, 06 Nov 2013 08:39:03 -0800 (PST)\r
  39 Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
  40         [88.195.111.91])\r
  41         by mx.google.com with ESMTPSA id s3sm75647659eeo.3.2013.11.06.08.39.01\r
  42         for <multiple recipients>\r
  43         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  44         Wed, 06 Nov 2013 08:39:02 -0800 (PST)\r
  45 From: Jani Nikula <jani@nikula.org>\r
  46 To: notmuch@notmuchmail.org\r
  47 Subject: [PATCH 2/2] man: document notmuch compact --quiet and\r
  48         --backup=DIRECTORY options\r
  49 Date: Wed,  6 Nov 2013 18:38:56 +0200\r
  50 Message-Id: <1383755936-11862-2-git-send-email-jani@nikula.org>\r
  51 X-Mailer: git-send-email 1.8.4.rc3\r
  52 In-Reply-To: <1383755936-11862-1-git-send-email-jani@nikula.org>\r
  53 References:\r
  54  <3d33996df44b338847dac930b6cd294c57b6e54b.1383481295.git.jani@nikula.org>\r
  55         <1383755936-11862-1-git-send-email-jani@nikula.org>\r
  56 X-BeenThere: notmuch@notmuchmail.org\r
  57 X-Mailman-Version: 2.1.13\r
  58 Precedence: list\r
  59 List-Id: "Use and development of the notmuch mail system."\r
  60         <notmuch.notmuchmail.org>\r
  61 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  62         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  63 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  64 List-Post: <mailto:notmuch@notmuchmail.org>\r
  65 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  66 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  67         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  68 X-List-Received-Date: Wed, 06 Nov 2013 18:37:31 -0000\r
  69 \r
  70 ---\r
  71 \r
  72 v2: --verbose -> --quiet\r
  73 ---\r
  74  man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-\r
  75  1 file changed, 27 insertions(+), 1 deletion(-)\r
  76 \r
  77 diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
  78 index 1aeed22..0c95873 100644\r
  79 --- a/man/man1/notmuch-compact.1\r
  80 +++ b/man/man1/notmuch-compact.1\r
  81 @@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database\r
  82  .SH SYNOPSIS\r
  83  \r
  84  .B notmuch compact\r
  85 +.RI "[ --quiet ]"\r
  86 +.RI "[ --backup=<" directory "> ]"\r
  87  \r
  88  .SH DESCRIPTION\r
  89  \r
  90 @@ -14,11 +16,35 @@ the space required by the database and improve lookup performance.\r
  91  \r
  92  The compacted database is built in a temporary directory and is later\r
  93  moved into the place of the origin database. The original uncompacted\r
  94 -database is preserved to be deleted by the user as desired.\r
  95 +database is discarded, unless the\r
  96 +.BR "\-\-backup=" <directory>\r
  97 +option is used.\r
  98  \r
  99  Note that the database write lock will be held during the compaction\r
 100  process (which may be quite long) to protect data integrity.\r
 101  \r
 102 +Supported options for\r
 103 +.B compact\r
 104 +include\r
 105 +\r
 106 +.RS 4\r
 107 +.TP 4\r
 108 +.BR "\-\-backup=" <directory>\r
 109 +\r
 110 +Save the current database to the given directory before replacing it\r
 111 +with the compacted database. The backup directory must not exist and\r
 112 +it must reside on the same mounted filesystem as the current database.\r
 113 +\r
 114 +.RE\r
 115 +\r
 116 +.RS 4\r
 117 +.TP 4\r
 118 +.BR \-\-quiet\r
 119 +\r
 120 +Do not report database compaction progress to stdout.\r
 121 +\r
 122 +.RE\r
 123 +\r
 124  .RE\r
 125  .SH ENVIRONMENT\r
 126  The following environment variables can be used to control the\r
 127 -- \r
 128 1.8.4.rc3\r
 129 \r