4a/60cad463b995301af4846d06479a4de9d9a268

   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 D487F429E40\r
   6         for <notmuch@notmuchmail.org>; Sun,  6 Jan 2013 12:23:28 -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 4gEgIKSyZx0O for <notmuch@notmuchmail.org>;\r
  16         Sun,  6 Jan 2013 12:23:27 -0800 (PST)\r
  17 Received: from dmz-mailsec-scanner-6.mit.edu (DMZ-MAILSEC-SCANNER-6.MIT.EDU\r
  18         [18.7.68.35])\r
  19         by olra.theworths.org (Postfix) with ESMTP id CED30431FD7\r
  20         for <notmuch@notmuchmail.org>; Sun,  6 Jan 2013 12:23:16 -0800 (PST)\r
  21 X-AuditID: 12074423-b7ef96d000000725-28-50e9dd3449e5\r
  22 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
  23         by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP\r
  24         id B7.D1.01829.43DD9E05; Sun,  6 Jan 2013 15:23:16 -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 r06KNFPZ016273; \r
  27         Sun, 6 Jan 2013 15:23:15 -0500\r
  28 Received: from drake.dyndns.org (a069.catapulsion.net [70.36.81.69])\r
  29         (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 r06KN3JX020367\r
  32         (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
  33         Sun, 6 Jan 2013 15:23:13 -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 1Trwk7-0007YM-Vw; Sun, 06 Jan 2013 15:22:51 -0500\r
  37 From: Austin Clements <amdragon@MIT.EDU>\r
  38 To: notmuch@notmuchmail.org\r
  39 Subject: [PATCH v5 6/6] man: Update notmuch-dump(1) and notmuch-restore(1)\r
  40 Date: Sun,  6 Jan 2013 15:22:42 -0500\r
  41 Message-Id: <1357503762-28759-7-git-send-email-amdragon@mit.edu>\r
  42 X-Mailer: git-send-email 1.7.10.4\r
  43 In-Reply-To: <1357503762-28759-1-git-send-email-amdragon@mit.edu>\r
  44 References: <1357503762-28759-1-git-send-email-amdragon@mit.edu>\r
  45 X-Brightmail-Tracker:\r
  46  H4sIAAAAAAAAA+NgFnrMIsWRmVeSWpSXmKPExsUixCmqrGty92WAwd8edYsbrd2MFk3TnS1W\r
  47         z+WxuH5zJrPFm5XzWB1YPXbOusvucfjrQhaPW/dfs3s8W3WL2WPLoffMAaxRXDYpqTmZZalF\r
  48         +nYJXBl3Lx1nKdgpWDHlUAtTA+NGvi5GTg4JAROJy0u/MkLYYhIX7q1nA7GFBPYxSvxfUghh\r
  49         r2eU6GxS7mLkArL3M0lsXtHLCOHMZZT40/wWrINNQENi2/7lYJNEBKQldt6dzQpSxCzQxChx\r
  50         bdNcoCIODmEBL4nvH+xAalgEVCWOtS1gBrF5BRwk7j0/yQZxhaJE97MJYOWcAo4SH+fJQhzh\r
  51         IHFnx332CYz8CxgZVjHKpuRW6eYmZuYUpybrFicn5uWlFuma6eVmluilppRuYgSFH7uL8g7G\r
  52         PweVDjEKcDAq8fBe2PkiQIg1say4MvcQoyQHk5Io7+6LLwOE+JLyUyozEosz4otKc1KLDzFK\r
  53         cDArifDuOwaU401JrKxKLcqHSUlzsCiJ815LuekvJJCeWJKanZpakFoEk5Xh4FCS4JW8A9Qo\r
  54         WJSanlqRlplTgpBm4uAEGc4DNPzlbZDhxQWJucWZ6RD5U4y6HA0vbzxlFGLJy89LlRLnlQEZ\r
  55         JABSlFGaBzcHljZeMYoDvSXMawBSxQNMOXCTXgEtYQJakvr4OciSkkSElFQDY3DfETc2d+Nd\r
  56         wd161x2miL29cH3Td2GHIr8V1VJ+XwOWlHlHHD+2qtoqwD6ioPdWSOGZlrjuI6K3hWY8njHV\r
  57         uOD0aWtO7mveX2JvHr0qY1hr52z98YLl4tAvB77cDHu6TfwHT8Cpni3rzFo0H1++Khyd3Zm2\r
  58         6/kNz02fvNra/uQlZTb9CM0zUmIpzkg01GIuKk4EAJt9dxP2AgAA\r
  59 Cc: tomi.ollila@iki.fi\r
  60 X-BeenThere: notmuch@notmuchmail.org\r
  61 X-Mailman-Version: 2.1.13\r
  62 Precedence: list\r
  63 List-Id: "Use and development of the notmuch mail system."\r
  64         <notmuch.notmuchmail.org>\r
  65 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  66         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  67 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  68 List-Post: <mailto:notmuch@notmuchmail.org>\r
  69 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  70 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  71         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  72 X-List-Received-Date: Sun, 06 Jan 2013 20:23:29 -0000\r
  73 \r
  74 Describe the new batch-tag format.  For notmuch-restore, rather than\r
  75 half-heartedly duplicating the description, we now cite notmuch-dump.\r
  76 ---\r
  77  man/man1/notmuch-dump.1    |   11 +++++++----\r
  78  man/man1/notmuch-restore.1 |    6 ++----\r
  79  2 files changed, 9 insertions(+), 8 deletions(-)\r
  80 \r
  81 diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
  82 index 770b00f..7bd6def 100644\r
  83 --- a/man/man1/notmuch-dump.1\r
  84 +++ b/man/man1/notmuch-dump.1\r
  85 @@ -64,13 +64,16 @@ and tags containing whitespace or non-\fBascii\fR(7) characters.\r
  86  Each line has the form\r
  87  \r
  88  .RS 4\r
  89 -.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id >\r
  90 +.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
  91  \r
  92 -where encoded means that every byte not matching the regex\r
  93 +Tags are hex-encoded by replacing every byte not matching the regex\r
  94  .B [A-Za-z0-9@=.,_+-]\r
  95 -is replace by\r
  96 +with\r
  97  .B %nn\r
  98 -where nn is the two digit hex encoding.\r
  99 +where nn is the two digit hex encoding.  The message ID is a valid Xapian\r
 100 +query, quoted using Xapian boolean term quoting rules: if the ID contains\r
 101 +whitespace or a close paren or starts with a double quote, it must be\r
 102 +enclosed in double quotes and double quotes inside the ID must be doubled.\r
 103  The astute reader will notice this is a special case of the batch input\r
 104  format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
 105  mandatory for \fBnotmuch-restore\fR(1).\r
 106 diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1\r
 107 index 6bba628..78fef52 100644\r
 108 --- a/man/man1/notmuch-restore.1\r
 109 +++ b/man/man1/notmuch-restore.1\r
 110 @@ -57,10 +57,8 @@ sup calls them).\r
 111  The\r
 112  .B batch-tag\r
 113  dump format is intended to more robust against malformed message-ids\r
 114 -and tags containing whitespace or non-\fBascii\fR(7) characters.  This\r
 115 -format hex-escapes all characters those outside of a small character\r
 116 -set, intended to be suitable for e.g. pathnames in most UNIX-like\r
 117 -systems.\r
 118 +and tags containing whitespace or non-\fBascii\fR(7) characters.  See\r
 119 +\fBnotmuch-dump\fR(1) for details on this format.\r
 120  \r
 121  .B "notmuch restore"\r
 122  updates the maildir flags according to tag changes if the\r
 123 -- \r
 124 1.7.10.4\r
 125 \r