From: David Bremner Date: Thu, 23 Jan 2014 13:02:47 +0000 (+2000) Subject: [PATCH 2/2] man: update notmuch-dump man page for new default. X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=a1e499b87b1989945aacc509b0161494e7900247;p=notmuch-archives.git [PATCH 2/2] man: update notmuch-dump man page for new default. --- diff --git a/a7/f2ae5d1aeb0402a14f026f821af02433d077b4 b/a7/f2ae5d1aeb0402a14f026f821af02433d077b4 new file mode 100644 index 000000000..244601c86 --- /dev/null +++ b/a7/f2ae5d1aeb0402a14f026f821af02433d077b4 @@ -0,0 +1,131 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id A3DF4431FC2 + for ; Thu, 23 Jan 2014 05:03:05 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id bkHxfRPvD60o for ; + Thu, 23 Jan 2014 05:02:59 -0800 (PST) +Received: from yantan.tethera.net (yantan.tethera.net [199.188.72.155]) + (using TLSv1 with cipher DHE-RSA-AES128-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 7D357431FB6 + for ; Thu, 23 Jan 2014 05:02:59 -0800 (PST) +Received: from remotemail by yantan.tethera.net with local (Exim 4.80) + (envelope-from ) + id 1W6Jvv-0006gs-2O; Thu, 23 Jan 2014 09:02:59 -0400 +Received: (nullmailer pid 10643 invoked by uid 1000); Thu, 23 Jan 2014 + 13:02:55 -0000 +From: David Bremner +To: notmuch@notmuchmail.org +Subject: [PATCH 2/2] man: update notmuch-dump man page for new default. +Date: Thu, 23 Jan 2014 09:02:47 -0400 +Message-Id: <1390482167-10473-2-git-send-email-david@tethera.net> +X-Mailer: git-send-email 1.8.5.2 +In-Reply-To: <1390482167-10473-1-git-send-email-david@tethera.net> +References: + <1390482167-10473-1-git-send-email-david@tethera.net> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Thu, 23 Jan 2014 13:03:05 -0000 + +Actually the previous default was not documented explicitely. I moved +the batch-tag section first because it seemed that the formats were +previously documented in order default, other. +--- + man/man1/notmuch-dump.1 | 54 +++++++++++++++++++++++++------------------------ + 1 file changed, 28 insertions(+), 26 deletions(-) + +diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 +index 0c52d1b..16e72eb 100644 +--- a/man/man1/notmuch-dump.1 ++++ b/man/man1/notmuch-dump.1 +@@ -28,6 +28,34 @@ per line, followed by a list of tags. + + .RS 4 + .TP 4 ++.B batch-tag ++ ++The default ++.B batch-tag ++dump format is intended to more robust against malformed message-ids ++and tags containing whitespace or non-\fBascii\fR(7) characters. ++Each line has the form ++ ++.RS 4 ++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id > ++ ++Tags are hex-encoded by replacing every byte not matching the regex ++.B [A-Za-z0-9@=.,_+-] ++with ++.B %nn ++where nn is the two digit hex encoding. The message ID is a valid Xapian ++query, quoted using Xapian boolean term quoting rules: if the ID contains ++whitespace or a close paren or starts with a double quote, it must be ++enclosed in double quotes and double quotes inside the ID must be doubled. ++The astute reader will notice this is a special case of the batch input ++format for \fBnotmuch-tag\fR(1); note that the single message-id query is ++mandatory for \fBnotmuch-restore\fR(1). ++ ++.RE ++.RE ++ ++.RS 4 ++.TP 4 + .B sup + + The +@@ -53,32 +81,6 @@ that tags with spaces will not be correctly restored with this format. + .RE + + .RE +-.RS 4 +-.TP 4 +-.B batch-tag +- +-The +-.B batch-tag +-dump format is intended to more robust against malformed message-ids +-and tags containing whitespace or non-\fBascii\fR(7) characters. +-Each line has the form +- +-.RS 4 +-.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id > +- +-Tags are hex-encoded by replacing every byte not matching the regex +-.B [A-Za-z0-9@=.,_+-] +-with +-.B %nn +-where nn is the two digit hex encoding. The message ID is a valid Xapian +-query, quoted using Xapian boolean term quoting rules: if the ID contains +-whitespace or a close paren or starts with a double quote, it must be +-enclosed in double quotes and double quotes inside the ID must be doubled. +-The astute reader will notice this is a special case of the batch input +-format for \fBnotmuch-tag\fR(1); note that the single message-id query is +-mandatory for \fBnotmuch-restore\fR(1). +- +-.RE + + + With no search terms, a dump of all messages in the database will be +-- +1.8.5.2 +