X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-show-1.mdwn;fp=manpages%2Fnotmuch-show-1.mdwn;h=362c2880361adb2602a506b965a305c3f4a45cc9;hb=01b1bc7553d0b0ebf35ac3016c83240b4151ad59;hp=0000000000000000000000000000000000000000;hpb=c2a1babf958cb98d7c16b0d901d94beeec20ff10;p=obsolete%2Fnotmuch-wiki
diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn
new file mode 100644
index 0000000..362c288
--- /dev/null
+++ b/manpages/notmuch-show-1.mdwn
@@ -0,0 +1,199 @@
+NOTMUCH-SHOW(1)
+
+NAME
+
+
+ notmuch-show - Show messages matching the given search terms.
+
+
+SYNOPSIS
+
+
+ notmuch show [options...] <search-term>...
+
+
+DESCRIPTION
+
+
+ Shows all messages matching the search terms.
+
+
+
+ See notmuch-search-terms(7) for details of the supported syntax for
+ .
+
+
+
+ The messages will be grouped and sorted based on the threading (all
+ replies to a particular message will appear immediately after that mes-
+ sage in date order). The output is not indented by default, but depth
+ tags are printed so that proper indentation can be performed by a post-
+ processor (such as the emacs interface to notmuch).
+
+
+
+ Supported options for show include
+
+
+
+ --entire-thread
+
+
+
+ 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.
+
+
+
+ --format=(text|json|mbox|raw)
+
+
+
+ text (default for messages)
+
+
+
+ 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-
+ tipart MIME message, these parts will be nested.
+
+
+
+ json
+
+
+
+ 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
+
+
+
+ mbox
+
+
+
+ All matching messages are output in the traditional, Unix
+ mbox format with each message being prefixed by a line
+ beginning with "From " and a blank line separating each
+ message. Lines in the message content beginning with "From
+ " (preceded by zero or more '>' characters) have an addi-
+ tional '>' character added. This reversible escaping is
+ termed "mboxrd" format and described in detail here:
+
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+ 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.
+
+
+
+ --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.
+
+
+
+ --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.
+
+
+
+ --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.
+
+
+
+ --exclude=(true|false)
+
+
+
+ Specify whether to omit threads only matching search.tag_ex-
+ clude 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 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.
+
+
+
+ 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
+ seen in the first column of output from the notmuch search command.
+
+
+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),
+ notmuch-search(1), notmuch-search-terms(7), notmuch-tag(1)
+
+
+Notmuch 0.13.2