From: Austin Clements <amdragon@MIT.EDU>
To: notmuch@notmuchmail.org
Cc: tomi.ollila@iki.fi
Subject: [PATCH v5 6/6] man: Update notmuch-dump(1) and notmuch-restore(1)
Date: Sun, 6 Jan 2013 15:22:42 -0500 [thread overview]
Message-ID: <1357503762-28759-7-git-send-email-amdragon@mit.edu> (raw)
In-Reply-To: <1357503762-28759-1-git-send-email-amdragon@mit.edu>
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
next prev parent reply other threads:[~2013-01-06 20:23 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-01-06 20:22 [PATCH v5 0/6] Use Xapian query syntax for batch-tag dump/restore Austin Clements
2013-01-06 20:22 ` [PATCH v5 1/6] restore: Make missing messages non-fatal (again) Austin Clements
2013-01-06 20:22 ` [PATCH v5 2/6] util: Factor out boolean term quoting routine Austin Clements
2013-01-06 20:22 ` [PATCH v5 3/6] util: Function to parse boolean term queries Austin Clements
2013-01-06 20:22 ` [PATCH v5 4/6] dump: Disallow \n in message IDs Austin Clements
2013-01-06 20:22 ` [PATCH v5 5/6] dump/restore: Use Xapian queries for batch-tag format Austin Clements
2013-01-06 20:22 ` Austin Clements [this message]
2013-01-06 22:01 ` [PATCH v5 0/6] Use Xapian query syntax for batch-tag dump/restore Jani Nikula
2013-01-06 22:05 ` Mark Walters
2013-01-07 2:52 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1357503762-28759-7-git-send-email-amdragon@mit.edu \
--to=amdragon@mit.edu \
--cc=notmuch@notmuchmail.org \
--cc=tomi.ollila@iki.fi \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).