debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 03:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/man/man1/notmuch-restore.1

92 lines
2.1 KiB
Groff
Raw Normal View History

version: set new version and release date These are manually set in version and NEWS, and propagate to the other files via "make update-versions"
2013-07-28 16:18:48 +02:00
.TH NOTMUCH-RESTORE 1 2013-07-28 "Notmuch 0.16"
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
.SH NAME
manpages: consistent "format" for NAME section The NAME section in manpages generally doesn't start with capital letter (unless the word is 'proper noun') and doesn't end with period. Notmuch manual pages now matches that "format".
2012-06-24 23:53:27 +02:00
notmuch-restore \- restores the tags from the given file (see notmuch dump)
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
.SH SYNOPSIS
.B "notmuch restore"
.RB [ "--accumulate" ]
notmuch-{dump,restore}.1: document new format options More or less arbitrarily, notmuch-dump.1 gets the more detailed description of the format.
2012-01-02 20:07:33 +01:00
.RB [ "--format=(auto|batch-tag|sup)" ]
notmuch-restore: replace positional argument for input with option Since notmuch dump doesn't use positional arguments anymore, it seems better to be consistent.
2012-08-04 14:55:45 +02:00
.RI "[ --input=<" filename "> ]"
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
.SH DESCRIPTION
Restores the tags from the given file (see
.BR "notmuch dump" ")."
The input is read from the given filename, if any, or from stdin.
notmuch-{dump,restore}.1: document new format options More or less arbitrarily, notmuch-dump.1 gets the more detailed description of the format.
2012-01-02 20:07:33 +01:00
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
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
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).
notmuch-{dump,restore}.1: document new format options More or less arbitrarily, notmuch-dump.1 gets the more detailed description of the format.
2012-01-02 20:07:33 +01:00
.RE
.RS 4
.TP 4
.B batch-tag
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
notmuch-{dump,restore}.1: document new format options More or less arbitrarily, notmuch-dump.1 gets the more detailed description of the format.
2012-01-02 20:07:33 +01:00
The
.B batch-tag
dump format is intended to more robust against malformed message-ids
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.
2013-01-06 21:22:42 +01:00
and tags containing whitespace or non-\fBascii\fR(7) characters. See
\fBnotmuch-dump\fR(1) for details on this format.
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
man: add references to maildir flag synchronization notmuch new, restore, and tag commands support maildir flag synchronization with notmuch tags. Reference the notmuch-config(1) man page about it in the relevant man pages.
2012-02-25 23:57:23 +01:00
.B "notmuch restore"
updates the maildir flags according to tag changes if the
.B "maildir.synchronize_flags"
configuration option is enabled. See \fBnotmuch-config\fR(1) for
details.
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
.RE
notmuch-{dump,restore}.1: document new format options More or less arbitrarily, notmuch-dump.1 gets the more detailed description of the format.
2012-01-02 20:07:33 +01:00
.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
break up dump and restore man pages. These functions are enough different in their behavior that it's not really worth it to combine them. They overlap in the format of the dump file, but we can have a separate page that describes the dump format, and either reference it or include it. This also keeps things nice and clean with one page per command.
2011-12-27 07:36:32 +01:00
.SH SEE ALSO
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
man: reference notmuch-insert.1 Add references to notmuch-insert.1 from other man pages.
2013-06-23 06:23:58 +02:00
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
man: update SEE ALSO references in man pages Drop references to notmuch-part(1). Reference all man pages. Fix man page section of notmuch-dump(1).
2012-03-11 22:36:16 +01:00
\fBnotmuch-reply\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)
Reference in a new issue Copy permalink