doc: Fix minor formatting issues in notmuch-show.rst
[notmuch] / doc / man1 / notmuch-show.rst
1 ============
2 notmuch-show
3 ============
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **show** [*option* ...] <*search-term*> ...
9
10 DESCRIPTION
11 ===========
12
13 Shows all messages matching the search terms.
14
15 See **notmuch-search-terms(7)** for details of the supported syntax for
16 <search-terms>.
17
18 The messages will be grouped and sorted based on the threading (all
19 replies to a particular message will appear immediately after that
20 message in date order). The output is not indented by default, but depth
21 tags are printed so that proper indentation can be performed by a
22 post-processor (such as the emacs interface to notmuch).
23
24 Supported options for **show** include
25
26     ``--entire-thread=(true|false)``
27         If true, **notmuch show** outputs all messages in the thread of
28         any message matching the search terms; if false, it outputs only
29         the matching messages. For ``--format=json`` and
30         ``--format=sexp`` this defaults to true. For other formats, this
31         defaults to false.
32
33     ``--format=(text|json|sexp|mbox|raw)``
34
35         **text** (default for messages)
36             The default plain-text format has all text-content MIME
37             parts decoded. Various components in the output,
38             (**message**, **header**, **body**, **attachment**, and MIME
39             **part**), will be delimited by easily-parsed markers. Each
40             marker consists of a Control-L character (ASCII decimal 12),
41             the name of the marker, and then either an opening or
42             closing brace, ('{' or '}'), to either open or close the
43             component. For a multipart MIME message, these parts will be
44             nested.
45
46         **json**
47             The output is formatted with Javascript Object Notation
48             (JSON). This format is more robust than the text format for
49             automated processing. The nested structure of multipart MIME
50             messages is reflected in nested JSON output. By default JSON
51             output includes all messages in a matching thread; that is,
52             by default,
53             ``--format=json`` sets ``--entire-thread``. The caller can
54             disable this behaviour by setting ``--entire-thread=false``.
55
56         **sexp**
57             The output is formatted as an S-Expression (sexp). This
58             format is more robust than the text format for automated
59             processing. The nested structure of multipart MIME messages
60             is reflected in nested S-Expression output. By default,
61             S-Expression output includes all messages in a matching
62             thread; that is, by default,
63             ``--format=sexp`` sets ``--entire-thread``. The caller can
64             disable this behaviour by setting ``--entire-thread=false``.
65
66         **mbox**
67             All matching messages are output in the traditional, Unix
68             mbox format with each message being prefixed by a line
69             beginning with "From " and a blank line separating each
70             message. Lines in the message content beginning with "From "
71             (preceded by zero or more '>' characters) have an additional
72             '>' character added. This reversible escaping is termed
73             "mboxrd" format and described in detail here:
74
75             http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
76
77         **raw** (default if --part is given)
78             Write the raw bytes of the given MIME part of a message to
79             standard out. For this format, it is an error to specify a
80             query that matches more than one message.
81
82             If the specified part is a leaf part, this outputs the
83             body of the part after performing content transfer
84             decoding (but no charset conversion). This is suitable for
85             saving attachments, for example.
86
87             For a multipart or message part, the output includes the
88             part headers as well as the body (including all child
89             parts). No decoding is performed because multipart and
90             message parts cannot have non-trivial content transfer
91             encoding. Consumers of this may need to implement MIME
92             decoding and similar functions.
93
94     ``--format-version=N``
95         Use the specified structured output format version. This is
96         intended for programs that invoke **notmuch(1)** internally. If
97         omitted, the latest supported version will be used.
98
99     ``--part=N``
100         Output the single decoded MIME part N of a single message. The
101         search terms must match only a single message. Message parts are
102         numbered in a depth-first walk of the message MIME structure,
103         and are identified in the 'json', 'sexp' or 'text' output
104         formats.
105
106         Note that even a message with no MIME structure or a single
107         body part still has two MIME parts: part 0 is the whole
108         message (headers and body) and part 1 is just the body.
109
110     ``--verify``
111         Compute and report the validity of any MIME cryptographic
112         signatures found in the selected content (ie. "multipart/signed"
113         parts). Status of the signature will be reported (currently only
114         supported with --format=json and --format=sexp), and the
115         multipart/signed part will be replaced by the signed data.
116
117     ``--decrypt``
118         Decrypt any MIME encrypted parts found in the selected content
119         (ie. "multipart/encrypted" parts). Status of the decryption will
120         be reported (currently only supported with --format=json and
121         --format=sexp) and on successful decryption the
122         multipart/encrypted part will be replaced by the decrypted
123         content.
124
125         Decryption expects a functioning **gpg-agent(1)** to provide any
126         needed credentials. Without one, the decryption will fail.
127
128         Implies --verify.
129
130     ``--exclude=(true|false)``
131         Specify whether to omit threads only matching
132         search.tag\_exclude from the search results (the default) or
133         not. In either case the excluded message will be marked with the
134         exclude flag (except when output=mbox when there is nowhere to
135         put the flag).
136
137         If --entire-thread is specified then complete threads are
138         returned regardless (with the excluded flag being set when
139         appropriate) but threads that only match in an excluded message
140         are not returned when ``--exclude=true.``
141
142         The default is ``--exclude=true.``
143
144     ``--body=(true|false)``
145         If true (the default) **notmuch show** includes the bodies of
146         the messages in the output; if false, bodies are omitted.
147         ``--body=false`` is only implemented for the json and sexp
148         formats and it is incompatible with ``--part > 0.``
149
150         This is useful if the caller only needs the headers as body-less
151         output is much faster and substantially smaller.
152
153     ``--include-html``
154         Include "text/html" parts as part of the output (currently only
155         supported with --format=json and --format=sexp). By default,
156         unless ``--part=N`` is used to select a specific part or
157         ``--include-html`` is used to include all "text/html" parts, no
158         part with content type "text/html" is included in the output.
159
160 A common use of **notmuch show** is to display a single thread of email
161 messages. For this, use a search term of "thread:<thread-id>" as can be
162 seen in the first column of output from the **notmuch search** command.
163
164 EXIT STATUS
165 ===========
166
167 This command supports the following special exit status codes
168
169 ``20``
170     The requested format version is too old.
171
172 ``21``
173     The requested format version is too new.
174
175 SEE ALSO
176 ========
177
178 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
179 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
180 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
181 **notmuch-search(1)**, **notmuch-search-terms(7)**, **notmuch-tag(1)**