diff options
| author |  Austin Clements <amdragon@MIT.EDU> | 2013-01-06 15:22:42 -0500 |
|---|---|---|
| committer |  David Bremner <bremner@debian.org> | 2013-01-06 22:40:45 -0400 |
| commit | c31a91bc5c270a9f416b63bb75c95f6274fce978 (patch) | |
| tree | acd703bf32f0008030c466951d93cf53e791f98a /man | |
| parent | 425e2bc81263230df301c67d93c64ff9685ff840 (diff) | |
man: Update notmuch-dump(1) and notmuch-restore(1)
Describe the new batch-tag format. For notmuch-restore, rather than
half-heartedly duplicating the description, we now cite notmuch-dump.
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/notmuch-dump.1 | 11 | ||||
| -rw-r--r-- | 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 770b00fc..7bd6deff 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 6bba6286..78fef523 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 |