a7/f2ae5d1aeb0402a14f026f821af02433d077b4

   1 Return-Path: <bremner@tethera.net>\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 A3DF4431FC2\r
   6         for <notmuch@notmuchmail.org>; Thu, 23 Jan 2014 05:03:05 -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\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
  12         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 bkHxfRPvD60o for <notmuch@notmuchmail.org>;\r
  16         Thu, 23 Jan 2014 05:02:59 -0800 (PST)\r
  17 Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
  18         (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
  19         (No client certificate requested)\r
  20         by olra.theworths.org (Postfix) with ESMTPS id 7D357431FB6\r
  21         for <notmuch@notmuchmail.org>; Thu, 23 Jan 2014 05:02:59 -0800 (PST)\r
  22 Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
  23         (envelope-from <bremner@tethera.net>)\r
  24         id 1W6Jvv-0006gs-2O; Thu, 23 Jan 2014 09:02:59 -0400\r
  25 Received: (nullmailer pid 10643 invoked by uid 1000); Thu, 23 Jan 2014\r
  26         13:02:55 -0000\r
  27 From: David Bremner <david@tethera.net>\r
  28 To: notmuch@notmuchmail.org\r
  29 Subject: [PATCH 2/2] man: update notmuch-dump man page for new default.\r
  30 Date: Thu, 23 Jan 2014 09:02:47 -0400\r
  31 Message-Id: <1390482167-10473-2-git-send-email-david@tethera.net>\r
  32 X-Mailer: git-send-email 1.8.5.2\r
  33 In-Reply-To: <1390482167-10473-1-git-send-email-david@tethera.net>\r
  34 References: <m24n4xo2r0.fsf@guru.guru-group.fi>\r
  35         <1390482167-10473-1-git-send-email-david@tethera.net>\r
  36 X-BeenThere: notmuch@notmuchmail.org\r
  37 X-Mailman-Version: 2.1.13\r
  38 Precedence: list\r
  39 List-Id: "Use and development of the notmuch mail system."\r
  40         <notmuch.notmuchmail.org>\r
  41 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  42         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  43 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  44 List-Post: <mailto:notmuch@notmuchmail.org>\r
  45 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  46 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  47         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  48 X-List-Received-Date: Thu, 23 Jan 2014 13:03:05 -0000\r
  49 \r
  50 Actually the previous default was not documented explicitely.  I moved\r
  51 the batch-tag section first because it seemed that the formats were\r
  52 previously documented in order default, other.\r
  53 ---\r
  54  man/man1/notmuch-dump.1 | 54 +++++++++++++++++++++++++------------------------\r
  55  1 file changed, 28 insertions(+), 26 deletions(-)\r
  56 \r
  57 diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
  58 index 0c52d1b..16e72eb 100644\r
  59 --- a/man/man1/notmuch-dump.1\r
  60 +++ b/man/man1/notmuch-dump.1\r
  61 @@ -28,6 +28,34 @@ per line, followed by a list of tags.\r
  62  \r
  63  .RS 4\r
  64  .TP 4\r
  65 +.B batch-tag\r
  66 +\r
  67 +The default\r
  68 +.B batch-tag\r
  69 +dump format is intended to more robust against malformed message-ids\r
  70 +and tags containing whitespace or non-\fBascii\fR(7) characters.\r
  71 +Each line has the form\r
  72 +\r
  73 +.RS 4\r
  74 +.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
  75 +\r
  76 +Tags are hex-encoded by replacing every byte not matching the regex\r
  77 +.B [A-Za-z0-9@=.,_+-]\r
  78 +with\r
  79 +.B %nn\r
  80 +where nn is the two digit hex encoding.  The message ID is a valid Xapian\r
  81 +query, quoted using Xapian boolean term quoting rules: if the ID contains\r
  82 +whitespace or a close paren or starts with a double quote, it must be\r
  83 +enclosed in double quotes and double quotes inside the ID must be doubled.\r
  84 +The astute reader will notice this is a special case of the batch input\r
  85 +format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
  86 +mandatory for \fBnotmuch-restore\fR(1).\r
  87 +\r
  88 +.RE\r
  89 +.RE\r
  90 +\r
  91 +.RS 4\r
  92 +.TP 4\r
  93  .B sup\r
  94  \r
  95  The\r
  96 @@ -53,32 +81,6 @@ that tags with spaces will not be correctly restored with this format.\r
  97  .RE\r
  98  \r
  99  .RE\r
 100 -.RS 4\r
 101 -.TP 4\r
 102 -.B batch-tag\r
 103 -\r
 104 -The\r
 105 -.B batch-tag\r
 106 -dump format is intended to more robust against malformed message-ids\r
 107 -and tags containing whitespace or non-\fBascii\fR(7) characters.\r
 108 -Each line has the form\r
 109 -\r
 110 -.RS 4\r
 111 -.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
 112 -\r
 113 -Tags are hex-encoded by replacing every byte not matching the regex\r
 114 -.B [A-Za-z0-9@=.,_+-]\r
 115 -with\r
 116 -.B %nn\r
 117 -where nn is the two digit hex encoding.  The message ID is a valid Xapian\r
 118 -query, quoted using Xapian boolean term quoting rules: if the ID contains\r
 119 -whitespace or a close paren or starts with a double quote, it must be\r
 120 -enclosed in double quotes and double quotes inside the ID must be doubled.\r
 121 -The astute reader will notice this is a special case of the batch input\r
 122 -format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
 123 -mandatory for \fBnotmuch-restore\fR(1).\r
 124 -\r
 125 -.RE\r
 126  \r
 127  \r
 128  With no search terms, a dump of all messages in the database will be\r
 129 -- \r
 130 1.8.5.2\r
 131 \r