initial splitting of notmuch.1
[notmuch] / man / man1 / notmuch-show.1
1 .TH NOTMUCH-SHOW 1 2011-12-04 "Notmuch 0.10.2"
2 .SH NAME
3 notmuch-show \- Show messages matching the given search terms.
4 .SH SYNOPSIS
5
6 .B notmuch show
7 .RI "[" options "...] <" search-term ">..."
8
9 .SH DESCRIPTION
10
11 Shows all messages matching the search terms.
12
13 The messages will be grouped and sorted based on the threading (all
14 replies to a particular message will appear immediately after that
15 message in date order). The output is not indented by default, but
16 depth tags are printed so that proper indentation can be performed by
17 a post-processor (such as the emacs interface to notmuch).
18
19 Supported options for
20 .B show
21 include
22 .RS 4
23 .TP 4
24 .B \-\-entire\-thread
25
26 By default only those messages that match the search terms will be
27 displayed. With this option, all messages in the same thread as any
28 matched message will be displayed.
29 .RE
30
31 .RS 4
32 .TP 4
33 .B \-\-format=(text|json|mbox|raw)
34
35 .RS 4
36 .TP 4
37 .BR text " (default for messages)"
38
39 The default plain-text format has all text-content MIME parts
40 decoded. Various components in the output,
41 .RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
42 will be delimited by easily-parsed markers. Each marker consists of a
43 Control-L character (ASCII decimal 12), the name of the marker, and
44 then either an opening or closing brace, ('{' or '}'), to either open
45 or close the component. For a multipart MIME message, these parts will
46 be nested.
47 .RE
48 .RS 4
49 .TP 4
50 .B json
51
52 The output is formatted with Javascript Object Notation (JSON). This
53 format is more robust than the text format for automated
54 processing. The nested structure of multipart MIME messages is
55 reflected in nested JSON output. JSON output always includes all
56 messages in a matching thread; in effect
57 .B \-\-format=json
58 implies
59 .B \-\-entire\-thread
60
61 .RE
62 .RS 4
63 .TP 4
64 .B mbox
65
66 All matching messages are output in the traditional, Unix mbox format
67 with each message being prefixed by a line beginning with "From " and
68 a blank line separating each message. Lines in the message content
69 beginning with "From " (preceded by zero or more '>' characters) have
70 an additional '>' character added. This reversible escaping
71 is termed "mboxrd" format and described in detail here:
72
73 .nf
74 .nh
75 http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
76 .hy
77 .fi
78 .
79 .RE
80 .RS 4
81 .TP 4
82 .BR raw " (default for a single part, see \-\-part)"
83
84 For a message, the original, raw content of the email message is
85 output. Consumers of this format should expect to implement MIME
86 decoding and similar functions.
87
88 For a single part (\-\-part) the raw part content is output after
89 performing any necessary MIME decoding.
90
91 The raw format must only be used with search terms matching single
92 message.
93 .RE
94 .RE
95
96 .RS 4
97 .TP 4
98 .B \-\-part=N
99
100 Output the single decoded MIME part N of a single message.  The search
101 terms must match only a single message.  Message parts are numbered in
102 a depth-first walk of the message MIME structure, and are identified
103 in the 'json' or 'text' output formats.
104 .RE
105
106 .RS 4
107 .TP 4
108 .B \-\-verify
109
110 Compute and report the validity of any MIME cryptographic signatures
111 found in the selected content (ie. "multipart/signed" parts). Status
112 of the signature will be reported (currently only supported with
113 --format=json), and the multipart/signed part will be replaced by the
114 signed data.
115 .RE
116
117 .RS 4
118 .TP 4
119 .B \-\-decrypt
120
121 Decrypt any MIME encrypted parts found in the selected content
122 (ie. "multipart/encrypted" parts). Status of the decryption will be
123 reported (currently only supported with --format=json) and the
124 multipart/encrypted part will be replaced by the decrypted
125 content.
126 .RE
127
128 A common use of
129 .B notmuch show
130 is to display a single thread of email messages. For this, use a
131 search term of "thread:<thread-id>" as can be seen in the first
132 column of output from the
133 .B notmuch search
134 command.
135
136 See the
137 .B "SEARCH SYNTAX"
138 section below for details of the supported syntax for <search-terms>.
139 .RE
140 .RS 4