3e/2f9a6ec773d95dc0de4b65904555df91ac38b7

   1 Return-Path: <amdragon@mit.edu>\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 6EECC431FB6\r
   6         for <notmuch@notmuchmail.org>; Tue, 25 Dec 2012 19:49:07 -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 SB6n4hlUr+Jp for <notmuch@notmuchmail.org>;\r
  16         Tue, 25 Dec 2012 19:49:03 -0800 (PST)\r
  17 Received: from dmz-mailsec-scanner-1.mit.edu (DMZ-MAILSEC-SCANNER-1.MIT.EDU\r
  18         [18.9.25.12])\r
  19         by olra.theworths.org (Postfix) with ESMTP id 47EBF431FBD\r
  20         for <notmuch@notmuchmail.org>; Tue, 25 Dec 2012 19:49:00 -0800 (PST)\r
  21 X-AuditID: 1209190c-b7fa86d000001d37-85-50da73ab5ccc\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         by dmz-mailsec-scanner-1.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id 36.51.07479.BA37AD05; Tue, 25 Dec 2012 22:48:59 -0500 (EST)\r
  25 Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
  26         by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id qBQ3muBG023722; \r
  27         Tue, 25 Dec 2012 22:48:56 -0500\r
  28 Received: from drake.dyndns.org (c-76-21-105-205.hsd1.ca.comcast.net\r
  29         [76.21.105.205]) (authenticated bits=0)\r
  30         (User authenticated as amdragon@ATHENA.MIT.EDU)\r
  31         by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qBQ3mrnW013185\r
  32         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  33         Tue, 25 Dec 2012 22:48:55 -0500 (EST)\r
  34 Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
  35         (envelope-from <amdragon@mit.edu>)\r
  36         id 1Tnhz9-0002z4-1j; Tue, 25 Dec 2012 22:48:51 -0500\r
  37 From: Austin Clements <amdragon@MIT.EDU>\r
  38 To: notmuch@notmuchmail.org\r
  39 Subject: [PATCH v2 5/5] man: Update notmuch-dump(1) and notmuch-restore(1)\r
  40 Date: Tue, 25 Dec 2012 22:48:43 -0500\r
  41 Message-Id: <1356493723-11085-6-git-send-email-amdragon@mit.edu>\r
  42 X-Mailer: git-send-email 1.7.10.4\r
  43 In-Reply-To: <1356493723-11085-1-git-send-email-amdragon@mit.edu>\r
  44 References: <1356493723-11085-1-git-send-email-amdragon@mit.edu>\r
  45 X-Brightmail-Tracker:\r
  46  H4sIAAAAAAAAA+NgFrrNIsWRmVeSWpSXmKPExsUixCmqrLu6+FaAwZ3vAhY3WrsZLZqmO1us\r
  47         nstjcf3mTGYHFo+ds+6ye9y6/5rd49mqW8weWw69Zw5gieKySUnNySxLLdK3S+DKuHvpOEvB\r
  48         TsGKKYdamBoYN/J1MXJySAiYSHTs38kOYYtJXLi3nq2LkYtDSGAfo8T2FW9ZIZwNjBLXH39j\r
  49         hnAuMkn0Tr3HBOHMZZS4umAvE0g/m4CGxLb9yxlBbBEBaYmdd2ezgtjMAnkSDx9tBdshLOAl\r
  50         ce/gc7A4i4CqRMelF8wgNq+Ag8SvE/eh7lCU6H42AegODg5OAUeJnQ/qQMJCQCUTH55nmsDI\r
  51         v4CRYRWjbEpulW5uYmZOcWqybnFyYl5eapGuoV5uZoleakrpJkZwuEny7GB8c1DpEKMAB6MS\r
  52         Dy/Hr5sBQqyJZcWVuYcYJTmYlER5txfcChDiS8pPqcxILM6ILyrNSS0+xCjBwawkwuv8Eaic\r
  53         NyWxsiq1KB8mJc3BoiTOeznlpr+QQHpiSWp2ampBahFMVoaDQ0mC910R0FDBotT01Iq0zJwS\r
  54         hDQTByfIcB6g4TdBaniLCxJzizPTIfKnGHU5Gl7eeMooxJKXn5cqJc57AaRIAKQoozQPbg4s\r
  55         TbxiFAd6S5h3D0gVDzDFwE16BbSECWhJLN8NkCUliQgpqQZGiTBBo9V6NZcuXZMSZanT+9C+\r
  56         kaux5dC2980Llr82qrze/OX8Co9dfCbyy30franvfCe2W6/2+ONzHMvlH8Q9jo/f9G8ZV+uk\r
  57         9vyI6qX1QlmX0nme6i4VWnqF+6V71OHr34vFc45/vSK6e+vLNTaqKR5+3U1SrW8v7F/47d6h\r
  58         le8/W1/WF5ZOV2Ipzkg01GIuKk4EANFpoN3uAgAA\r
  59 X-BeenThere: notmuch@notmuchmail.org\r
  60 X-Mailman-Version: 2.1.13\r
  61 Precedence: list\r
  62 List-Id: "Use and development of the notmuch mail system."\r
  63         <notmuch.notmuchmail.org>\r
  64 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  65         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  66 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  67 List-Post: <mailto:notmuch@notmuchmail.org>\r
  68 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  69 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  70         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  71 X-List-Received-Date: Wed, 26 Dec 2012 03:49:08 -0000\r
  72 \r
  73 Describe the new batch-tag format.  For notmuch-restore, rather than\r
  74 half-heartedly duplicating the description, we now cite notmuch-dump.\r
  75 ---\r
  76  man/man1/notmuch-dump.1    |   11 +++++++----\r
  77  man/man1/notmuch-restore.1 |    6 ++----\r
  78  2 files changed, 9 insertions(+), 8 deletions(-)\r
  79 \r
  80 diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
  81 index 770b00f..7bd6def 100644\r
  82 --- a/man/man1/notmuch-dump.1\r
  83 +++ b/man/man1/notmuch-dump.1\r
  84 @@ -64,13 +64,16 @@ and tags containing whitespace or non-\fBascii\fR(7) characters.\r
  85  Each line has the form\r
  86  \r
  87  .RS 4\r
  88 -.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id >\r
  89 +.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
  90  \r
  91 -where encoded means that every byte not matching the regex\r
  92 +Tags are hex-encoded by replacing every byte not matching the regex\r
  93  .B [A-Za-z0-9@=.,_+-]\r
  94 -is replace by\r
  95 +with\r
  96  .B %nn\r
  97 -where nn is the two digit hex encoding.\r
  98 +where nn is the two digit hex encoding.  The message ID is a valid Xapian\r
  99 +query, quoted using Xapian boolean term quoting rules: if the ID contains\r
 100 +whitespace or a close paren or starts with a double quote, it must be\r
 101 +enclosed in double quotes and double quotes inside the ID must be doubled.\r
 102  The astute reader will notice this is a special case of the batch input\r
 103  format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
 104  mandatory for \fBnotmuch-restore\fR(1).\r
 105 diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1\r
 106 index 6bba628..78fef52 100644\r
 107 --- a/man/man1/notmuch-restore.1\r
 108 +++ b/man/man1/notmuch-restore.1\r
 109 @@ -57,10 +57,8 @@ sup calls them).\r
 110  The\r
 111  .B batch-tag\r
 112  dump format is intended to more robust against malformed message-ids\r
 113 -and tags containing whitespace or non-\fBascii\fR(7) characters.  This\r
 114 -format hex-escapes all characters those outside of a small character\r
 115 -set, intended to be suitable for e.g. pathnames in most UNIX-like\r
 116 -systems.\r
 117 +and tags containing whitespace or non-\fBascii\fR(7) characters.  See\r
 118 +\fBnotmuch-dump\fR(1) for details on this format.\r
 119  \r
 120  .B "notmuch restore"\r
 121  updates the maildir flags according to tag changes if the\r
 122 -- \r
 123 1.7.10.4\r
 124 \r