7c/06f401c8e0041245db4b4cbcf512ea8ecb922d

   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 19864431FAF\r
   6         for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:26:19 -0800 (PST)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
   9 X-Spam-Flag: NO\r
  10 X-Spam-Score: -0.7\r
  11 X-Spam-Level: \r
  12 X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
  13         tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
  14 Received: from olra.theworths.org ([127.0.0.1])\r
  15         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  16         with ESMTP id ha7AgN77aK+u for <notmuch@notmuchmail.org>;\r
  17         Sun,  3 Nov 2013 04:26:11 -0800 (PST)\r
  18 Received: from mail-ea0-f179.google.com (mail-ea0-f179.google.com\r
  19         [209.85.215.179]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
  20         (No client certificate requested)\r
  21         by olra.theworths.org (Postfix) with ESMTPS id A8ED3429E4D\r
  22         for <notmuch@notmuchmail.org>; Sun,  3 Nov 2013 04:25:23 -0800 (PST)\r
  23 Received: by mail-ea0-f179.google.com with SMTP id b10so2837979eae.24\r
  24         for <notmuch@notmuchmail.org>; Sun, 03 Nov 2013 04:25:22 -0800 (PST)\r
  25 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
  26         d=1e100.net; s=20130820;\r
  27         h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
  28         :references:in-reply-to:references;\r
  29         bh=WeGfvp6a4EP8L1ifomZVo8jwfP5pA0geltsbmHOM2o0=;\r
  30         b=LMNuW0WvouORGUKS6nvtfmEEJsfAB+Cxmur0k2eI5HyyCCU8vDddBkP1gIkefio9ZJ\r
  31         NbVFm/erRq6WdPcyA0vXd2TVqgR24cs45NFlw7ckuYlyAlPozrz+/UZntAE+ZW98R72s\r
  32         JphnrbXjf+qMCBstVyuEnqgzCEJOMGqOMPghCVyiK7EQDX2yEJfJcxxAZplUfBN4Wlpy\r
  33         9gn5vBAZpPJ7Qq4zDPACMLmWNxZGKRcB3H+fNSCTGbZyA5YznM9qxlhFQ26uRxrop3Fr\r
  34         6+SLJQ6iiU+haqgouWrIg0wuwkiKNtYRdifVrkDkyht/1juoRVgKqq6RgkvTYn6Wy26O\r
  35         oiFg==\r
  36 X-Gm-Message-State:\r
  37  ALoCoQnhSuUG7E0xXbdY6unYKfC3ot/qnNcaVDET7InzHKkd0lHjedtFUlg/Agd771qHbPMs7q1r\r
  38 X-Received: by 10.14.42.6 with SMTP id i6mr153790eeb.65.1383481522523;\r
  39         Sun, 03 Nov 2013 04:25:22 -0800 (PST)\r
  40 Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
  41         [88.195.111.91])\r
  42         by mx.google.com with ESMTPSA id e13sm32850621eeu.4.2013.11.03.04.25.21\r
  43         for <multiple recipients>\r
  44         (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
  45         Sun, 03 Nov 2013 04:25:21 -0800 (PST)\r
  46 From: Jani Nikula <jani@nikula.org>\r
  47 To: notmuch@notmuchmail.org\r
  48 Subject: [PATCH v2 11/11] man: document notmuch compact --verbose and\r
  49         --backup=DIRECTORY options\r
  50 Date: Sun,  3 Nov 2013 14:24:51 +0200\r
  51 Message-Id:\r
  52  <3801222bf725ea36d8d0e9c9cd8ff9f27c043adb.1383481295.git.jani@nikula.org>\r
  53 X-Mailer: git-send-email 1.8.4.rc3\r
  54 In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
  55 References: <cover.1383481295.git.jani@nikula.org>\r
  56 In-Reply-To: <cover.1383481295.git.jani@nikula.org>\r
  57 References: <cover.1383481295.git.jani@nikula.org>\r
  58 X-BeenThere: notmuch@notmuchmail.org\r
  59 X-Mailman-Version: 2.1.13\r
  60 Precedence: list\r
  61 List-Id: "Use and development of the notmuch mail system."\r
  62         <notmuch.notmuchmail.org>\r
  63 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  64         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  65 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  66 List-Post: <mailto:notmuch@notmuchmail.org>\r
  67 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  68 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  69         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  70 X-List-Received-Date: Sun, 03 Nov 2013 12:26:19 -0000\r
  71 \r
  72 ---\r
  73  man/man1/notmuch-compact.1 | 28 +++++++++++++++++++++++++++-\r
  74  1 file changed, 27 insertions(+), 1 deletion(-)\r
  75 \r
  76 diff --git a/man/man1/notmuch-compact.1 b/man/man1/notmuch-compact.1\r
  77 index 1aeed22..dfffccb 100644\r
  78 --- a/man/man1/notmuch-compact.1\r
  79 +++ b/man/man1/notmuch-compact.1\r
  80 @@ -4,6 +4,8 @@ notmuch-compact \- compact the notmuch database\r
  81  .SH SYNOPSIS\r
  82  \r
  83  .B notmuch compact\r
  84 +.RI "[ --verbose ]"\r
  85 +.RI "[ --backup=<" directory "> ]"\r
  86  \r
  87  .SH DESCRIPTION\r
  88  \r
  89 @@ -14,11 +16,35 @@ the space required by the database and improve lookup performance.\r
  90  \r
  91  The compacted database is built in a temporary directory and is later\r
  92  moved into the place of the origin database. The original uncompacted\r
  93 -database is preserved to be deleted by the user as desired.\r
  94 +database is discarded, unless the\r
  95 +.BR "\-\-backup=" <directory>\r
  96 +option is used.\r
  97  \r
  98  Note that the database write lock will be held during the compaction\r
  99  process (which may be quite long) to protect data integrity.\r
 100  \r
 101 +Supported options for\r
 102 +.B compact\r
 103 +include\r
 104 +\r
 105 +.RS 4\r
 106 +.TP 4\r
 107 +.BR "\-\-backup=" <directory>\r
 108 +\r
 109 +Save the current database to the given directory before replacing it\r
 110 +with the compacted database. The backup directory must not exist and\r
 111 +it must reside on the same mounted filesystem as the current database.\r
 112 +\r
 113 +.RE\r
 114 +\r
 115 +.RS 4\r
 116 +.TP 4\r
 117 +.BR \-\-verbose\r
 118 +\r
 119 +Report database compaction progress to stdout.\r
 120 +\r
 121 +.RE\r
 122 +\r
 123  .RE\r
 124  .SH ENVIRONMENT\r
 125  The following environment variables can be used to control the\r
 126 -- \r
 127 1.8.4.rc3\r
 128 \r