]> git.notmuchmail.org Git - notmuch/commitdiff
man: update notmuch-dump man page for new default.
authorDavid Bremner <david@tethera.net>
Thu, 23 Jan 2014 13:02:47 +0000 (09:02 -0400)
committerDavid Bremner <david@tethera.net>
Fri, 24 Jan 2014 12:52:22 +0000 (08:52 -0400)
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

index 0c52d1b762281920a6f2e8df42342f0c7365d4ae..16e72eb0fcdf3e4e83adc02339d334718d4b3dfe 100644 (file)
@@ -26,6 +26,34 @@ incremental backup than the native database files.)
 Notmuch restore supports two plain text dump formats, both with one message-id
 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
@@ -52,32 +80,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