man: clarify search --exclude documentation

Highlight "excluded messages" as a term with a meaning that
may not be obvious.

Be explicit about the effects of search --exclude=true and
--exclude=false.
This commit is contained in:
Peter Wang 2013-05-11 20:50:05 +01:00 committed by David Bremner
parent c75dff3c1a
commit ea0e75702d

View file

@ -132,8 +132,19 @@ Limit the number of displayed results to N.
.TP 4 .TP 4
.BR \-\-exclude=(true|false|flag) .BR \-\-exclude=(true|false|flag)
Specify whether to omit messages matching search.tag_exclude from the A message is called "excluded" if it matches at least one tag in
search results (the default) or not. The extra option search.tag_exclude that does not appear explicitly in the search terms.
This option specifies whether to omit excluded messages in the search
process.
The default value,
.BR true ,
prevents excluded messages from matching the search terms.
.B false
allows excluded messages to match search terms and appear in displayed
results. Excluded messages are still marked in the relevant outputs.
.B flag .B flag
only has an effect when only has an effect when
.B --output=summary .B --output=summary