Skip to content

Commit 63c503a

Browse files
committed
notmuch.1: Document the new --entire-thread option to "notmuch show".
This was added to "notmuch help" earlier, but not to the man page. Add it there, and use consistent wording in both places.
1 parent 4d19b89 commit 63c503a

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

notmuch.1

+17-1
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@ when sorting by
169169
.B newest\-first
170170
the threads will be sorted by the newest message in each thread.
171171

172+
.RE
173+
.RS 4
172174
By default, results will be displayed in reverse chronological order,
173175
(that is, the newest results will be displayed first).
174176

@@ -177,7 +179,7 @@ See the
177179
section below for details of the supported syntax for <search-terms>.
178180
.RE
179181
.TP
180-
.BR show " <search-term>..."
182+
.BR show " [options...] <search-term>..."
181183

182184
Shows all messages matching the search terms.
183185

@@ -187,6 +189,19 @@ message in date order). The output is not indented by default, but
187189
depth tags are printed so that proper indentation can be performed by
188190
a post-processor (such as the emacs interface to notmuch).
189191

192+
Supported options for
193+
.B show
194+
include
195+
.RS 4
196+
.TP 4
197+
.B \-\-entire\-thread
198+
199+
By default only those messages that match the search terms will be
200+
displayed. With this option, all messages in the same thread as any
201+
matched message will be displayed.
202+
.RE
203+
204+
.RS 4
190205
The output format is plain-text, with all text-content MIME parts
191206
decoded. Various components in the output,
192207
.RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
@@ -207,6 +222,7 @@ See the
207222
.B "SEARCH SYNTAX"
208223
section below for details of the supported syntax for <search-terms>.
209224
.RE
225+
.RE
210226

211227
The
212228
.B reply

notmuch.c

+4-3
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,10 @@ command_t commands[] = {
181181
"\n"
182182
"\t\t--entire-thread\n"
183183
"\n"
184-
"\t\t\tBy default only messages strictly matching the\n"
185-
"\t\t\tsearch expression will be displayed. With this\n"
186-
"\t\t\toption all messages in matching threads are shown.\n"
184+
"\t\t\tBy default only those messages that match the\n"
185+
"\t\t\tsearch terms will be displayed. With this option,\n"
186+
"\t\t\tall messages in the same thread as any matched\n"
187+
"\t\t\tmessage will be displayed.\n"
187188
"\n"
188189
"\t\tThe output format is plain-text, with all text-content\n"
189190
"\t\tMIME parts decoded. Various components in the output,\n"

0 commit comments

Comments
 (0)