X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-dump.1;h=3fa51bdd69ec360afa4339ff2353de3e91e7c170;hb=bcccc2e1fe19003e28b6cd85d3f2b2beda40335f;hp=770b00fcde6e2d0970e954553008fdf01d0e402f;hpb=60cd3b9a0623a1cb71a1a1eb440accf9236a41e7;p=obsolete%2Fnotmuch-old

diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1
index 770b00fc..3fa51bdd 100644
--- a/man/man1/notmuch-dump.1
+++ b/man/man1/notmuch-dump.1
@@ -1,4 +1,4 @@
-.TH NOTMUCH-DUMP 1 2012-08-20 "Notmuch 0.14"
+.TH NOTMUCH-DUMP 1 2013-02-17 "Notmuch 0.15.2"
 .SH NAME
 notmuch-dump \- creates a plain-text dump of the tags of each message
 
@@ -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).