aboutsummaryrefslogtreecommitdiffhomepage
path: root/notmuch.c
diff options
context:
space:
mode:
authorGravatar David Bremner <bremner@debian.org>2011-10-12 18:34:43 -0300
committerGravatar David Bremner <bremner@debian.org>2011-10-16 20:10:03 -0300
commit8bb5b6201ec2cb890655fee6ef7e540f401a4c7e (patch)
tree5def9868c71856a863af76a22b5313a69e23a9fd /notmuch.c
parent53b397acfcd6b6372372593cc9047ee1a9599afd (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.c')
-rw-r--r--notmuch.c13
1 files changed, 11 insertions, 2 deletions
diff --git a/notmuch.c b/notmuch.c
index f9d66297..640ad8da 100644
--- a/notmuch.c
+++ b/notmuch.c
@@ -375,14 +375,23 @@ static command_t commands[] = {
"\tSee \"notmuch help search-terms\" for details of the search\n"
"\tterms syntax." },
{ "dump", notmuch_dump_command,
- "[<filename>]",
+ "[<filename>] [--] [<search-terms>]",
"Create a plain-text dump of the tags for each message.",
"\tOutput is to the given filename, if any, or to stdout.\n"
+ "\tNote that using the filename argument is deprecated.\n"
+ "\n"
"\tThese tags are the only data in the notmuch database\n"
"\tthat can't be recreated from the messages themselves.\n"
"\tThe output of notmuch dump is therefore the only\n"
"\tcritical thing to backup (and much more friendly to\n"
- "\tincremental backup than the native database files.)" },
+ "\tincremental backup than the native database files.)\n"
+ "\n"
+ "\tWith no search terms, a dump of all messages in the\n"
+ "\tdatabase will be generated. A \"--\" argument instructs\n"
+ "\tnotmuch that the remaining arguments are search terms.\n"
+ "\n"
+ "\tSee \"notmuch help search-terms\" for the search-term syntax.\n"
+ },
{ "restore", notmuch_restore_command,
"<filename>",
"Restore the tags from the given dump file (see 'dump').",