[PATCH 2/2] man: update notmuch-dump man page for new default.
authorDavid Bremner <david@tethera.net>
Thu, 23 Jan 2014 13:02:47 +0000 (09:02 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:59:14 +0000 (09:59 -0800)
a7/f2ae5d1aeb0402a14f026f821af02433d077b4 [new file with mode: 0644]

diff --git a/a7/f2ae5d1aeb0402a14f026f821af02433d077b4 b/a7/f2ae5d1aeb0402a14f026f821af02433d077b4
new file mode 100644 (file)
index 0000000..244601c
--- /dev/null
@@ -0,0 +1,131 @@
+Return-Path: <bremner@tethera.net>\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 A3DF4431FC2\r
+       for <notmuch@notmuchmail.org>; Thu, 23 Jan 2014 05:03:05 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       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 bkHxfRPvD60o for <notmuch@notmuchmail.org>;\r
+       Thu, 23 Jan 2014 05:02:59 -0800 (PST)\r
+Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155])\r
+       (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 7D357431FB6\r
+       for <notmuch@notmuchmail.org>; Thu, 23 Jan 2014 05:02:59 -0800 (PST)\r
+Received: from remotemail by yantan.tethera.net with local (Exim 4.80)\r
+       (envelope-from <bremner@tethera.net>)\r
+       id 1W6Jvv-0006gs-2O; Thu, 23 Jan 2014 09:02:59 -0400\r
+Received: (nullmailer pid 10643 invoked by uid 1000); Thu, 23 Jan 2014\r
+       13:02:55 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 2/2] man: update notmuch-dump man page for new default.\r
+Date: Thu, 23 Jan 2014 09:02:47 -0400\r
+Message-Id: <1390482167-10473-2-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 1.8.5.2\r
+In-Reply-To: <1390482167-10473-1-git-send-email-david@tethera.net>\r
+References: <m24n4xo2r0.fsf@guru.guru-group.fi>\r
+       <1390482167-10473-1-git-send-email-david@tethera.net>\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: Thu, 23 Jan 2014 13:03:05 -0000\r
+\r
+Actually the previous default was not documented explicitely.  I moved\r
+the batch-tag section first because it seemed that the formats were\r
+previously documented in order default, other.\r
+---\r
+ man/man1/notmuch-dump.1 | 54 +++++++++++++++++++++++++------------------------\r
+ 1 file changed, 28 insertions(+), 26 deletions(-)\r
+\r
+diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1\r
+index 0c52d1b..16e72eb 100644\r
+--- a/man/man1/notmuch-dump.1\r
++++ b/man/man1/notmuch-dump.1\r
+@@ -28,6 +28,34 @@ per line, followed by a list of tags.\r
\r
+ .RS 4\r
+ .TP 4\r
++.B batch-tag\r
++\r
++The default\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.\r
++Each line has the form\r
++\r
++.RS 4\r
++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
++\r
++Tags are hex-encoded by replacing every byte not matching the regex\r
++.B [A-Za-z0-9@=.,_+-]\r
++with\r
++.B %nn\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
++\r
++.RE\r
++.RE\r
++\r
++.RS 4\r
++.TP 4\r
+ .B sup\r
\r
+ The\r
+@@ -53,32 +81,6 @@ that tags with spaces will not be correctly restored with this format.\r
+ .RE\r
\r
+ .RE\r
+-.RS 4\r
+-.TP 4\r
+-.B batch-tag\r
+-\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.\r
+-Each line has the form\r
+-\r
+-.RS 4\r
+-.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id >\r
+-\r
+-Tags are hex-encoded by replacing every byte not matching the regex\r
+-.B [A-Za-z0-9@=.,_+-]\r
+-with\r
+-.B %nn\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
+-\r
+-.RE\r
\r
\r
+ With no search terms, a dump of all messages in the database will be\r
+-- \r
+1.8.5.2\r
+\r