X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=notmuch.1;h=4f864a8983f1faf0a62863c8a98909ceac3f8f32;hb=941cb03e5774cb8af6925c29c25d1e94c9457ec6;hp=5a8c83dc6b534ba58889708897cbbe23353adba7;hpb=68a2c7a8b0f749cb33a8ce7cfa2aa7781d2529bb;p=notmuch diff --git a/notmuch.1 b/notmuch.1 index 5a8c83dc..4f864a89 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 " " 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.