X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-dump.1;h=16e72eb0fcdf3e4e83adc02339d334718d4b3dfe;hb=eb61cc78398712dc4cc8a4a3ed861ac074aa007e;hp=cb5d92eae8b7f08f3e44a95db2a50d1638e8f07c;hpb=bb390f89a1599f4767fbf7fc7cb1f01aba22b9ae;p=notmuch diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 index cb5d92ea..16e72eb0 100644 --- a/man/man1/notmuch-dump.1 +++ b/man/man1/notmuch-dump.1 @@ -1,4 +1,4 @@ -.TH NOTMUCH-DUMP 1 2013-12-07 "Notmuch 0.17~rc3" +.TH NOTMUCH-DUMP 1 2013-12-30 "Notmuch 0.17" .SH NAME notmuch-dump \- creates a plain-text dump of the tags of each message @@ -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