diff options
| author |  David Bremner <bremner@debian.org> | 2011-10-12 18:34:43 -0300 |
|---|---|---|
| committer | David Bremner <bremner@debian.org> | 2011-10-16 20:10:03 -0300 |
| commit | 8bb5b6201ec2cb890655fee6ef7e540f401a4c7e (patch) | |
| tree | 5def9868c71856a863af76a22b5313a69e23a9fd /notmuch.1 | |
| parent | 53b397acfcd6b6372372593cc9047ee1a9599afd (diff) | |
docs: Update man page, NEWS and online help for new dump arguments.
We mention in all three places that using the filename argument is
deprecated.
Diffstat (limited to 'notmuch.1')
| -rw-r--r-- | notmuch.1 | 15 |
1 files changed, 13 insertions, 2 deletions
@@ -458,16 +458,27 @@ purposes, and to restore from that dump .RS 4 .TP 4 -.BR dump " [<filename>]" +.BR dump " [<filename>] [--] [<search-terms>]" 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 <search-terms>. +.RE + .TP .BR restore " <filename>" |