man: clarify search --exclude documentation
authorPeter Wang <novalazy@gmail.com>
Sat, 11 May 2013 19:50:05 +0000 (20:50 +0100)
committerDavid Bremner <bremner@debian.org>
Sun, 12 May 2013 10:44:27 +0000 (07:44 -0300)
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.

man/man1/notmuch-search.1

index d3391f83339dad648a9e3bd4508e2c9a92a0c95e..59e8f3416e0d0bb55abfb1abe621c5da4273ff1b 100644 (file)
@@ -132,8 +132,19 @@ Limit the number of displayed results to N.
 .TP 4
 .BR \-\-exclude=(true|false|flag)
 
-Specify whether to omit messages matching search.tag_exclude from the
-search results (the default) or not. The extra option
+A message is called "excluded" if it matches at least one tag in
+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
 only has an effect when
 .B --output=summary