aboutsummaryrefslogtreecommitdiffhomepage
path: root/notmuch.c
diff options
context:
space:
mode:
authorGravatar Carl Worth <cworth@cworth.org>2011-05-24 11:21:08 -0700
committerGravatar Carl Worth <cworth@cworth.org>2011-05-24 12:19:18 -0700
commita06889c8d48eff3f3fc76b5cbacc60ce46bd65da (patch)
treee28d439e28e6b2b8e355a9a8ec0969c9de3a3ce5 /notmuch.c
parenta01956924eb5b7fd4077b1c6678cbc53faa99d43 (diff)
notmuch show: Update documentation for default --format=raw for --part
We recently made the --part option to "notmuch show" trigger a default format of "raw", (since the previous default of "text" is not often useful with a single part---especially a non-text part). Here, we update the documentation to match.
Diffstat (limited to 'notmuch.c')
-rw-r--r--notmuch.c17
1 files changed, 11 insertions, 6 deletions
diff --git a/notmuch.c b/notmuch.c
index dc21096c..9bb88471 100644
--- a/notmuch.c
+++ b/notmuch.c
@@ -241,7 +241,7 @@ static command_t commands[] = {
"\n"
"\t--format=(text|json|mbox|raw)\n"
"\n"
- "\t\ttext (default)\n"
+ "\t\ttext (default for messages)\n"
"\n"
"\t\tThe default plain-text format has all text-content MIME parts\n"
"\t\tdecoded. Various components in the output, ('message', 'header',\n"
@@ -273,12 +273,17 @@ static command_t commands[] = {
"\n"
"\t\thttp://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\n"
"\n"
- "\t\traw\n"
+ "\t\traw (default for a single part, see --part)\n"
"\n"
- "\t\tThe original, raw content of the email message is displayed.\n"
- "\t\tConsumers of this format should expect to implement MIME\n"
- "\t\tdecoding and similar functions. This format must only\n"
- "\t\tbe used with search terms matching a single message.\n"
+ "\t\tFor a message, the original, raw content of the email\n"
+ "\t\tmessage is output. Consumers of this format should\n"
+ "\t\texpect to implement MIME decoding and similar functions.\n"
+ "\n"
+ "\t\tFor a single part (--part) the raw part content is output\n"
+ "\t\tafter performing any necessary MIME decoding.\n"
+ "\n"
+ "\t\tThe raw format must only be used with search terms matching\n"
+ "\t\tsingle message.\n"
"\n"
"\t--part=N\n"
"\n"