X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-show.1;h=928e03cc5d2c5be67051fbfe1d0dcc0a0641e335;hp=701186ee76b58b2a8c75cb25b4902cd4de035b7d;hb=df96c93239b6e92e19f22f7759e7d1595c3fdcdd;hpb=c48797b498ba8dc46fb323a8a7f2cde4d41d3123 diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index 701186ee..928e03cc 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -1,4 +1,4 @@ -.TH NOTMUCH-SHOW 1 2011-12-04 "Notmuch 0.10.2" +.TH NOTMUCH-SHOW 1 2012-05-25 "Notmuch 0.13.1" .SH NAME notmuch-show \- Show messages matching the given search terms. .SH SYNOPSIS @@ -10,6 +10,9 @@ notmuch-show \- Show messages matching the given search terms. Shows all messages matching the search terms. +See \fBnotmuch-search-terms\fR(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 message in date order). The output is not indented by default, but @@ -81,12 +84,17 @@ http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html .TP 4 .BR raw " (default for a single part, see \-\-part)" -For a message, 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 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. +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. @@ -125,6 +133,25 @@ multipart/encrypted part will be replaced by the decrypted content. .RE +.RS 4 +.TP 4 +.BR \-\-exclude=(true|false) + +Specify whether to omit threads only matching search.tag_exclude 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 returned +regardless (with the excluded flag being set when appropriate) but +threads that only match in an excluded message are not returned when +.B --exclude=true. + +The default is +.B --exclude=true. + +.RE + A common use of .B notmuch show is to display a single thread of email messages. For this, use a @@ -133,8 +160,10 @@ column of output from the .B notmuch search command. -See the -.B "SEARCH SYNTAX" -section below for details of the supported syntax for . -.RE -.RS 4 +.SH SEE ALSO + +\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-tag\fR(1)