X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-show.rst;h=14d598ab4805614d3c033eb042505b5c4f020d9b;hp=bad868beab892504286ea2e63b6de356f5e26cbd;hb=3cd00fdb8f24942c8d1f64b31241973bd659e423;hpb=d736260385a689b5c77d8121f48e29440e3adfa4 diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index bad868be..14d598ab 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -50,9 +50,8 @@ Supported options for **show** include messages is reflected in nested JSON output. By default JSON output includes all messages in a matching thread; that is, by default, - - ``--format=json`` sets ``--entire-thread`` The caller can - disable this behaviour by setting ``--entire-thread=false`` + ``--format=json`` sets ``--entire-thread``. The caller can + disable this behaviour by setting ``--entire-thread=false``. **sexp** The output is formatted as an S-Expression (sexp). This @@ -61,9 +60,8 @@ Supported options for **show** include is reflected in nested S-Expression output. By default, S-Expression output includes all messages in a matching thread; that is, by default, - - ``--format=sexp`` sets ``--entire-thread`` The caller can - disable this behaviour by setting ``--entire-thread=false`` + ``--format=sexp`` sets ``--entire-thread``. The caller can + disable this behaviour by setting ``--entire-thread=false``. **mbox** All matching messages are output in the traditional, Unix @@ -76,22 +74,22 @@ Supported options for **show** include http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - **raw** (default for a single part, see --part) - For a message or an attached message part, the original, raw - content of the email message is output. Consumers of this - format should expect to implement MIME decoding and similar - functions. + **raw** (default if --part is given) + Write the raw bytes of the given MIME part of a message to + standard out. For this format, it is an error to specify a + query that matches more than one message. - For a single part (--part) the raw part content is output - after performing any necessary MIME decoding. Note that - messages with a simple body still have two parts: part 0 is - the whole message and part 1 is the body. + If the specified part is a leaf part, this outputs the + body of the part after performing content transfer + decoding (but no charset conversion). This is suitable for + saving attachments, for example. - For a multipart part, the part headers and body (including - all child parts) is output. - - The raw format must only be used with search terms matching - single message. + For a multipart or message part, the output includes the + part headers as well as the body (including all child + parts). No decoding is performed because multipart and + message parts cannot have non-trivial content transfer + encoding. Consumers of this may need to implement MIME + decoding and similar functions. ``--format-version=N`` Use the specified structured output format version. This is @@ -105,6 +103,10 @@ Supported options for **show** include and are identified in the 'json', 'sexp' or 'text' output formats. + Note that even a message with no MIME structure or a single + body part still has two MIME parts: part 0 is the whole + message (headers and body) and part 1 is just the body. + ``--verify`` Compute and report the validity of any MIME cryptographic signatures found in the selected content (ie. "multipart/signed"