[PATCH v4 5/5] man: Update notmuch-dump(1) and notmuch-restore(1)

diff --git a/64/98cc3a5aa639d72c9de4c35c0daeb93e2dfa68 b/64/98cc3a5aa639d72c9de4c35c0daeb93e2dfa68
new file mode 100644 (file)
index 0000000..7d54627
--- /dev/null
+++ b/64/98cc3a5aa639d72c9de4c35c0daeb93e2dfa68
@@ -0,0 +1,125 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 28AD8431FC3\r
+       for <notmuch@notmuchmail.org>; Sun, 30 Dec 2012 22:42:55 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id Gru7nVWGMBCd for <notmuch@notmuchmail.org>;\r
+       Sun, 30 Dec 2012 22:42:53 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-5.mit.edu (DMZ-MAILSEC-SCANNER-5.MIT.EDU\r
+       [18.7.68.34])\r
+       by olra.theworths.org (Postfix) with ESMTP id BBE8F431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 30 Dec 2012 22:42:52 -0800 (PST)\r
+X-AuditID: 12074422-b7f616d000000e7c-31-50e133ec8b70\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 96.D2.03708.CE331E05; Mon, 31 Dec 2012 01:42:52 -0500 (EST)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id qBV6goBA028411; \r
+       Mon, 31 Dec 2012 01:42:50 -0500\r
+Received: from drake.dyndns.org (c-76-21-105-205.hsd1.ca.comcast.net\r
+       [76.21.105.205]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qBV6glis009883\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Mon, 31 Dec 2012 01:42:49 -0500 (EST)\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1TpZ5C-0000in-9F; Mon, 31 Dec 2012 01:42:46 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v4 5/5] man: Update notmuch-dump(1) and notmuch-restore(1)\r
+Date: Mon, 31 Dec 2012 01:42:42 -0500\r
+Message-Id: <1356936162-2589-6-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.7.10.4\r
+In-Reply-To: <1356936162-2589-1-git-send-email-amdragon@mit.edu>\r
+References: <1356936162-2589-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFnrOIsWRmVeSWpSXmKPExsUixCmqrPvG+GGAwcb/vBY3WrsZLZqmO1us\r
+       nstjcf3mTGaLNyvnsTqweuycdZfd4/DXhSwet+6/Zvd4tuoWs8eWQ++ZA1ijuGxSUnMyy1KL\r
+       9O0SuDLuXjrOUrBTsGLKoRamBsaNfF2MnBwSAiYSe+7cYIawxSQu3FvP1sXIxSEksI9R4sX1\r
+       GcwQzgZGiSMPH0FlLjJJrL00E8qZyyixe/sJRpB+NgENiW37l4PZIgLSEjvvzmYFKWIWaGKU\r
+       uLZpLhtIQljAS6LrxSd2EJtFQFXiUuNzVhCbV8Be4vynBVCHKEp0P5sAVs8p4CCx89ksFhBb\r
+       CKhm997zjBMY+RcwMqxilE3JrdLNTczMKU5N1i1OTszLSy3SNdXLzSzRS00p3cQICkN2F6Ud\r
+       jD8PKh1iFOBgVOLh3fD/QYAQa2JZcWXuIUZJDiYlUV4vg4cBQnxJ+SmVGYnFGfFFpTmpxYcY\r
+       JTiYlUR432oB5XhTEiurUovyYVLSHCxK4rzXUm76CwmkJ5akZqemFqQWwWRlODiUJHitjIAa\r
+       BYtS01Mr0jJzShDSTBycIMN5gIbbgNTwFhck5hZnpkPkTzHqcjS8vPGUUYglLz8vVUqc1xik\r
+       SACkKKM0D24OLH28YhQHekuYVxKkigeYeuAmvQJawgS0RIvhAciSkkSElFQDo39+/Onb72/Z\r
+       vgk/tmXZVh/3NLb71vy2cSu/u05t1jc09Vip9dH96pnD0wVe87ek1nUvOmd8YeWqa/wa026t\r
+       iXx4+NW7mol516Q7Oi031/TGmlWw3l10U/THzAU1szv1tBin9OXadnpZSz3SlFoaH+p2+d2R\r
+       KRc9rN4INTBKzllYsS2hJbuYX4mlOCPRUIu5qDgRAEotscj6AgAA\r
+Cc: tomi.ollila@iki.fi\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 31 Dec 2012 06:42:55 -0000\r
+\r
+Describe the new batch-tag format.  For notmuch-restore, rather than\r
+half-heartedly duplicating the description, we now cite notmuch-dump.\r
+---\r
+ man/man1/notmuch-dump.1    |   11 +++++++----\r
+ man/man1/notmuch-restore.1 |    6 ++----\r
+ 2 files changed, 9 insertions(+), 8 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
+index 770b00f..7bd6def 100644\r
+--- a/man/man1/notmuch-dump.1\r
++++ b/man/man1/notmuch-dump.1\r
+@@ -64,13 +64,16 @@ and tags containing whitespace or non-\fBascii\fR(7) characters.\r
+ Each line has the form\r
+ \r
+ .RS 4\r
+-.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id >\r
++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
+ \r
+-where encoded means that every byte not matching the regex\r
++Tags are hex-encoded by replacing every byte not matching the regex\r
+ .B [A-Za-z0-9@=.,_+-]\r
+-is replace by\r
++with\r
+ .B %nn\r
+-where nn is the two digit hex encoding.\r
++where nn is the two digit hex encoding.  The message ID is a valid Xapian\r
++query, quoted using Xapian boolean term quoting rules: if the ID contains\r
++whitespace or a close paren or starts with a double quote, it must be\r
++enclosed in double quotes and double quotes inside the ID must be doubled.\r
+ The astute reader will notice this is a special case of the batch input\r
+ format for \fBnotmuch-tag\fR(1); note that the single message-id query is\r
+ mandatory for \fBnotmuch-restore\fR(1).\r
+diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1\r
+index 6bba628..78fef52 100644\r
+--- a/man/man1/notmuch-restore.1\r
++++ b/man/man1/notmuch-restore.1\r
+@@ -57,10 +57,8 @@ sup calls them).\r
+ The\r
+ .B batch-tag\r
+ dump format is intended to more robust against malformed message-ids\r
+-and tags containing whitespace or non-\fBascii\fR(7) characters.  This\r
+-format hex-escapes all characters those outside of a small character\r
+-set, intended to be suitable for e.g. pathnames in most UNIX-like\r
+-systems.\r
++and tags containing whitespace or non-\fBascii\fR(7) characters.  See\r
++\fBnotmuch-dump\fR(1) for details on this format.\r
+ \r
+ .B "notmuch restore"\r
+ updates the maildir flags according to tag changes if the\r
+-- \r
+1.7.10.4\r
+\r