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

notmuch show: Update documentation for default --format=raw for --part

Browse source 
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.
This commit is contained in:
Carl Worth 2011-05-24 11:21:08 -07:00
parent a01956924e
commit a06889c8d4
2 changed files with 22 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
notmuch.1
View file

@ -252,7 +252,7 @@ matched message will be displayed.
.RS 4
.TP 4
.B text
.BR text " (default for messages)"
The default plain-text format has all text-content MIME parts
decoded. Various components in the output,
@ -291,12 +291,17 @@ http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
.RE
.RS 4
.TP 4
.B raw
.BR raw " (default for a single part, see \-\-part)"
The original, raw content of the email message is displayed.
Consumers of this format should expect to implement MIME decoding and
similar functions. This format must only be used with search terms
matching a single message.
For a message, the original, raw content of the email message is
output. Consumers of this format should expect to implement MIME
decoding and similar functions.
For a single part (\-\-part) the raw part content is output after
performing any necessary MIME decoding.
The raw format must only be used with search terms matching single
message.
.RE
.RE

17
notmuch.c
View file

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