debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 01:14:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update man page, NEWS and online help for new dump arguments.

Browse source 
We mention in all three places that using the filename argument is
deprecated.
This commit is contained in:
David Bremner 2011-10-12 18:34:43 -03:00
parent 53b397acfc
commit 8bb5b6201e
3 changed files with 33 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
NEWS
View file

@ -1,3 +1,12 @@
Notmuch 0.10 (2011-xx-xx)
notmuch dump changes
--------------------
The dump command now takes an optional search term much like notmuch
search/show/tag. The output file argument of dump is deprecated in
favour of using stdout.
Notmuch 0.9 (2011-10-01)
========================

15
notmuch.1
View file

@ -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>"

13
notmuch.c
View file

@ -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').",