diff options
Diffstat (limited to 'man/man1/notmuch-restore.1')
| -rw-r--r-- | man/man1/notmuch-restore.1 | 59 |
1 files changed, 53 insertions, 6 deletions
diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1 index 2fa87337..6bba6286 100644 --- a/man/man1/notmuch-restore.1 +++ b/man/man1/notmuch-restore.1 @@ -6,6 +6,7 @@ notmuch-restore \- restores the tags from the given file (see notmuch dump) .B "notmuch restore" .RB [ "--accumulate" ] +.RB [ "--format=(auto|batch-tag|sup)" ] .RI "[ --input=<" filename "> ]" .SH DESCRIPTION @@ -15,19 +16,51 @@ Restores the tags from the given file (see The input is read from the given filename, if any, or from stdin. -Note: The dump file format is specifically chosen to be + +Supported options for +.B restore +include +.RS 4 +.TP 4 +.B \-\-accumulate + +The union of the existing and new tags is applied, instead of +replacing each message's tags as they are read in from the dump file. + +.RE +.RS 4 +.TP 4 +.B \-\-format=(sup|batch-tag|auto) + +Notmuch restore supports two plain text dump formats, with each line +specifying a message-id and a set of tags. +For details of the actual formats, see \fBnotmuch-dump\fR(1). + +.RS 4 +.TP 4 +.B sup + +The +.B sup +dump file format is specifically chosen to be compatible with the format of files produced by sup-dump. So if you've previously been using sup for mail, then the .B "notmuch restore" command provides you a way to import all of your tags (or labels as sup calls them). -The --accumulate switch causes the union of the existing and new tags to be -applied, instead of replacing each message's tags as they are read in from the -dump file. +.RE +.RS 4 +.TP 4 +.B batch-tag -See \fBnotmuch-search-terms\fR(7) -for details of the supported syntax for <search-terms>. +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. .B "notmuch restore" updates the maildir flags according to tag changes if the @@ -36,6 +69,20 @@ configuration option is enabled. See \fBnotmuch-config\fR(1) for details. .RE + +.RS 4 +.TP 4 +.B auto + +This option (the default) tries to guess the format from the +input. For correctly formed input in either supported format, this +heuristic, based the fact that batch-tag format contains no parentheses, +should be accurate. + +.RE + +.RE + .SH SEE ALSO \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), |