X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=bba479e1fc0b2de1715839484546c671b4091a59;hp=c1aa4e329c43f0e377539b6ed454b95c1555b2ea;hb=1dedfc90f6eee7cad10f1a1ceb39a7a1c4dbd1b1;hpb=2e653db38fc38dee92b2ee0564e27921132e7232 diff --git a/notmuch.1 b/notmuch.1 index c1aa4e32..bba479e1 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -454,25 +454,38 @@ section below for details of the supported syntax for . The .BR dump " and " restore commands can be used to create a textual dump of email tags for backup -purposes, and to restore from that dump +purposes, and to restore from that dump. .RS 4 .TP 4 -.BR dump " []" +.BR dump " [] [--] []" Creates a plain-text dump of the tags of each message. -The output is to the given filename, if any, or to stdout. +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. + +See the +.B "SEARCH SYNTAX" +section below for details of the supported syntax for . +.RE + .TP -.BR restore " " +.BR restore " [--accumulate] []" Restores the tags from the given file (see -.BR "notmuch dump" "." +.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. @@ -480,11 +493,15 @@ 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 The .B part -command can used to output a single part of a multi-part MIME message. +command can used to output a single part of a multipart MIME message. .RS 4 .TP 4 @@ -641,13 +658,13 @@ expression). Finally, results can be restricted to only messages within a particular time range, (based on the Date: header) with a syntax of: - .. + .. Each timestamp is a number representing the number of seconds since 1970\-01\-01 00:00:00 UTC. This is not the most convenient means of expressing date ranges, but until notmuch is fixed to accept a more convenient form, one can use the date program to construct -timestamps. For example, with the bash shell the folowing syntax would +timestamps. For example, with the bash shell the following syntax would specify a date range to return messages from 2009\-10\-01 until the current time: