version: update to 0.15

[notmuch] / man / man1 / notmuch-restore.1

diff --git a/man/man1/notmuch-restore.1 b/man/man1/notmuch-restore.1
index 86e23fd818820f1de4088187349c44c45639b55b..895c6d29c23d69c19793fc07fe6ecec97e0b178f 100644 (file)
--- a/man/man1/notmuch-restore.1
+++ b/man/man1/notmuch-restore.1
@@ -1,12 +1,13 @@
-.TH NOTMUCH-RESTORE 1 2012-05-25 "Notmuch 0.13.1"
+.TH NOTMUCH-RESTORE 1 2013-01-18 "Notmuch 0.15"

 .SH NAME
 .SH NAME

-notmuch-restore \- Restores the tags from the given file (see notmuch dump).
+notmuch-restore \- restores the tags from the given file (see notmuch dump)

 
 .SH SYNOPSIS
 
 .B "notmuch restore"
 .RB [ "--accumulate" ]
 
 .SH SYNOPSIS
 
 .B "notmuch restore"
 .RB [ "--accumulate" ]

-.RI "[ <" filename "> ]"
+.RB [ "--format=(auto|batch-tag|sup)" ]
+.RI "[ --input=<" filename "> ]"

 
 .SH DESCRIPTION
 
 
 .SH DESCRIPTION
 


@@ -15,19 +16,49 @@ Restores the tags from the given file (see
 
 The input is read from the given filename, if any, or from stdin.
 
 
 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).
 
 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.  See
+\fBnotmuch-dump\fR(1) for details on this format.

 
 .B "notmuch restore"
 updates the maildir flags according to tag changes if the
 
 .B "notmuch restore"
 updates the maildir flags according to tag changes if the


@@ -36,6 +67,20 @@ configuration option is enabled. See \fBnotmuch-config\fR(1) for
 details.
 
 .RE
 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),
 .SH SEE ALSO
 
 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),