From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id D487F429E40 for ; Sun, 6 Jan 2013 12:23:28 -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 4gEgIKSyZx0O for ; Sun, 6 Jan 2013 12:23:27 -0800 (PST) Received: from dmz-mailsec-scanner-6.mit.edu (DMZ-MAILSEC-SCANNER-6.MIT.EDU [18.7.68.35]) by olra.theworths.org (Postfix) with ESMTP id CED30431FD7 for ; Sun, 6 Jan 2013 12:23:16 -0800 (PST) X-AuditID: 12074423-b7ef96d000000725-28-50e9dd3449e5 Received: from mailhub-auth-1.mit.edu ( [18.9.21.35]) by dmz-mailsec-scanner-6.mit.edu (Symantec Messaging Gateway) with SMTP id B7.D1.01829.43DD9E05; Sun, 6 Jan 2013 15:23:16 -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 r06KNFPZ016273; Sun, 6 Jan 2013 15:23:15 -0500 Received: from drake.dyndns.org (a069.catapulsion.net [70.36.81.69]) (authenticated bits=0) (User authenticated as amdragon@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id r06KN3JX020367 (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); Sun, 6 Jan 2013 15:23:13 -0500 (EST) Received: from amthrax by drake.dyndns.org with local (Exim 4.77) (envelope-from ) id 1Trwk7-0007YM-Vw; Sun, 06 Jan 2013 15:22:51 -0500 From: Austin Clements To: notmuch@notmuchmail.org Subject: [PATCH v5 6/6] man: Update notmuch-dump(1) and notmuch-restore(1) Date: Sun, 6 Jan 2013 15:22:42 -0500 Message-Id: <1357503762-28759-7-git-send-email-amdragon@mit.edu> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1357503762-28759-1-git-send-email-amdragon@mit.edu> References: <1357503762-28759-1-git-send-email-amdragon@mit.edu> X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFnrMIsWRmVeSWpSXmKPExsUixCmqrGty92WAwd8edYsbrd2MFk3TnS1W z+WxuH5zJrPFm5XzWB1YPXbOusvucfjrQhaPW/dfs3s8W3WL2WPLoffMAaxRXDYpqTmZZalF +nYJXBl3Lx1nKdgpWDHlUAtTA+NGvi5GTg4JAROJy0u/MkLYYhIX7q1nA7GFBPYxSvxfUghh r2eU6GxS7mLkArL3M0lsXtHLCOHMZZT40/wWrINNQENi2/7lYJNEBKQldt6dzQpSxCzQxChx bdNcoCIODmEBL4nvH+xAalgEVCWOtS1gBrF5BRwk7j0/yQZxhaJE97MJYOWcAo4SH+fJQhzh IHFnx332CYz8CxgZVjHKpuRW6eYmZuYUpybrFicn5uWlFuma6eVmluilppRuYgSFH7uL8g7G PweVDjEKcDAq8fBe2PkiQIg1say4MvcQoyQHk5Io7+6LLwOE+JLyUyozEosz4otKc1KLDzFK cDArifDuOwaU401JrKxKLcqHSUlzsCiJ815LuekvJJCeWJKanZpakFoEk5Xh4FCS4JW8A9Qo WJSanlqRlplTgpBm4uAEGc4DNPzlbZDhxQWJucWZ6RD5U4y6HA0vbzxlFGLJy89LlRLnlQEZ JABSlFGaBzcHljZeMYoDvSXMawBSxQNMOXCTXgEtYQJakvr4OciSkkSElFQDY3DfETc2d+Nd wd161x2miL29cH3Td2GHIr8V1VJ+XwOWlHlHHD+2qtoqwD6ioPdWSOGZlrjuI6K3hWY8njHV uOD0aWtO7mveX2JvHr0qY1hr52z98YLl4tAvB77cDHu6TfwHT8Cpni3rzFo0H1++Khyd3Zm2 6/kNz02fvNra/uQlZTb9CM0zUmIpzkg01GIuKk4EAJt9dxP2AgAA Cc: tomi.ollila@iki.fi 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: Sun, 06 Jan 2013 20:23:29 -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