diff options
author | Carl Worth <cworth@cworth.org> | 2011-05-24 11:21:08 -0700 |
---|---|---|
committer | Carl Worth <cworth@cworth.org> | 2011-05-24 12:19:18 -0700 |
commit | a06889c8d48eff3f3fc76b5cbacc60ce46bd65da (patch) | |
tree | e28d439e28e6b2b8e355a9a8ec0969c9de3a3ce5 /notmuch.1 | |
parent | a01956924eb5b7fd4077b1c6678cbc53faa99d43 (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.1')
-rw-r--r-- | notmuch.1 | 17 |
1 files changed, 11 insertions, 6 deletions
@@ -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 |