X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-show-1.mdwn;h=4a3831a6d2325e667613d9d1cdcfa859683925aa;hb=7ab49d222b1bafd16ce17aa2a8f21648fb3ac8fd;hp=6ad8953176aff572acd0ecff493bb6fd52bde9f6;hpb=ed52cd4055a160d4264b71aebe9e4276298da29e;p=notmuch-wiki diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 6ad8953..4a3831a 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -28,8 +28,8 @@ --entire-thread=(true|false) If true, notmuch show outputs all messages in the thread of any message matching the search terms; if false, it outputs only the - matching messages. For --format=json and --format=sexp this - defaults to true. For other formats, this defaults to false. + matching messages. For --format=json and --format=sexp this de‐ + faults to true. For other formats, this defaults to false. --format=(text|json|sexp|mbox|raw) @@ -48,8 +48,8 @@ for automated processing. The nested structure of multi‐ part MIME 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 + thread; that is, by default, --format=json sets --en- + tire-thread. The caller can disable this behaviour by setting --entire-thread=false. The JSON output is always encoded as UTF-8 and any message content included in the output will be charset-converted to UTF-8. @@ -88,9 +88,9 @@ decoding and similar functions. --format-version=N - Use the specified structured output format version. This is - intended for programs that invoke notmuch(1) internally. If - omitted, the latest supported version will be used. + Use the specified structured output format version. This is in‐ + tended for programs that invoke notmuch(1) internally. If omit‐ + ted, the latest supported version will be used. --part=N Output the single decoded MIME part N of a single message. The @@ -112,11 +112,11 @@ --decrypt=(false|auto|true|stash) If true, decrypt any MIME encrypted parts found in the 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 decryption - the multipart/encrypted part will be replaced by the decrypted - content. + content (e.g., "multipart/encrypted" parts). Status of the de‐ + cryption will be reported (currently only supported with --for- + mat=json and --format=sexp) and on successful decryption the + multipart/encrypted part will be replaced by the decrypted con‐ + tent. stash behaves like true, but upon successful decryption it will also stash the message's session key in the database, and index @@ -164,35 +164,36 @@ Default: auto --exclude=(true|false) - Specify whether to omit threads only matching search.tag_exclude - 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). + Specify whether to omit threads only matching search.ex‐ + clude_tags from the search results (the default) or not. In ei‐ + ther 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 regardless (with the excluded flag being set when - appropriate) but threads that only match in an excluded message - are not returned when --exclude=true. + If --entire-thread is specified then complete threads are re‐ + turned regardless (with the excluded flag being set when appro‐ + priate) but threads that only match in an excluded message are + not returned when --exclude=true. The default is --exclude=true. --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. + 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 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 "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 + A common use of notmuch show is to display a single thread of email messages. For this, use a search term of "thread:<thread-id>" as can be seen in the first column of output from the notmuch search command. @@ -208,8 +209,8 @@

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1),   notmuch-reply(1),
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
+       much-hooks(5),   notmuch-insert(1),  notmuch-new(1),  notmuch-reply(1),
        notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  not‐
        much-tag(1)
@@ -221,7 +222,7 @@

COPYRIGHT

-       2009-2018, Carl Worth and many others
+       2009-2021, Carl Worth and many others
-

0.28

+

0.32