X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-show-1.mdwn;h=f5df8494cf8506752f05c3d7f666bc9814c5dac6;hb=0b22ed1b4e640539ae8e6f78f1ea88e54426a50d;hp=b00206630b30d6bc732c067e088438173dbf401c;hpb=aeb851d55ecf79d2e8a8c9a1a99fd73ef1a7ac06;p=obsolete%2Fnotmuch-wiki diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index b002066..f5df849 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -2,7 +2,7 @@

NAME

-       notmuch-show - Show messages matching the given search terms.
+       notmuch-show - show messages matching the given search terms

SYNOPSIS

@@ -25,33 +25,49 @@ Supported options for show include - --entire-thread + --entire-thread=(true|false) - By default only those messages that match the search terms will - be displayed. With this option, all messages in the same thread - as any matched message will be displayed. + 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. - --format=(text|json|mbox|raw) + --format=(text|json|sexp|mbox|raw) text (default for messages) - The default plain-text format has all text-content MIME - parts decoded. Various components in the output, (message, + The default plain-text format has all text-content MIME + parts decoded. Various components in the output, (message, header, body, attachment, and MIME part), will be delimited - by easily-parsed markers. Each marker consists of a Con- - trol-L character (ASCII decimal 12), the name of the - marker, and then either an opening or closing brace, ('{' - or '}'), to either open or close the component. For a mul- + by easily-parsed markers. Each marker consists of a Con- + trol-L character (ASCII decimal 12), the name of the + marker, and then either an opening or closing brace, ('{' + or '}'), to either open or close the component. For a mul- tipart MIME message, these parts will be nested. json - The output is formatted with Javascript Object Notation + The output is formatted with Javascript Object Notation (JSON). This format is more robust than the text format for - automated processing. The nested structure of multipart - MIME messages is reflected in nested JSON output. JSON out- - put always includes all messages in a matching thread; in - effect --format=json implies --entire-thread + automated processing. The nested structure of multipart + 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 setting --entire-thread=false + + sexp + + The output is formatted as an S-Expression (sexp). This + format is more robust than the text format for automated + processing. The nested structure of multipart MIME messages + 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 mbox @@ -83,29 +99,35 @@ The raw format must only be used with search terms matching single message. + --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. + --part=N Output the single decoded MIME part N of a single message. The search terms must match only a single message. Message parts are numbered in a depth-first walk of the message MIME struc- - ture, and are identified in the 'json' or 'text' output for- - mats. + ture, and are identified in the 'json', 'sexp' or 'text' output + formats. --verify Compute and report the validity of any MIME cryptographic sig- natures found in the selected content (ie. "multipart/signed" parts). Status of the signature will be reported (currently on- - ly supported with --format=json), and the multipart/signed part - will be replaced by the signed data. + ly supported with --format=json and --format=sexp), and the + multipart/signed part will be replaced by the signed data. --decrypt Decrypt any MIME encrypted parts found in the selected content (ie. "multipart/encrypted" parts). Status of the decryption - will be reported (currently only supported with --format=json) - and the multipart/encrypted part will be replaced by the de- - crypted content. Implies --verify. + will be reported (currently only supported with --format=json + and --format=sexp) and the multipart/encrypted part will be re- + placed by the decrypted content. Implies --verify. --exclude=(true|false) @@ -122,17 +144,35 @@ 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 >&gt; 0. + + This is useful if the caller only needs the headers as body- + less output is much faster and substantially smaller. + 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. +

EXIT STATUS

+
+       This command supports the following special exit status codes
+
+       20     The requested format version is too old.
+
+       21     The requested format version is too new.
+
+

SEE ALSO

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

Notmuch 0.13.2

+

Notmuch 0.15