From dd6c4331a1b80cc80af052fe0aa3d2020811fa8c Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Wed, 26 Dec 2012 22:48:43 +1900 Subject: [PATCH] [PATCH v2 5/5] man: Update notmuch-dump(1) and notmuch-restore(1) --- 3e/2f9a6ec773d95dc0de4b65904555df91ac38b7 | 124 ++++++++++++++++++++++ 1 file changed, 124 insertions(+) create mode 100644 3e/2f9a6ec773d95dc0de4b65904555df91ac38b7 diff --git a/3e/2f9a6ec773d95dc0de4b65904555df91ac38b7 b/3e/2f9a6ec773d95dc0de4b65904555df91ac38b7 new file mode 100644 index 000000000..f36ba0a35 --- /dev/null +++ b/3e/2f9a6ec773d95dc0de4b65904555df91ac38b7 @@ -0,0 +1,124 @@ +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 6EECC431FB6 + for ; Tue, 25 Dec 2012 19:49:07 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] 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 SB6n4hlUr+Jp for ; + Tue, 25 Dec 2012 19:49:03 -0800 (PST) +Received: from dmz-mailsec-scanner-1.mit.edu (DMZ-MAILSEC-SCANNER-1.MIT.EDU + [18.9.25.12]) + by olra.theworths.org (Postfix) with ESMTP id 47EBF431FBD + for ; Tue, 25 Dec 2012 19:49:00 -0800 (PST) +X-AuditID: 1209190c-b7fa86d000001d37-85-50da73ab5ccc +Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) + by dmz-mailsec-scanner-1.mit.edu (Symantec Messaging Gateway) with SMTP + id 36.51.07479.BA37AD05; Tue, 25 Dec 2012 22:48:59 -0500 (EST) +Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) + by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id qBQ3muBG023722; + Tue, 25 Dec 2012 22:48:56 -0500 +Received: from drake.dyndns.org (c-76-21-105-205.hsd1.ca.comcast.net + [76.21.105.205]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qBQ3mrnW013185 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Tue, 25 Dec 2012 22:48:55 -0500 (EST) +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1Tnhz9-0002z4-1j; Tue, 25 Dec 2012 22:48:51 -0500 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH v2 5/5] man: Update notmuch-dump(1) and notmuch-restore(1) +Date: Tue, 25 Dec 2012 22:48:43 -0500 +Message-Id: <1356493723-11085-6-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: <1356493723-11085-1-git-send-email-amdragon@mit.edu> +References: <1356493723-11085-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFrrNIsWRmVeSWpSXmKPExsUixCmqrLu6+FaAwZ3vAhY3WrsZLZqmO1us + nstjcf3mTGYHFo+ds+6ye9y6/5rd49mqW8weWw69Zw5gieKySUnNySxLLdK3S+DKuHvpOEvB + TsGKKYdamBoYN/J1MXJySAiYSHTs38kOYYtJXLi3nq2LkYtDSGAfo8T2FW9ZIZwNjBLXH39j + hnAuMkn0Tr3HBOHMZZS4umAvE0g/m4CGxLb9yxlBbBEBaYmdd2ezgtjMAnkSDx9tBdshLOAl + ce/gc7A4i4CqRMelF8wgNq+Ag8SvE/eh7lCU6H42AegODg5OAUeJnQ/qQMJCQCUTH55nmsDI + v4CRYRWjbEpulW5uYmZOcWqybnFyYl5eapGuoV5uZoleakrpJkZwuEny7GB8c1DpEKMAB6MS + Dy/Hr5sBQqyJZcWVuYcYJTmYlER5txfcChDiS8pPqcxILM6ILyrNSS0+xCjBwawkwuv8Eaic + NyWxsiq1KB8mJc3BoiTOeznlpr+QQHpiSWp2ampBahFMVoaDQ0mC910R0FDBotT01Iq0zJwS + hDQTByfIcB6g4TdBaniLCxJzizPTIfKnGHU5Gl7eeMooxJKXn5cqJc57AaRIAKQoozQPbg4s + TbxiFAd6S5h3D0gVDzDFwE16BbSECWhJLN8NkCUliQgpqQZGiTBBo9V6NZcuXZMSZanT+9C+ + kaux5dC2980Llr82qrze/OX8Co9dfCbyy30franvfCe2W6/2+ONzHMvlH8Q9jo/f9G8ZV+uk + 9vyI6qX1QlmX0nme6i4VWnqF+6V71OHr34vFc45/vSK6e+vLNTaqKR5+3U1SrW8v7F/47d6h + le8/W1/WF5ZOV2Ipzkg01GIuKk4EANFpoN3uAgAA +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: Wed, 26 Dec 2012 03:49:08 -0000 + +Describe the new batch-tag format. For notmuch-restore, rather than +half-heartedly duplicating the description, we now cite notmuch-dump. +--- + man/man1/notmuch-dump.1 | 11 +++++++---- + man/man1/notmuch-restore.1 | 6 ++---- + 2 files changed, 9 insertions(+), 8 deletions(-) + +diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 +index 770b00f..7bd6def 100644 +--- a/man/man1/notmuch-dump.1 ++++ b/man/man1/notmuch-dump.1 +@@ -64,13 +64,16 @@ and tags containing whitespace or non-\fBascii\fR(7) characters. + Each line has the form + + .RS 4 +-.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" encoded-message-id > ++.RI "+<" "encoded-tag" "> " "" "+<" "encoded-tag" "> ... -- " "" " id:<" quoted-message-id > + +-where encoded means that every byte not matching the regex ++Tags are hex-encoded by replacing every byte not matching the regex + .B [A-Za-z0-9@=.,_+-] +-is replace by ++with + .B %nn +-where nn is the two digit hex encoding. ++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). +diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1 +index 6bba628..78fef52 100644 +--- a/man/man1/notmuch-restore.1 ++++ b/man/man1/notmuch-restore.1 +@@ -57,10 +57,8 @@ sup calls them). + 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. This +-format hex-escapes all characters those outside of a small character +-set, intended to be suitable for e.g. pathnames in most UNIX-like +-systems. ++and tags containing whitespace or non-\fBascii\fR(7) characters. See ++\fBnotmuch-dump\fR(1) for details on this format. + + .B "notmuch restore" + updates the maildir flags according to tag changes if the +-- +1.7.10.4 + -- 2.26.2