X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman1%2Fnotmuch-show.rst;h=becd3e79929023b089a9e5542c15380961aae58f;hp=b2667537c220d88905d5c486af18016064644b13;hb=6784d5bc60f850a93e6101e60b03bf6ab81020cc;hpb=aa605f7e8a4c5e046503d61fdb953721c32f9d3a diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index b2667537..becd3e79 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -71,7 +71,7 @@ Supported options for **show** include http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - **raw** (default if --part is given) + **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. @@ -105,16 +105,16 @@ Supported options for **show** include ``--verify`` Compute and report the validity of any MIME cryptographic - signatures found in the selected content (ie. "multipart/signed" + signatures found in the selected content (e.g., "multipart/signed" parts). Status of the signature will be reported (currently only - supported with --format=json and --format=sexp), and the + supported with ``--format=json`` and ``--format=sexp``), and the multipart/signed part will be replaced by the signed data. ``--decrypt=(false|auto|true|stash)`` If ``true``, decrypt any MIME encrypted parts found in the - selected content (i.e. "multipart/encrypted" parts). Status of + selected content (e.g., "multipart/encrypted" parts). Status of the decryption will be reported (currently only supported - with --format=json and --format=sexp) and on successful + with ``--format=json`` and ``--format=sexp``) and on successful decryption the multipart/encrypted part will be replaced by the decrypted content. @@ -161,12 +161,12 @@ Supported options for **show** include Default: ``auto`` ``--exclude=(true|false)`` - Specify whether to omit threads only matching search.tag\_exclude + Specify whether to omit threads only matching search.exclude\_tags from the search results (the default) or not. In either case the excluded message will be marked with the exclude flag (except when output=mbox when there is nowhere to put the flag). - If --entire-thread is specified then complete threads are returned + If ``--entire-thread`` is specified then complete threads are returned regardless (with the excluded flag being set when appropriate) but threads that only match in an excluded message are not returned when ``--exclude=true.`` @@ -176,18 +176,19 @@ Supported options for **show** include ``--body=(true|false)`` If true (the default) **notmuch show** includes the bodies of the messages in the output; if false, bodies are omitted. - ``--body=false`` is only implemented for the json and sexp formats - and it is incompatible with ``--part > 0.`` + ``--body=false`` is only implemented for the text, json and sexp + formats and it is incompatible with ``--part > 0.`` This is useful if the caller only needs the headers as body-less output is much faster and substantially smaller. ``--include-html`` - Include "text/html" parts as part of the output (currently only - supported with --format=json and --format=sexp). By default, - unless ``--part=N`` is used to select a specific part or - ``--include-html`` is used to include all "text/html" parts, no - part with content type "text/html" is included in the output. + Include "text/html" parts as part of the output (currently + only supported with ``--format=text``, ``--format=json`` and + ``--format=sexp``). By default, unless ``--part=N`` is used to + select a specific part or ``--include-html`` is used to include all + "text/html" parts, no part with content type "text/html" is included + in the output. A common use of **notmuch show** is to display a single thread of email messages. For this, use a search term of "thread:" as can be