diff options
Diffstat (limited to 'man/man1/notmuch-dump.1')
-rw-r--r-- | man/man1/notmuch-dump.1 | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/man/man1/notmuch-dump.1 b/man/man1/notmuch-dump.1 new file mode 100644 index 00000000..9dc311f6 --- /dev/null +++ b/man/man1/notmuch-dump.1 @@ -0,0 +1,57 @@ +.TH NOTMUCH-DUMP 1 2011-12-04 "Notmuch 0.10.2" +.SH NAME +notmuch-dump \- Creates a plain-text dump of the tags of each message. + +.SH SYNOPSIS + +.B "notmuch dump" +.RI "[ <" filename "> ] [--]" +.RI "[ <" search-term ">...]" + +.B "notmuch restore" +.RB [ "--accumulate" ] +.RI "[ <" filename "> ]" + +.SH DESCRIPTION + +.TP +.BR dump " [<filename>]" + +Dump tags for messages matching the given search terms. + +Output is to the given filename, if any, or to stdout. Note that +using the filename argument is deprecated. + +These tags are the only data in the notmuch database that can't be +recreated from the messages themselves. The output of notmuch dump is +therefore the only critical thing to backup (and much more friendly to +incremental backup than the native database files.) + +With no search terms, a dump of all messages in the database will be +generated. A "--" argument instructs notmuch that the +remaining arguments are search terms. + +.TP +.BR restore " [--accumulate] [<filename>]" + +Restores the tags from the given file (see +.BR "notmuch dump" ")." + +The input is read from the given filename, if any, or from stdin. + +Note: The 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 + +See the +.B "SEARCH SYNTAX" +section below for details of the supported syntax for <search-terms>. +.RE |