X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-show.1;h=506583a6c6ebccb833d84d7e3d7569e7d29a5bdf;hb=52e50f78238fe1b2ed46fabcb203b37048a3ae44;hp=ebdd189fa0980710990ddd42810ba83a7f7e1061;hpb=0c20878ccefec1e6fc472851395a7ee5a0daec4e;p=notmuch diff --git a/man/man1/notmuch-show.1 b/man/man1/notmuch-show.1 index ebdd189f..506583a6 100644 --- a/man/man1/notmuch-show.1 +++ b/man/man1/notmuch-show.1 @@ -1,6 +1,6 @@ -.TH NOTMUCH-SHOW 1 2012-02-29 "Notmuch 0.12~rc1" +.TH NOTMUCH-SHOW 1 2012-06-01 "Notmuch 0.13.2" .SH NAME -notmuch-show \- Show messages matching the given search terms. +notmuch-show \- show messages matching the given search terms .SH SYNOPSIS .B notmuch show @@ -84,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,14 +130,42 @@ 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 decrypted -content. +content. Implies --verify. +.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 .RS 4 .TP 4 -.B \-\-no-exclude +.B \-\-body=(true|false) -Do not exclude the messages matching search.exclude_tags in the config file. +If true (the default) +.B notmuch show +includes the bodies of the messages in the output; if false, +bodies are omitted. +.B --body=false +is only implemented for the json format and it is incompatible with +.B --part > 0. + +This is useful if the caller only needs the headers as body-less +output is much faster and substantially smaller. .RE A common use of