diff options
| author |  Peter Wang <novalazy@gmail.com> | 2013-05-11 20:50:05 +0100 |
|---|---|---|
| committer |  David Bremner <bremner@debian.org> | 2013-05-12 07:44:27 -0300 |
| commit | ea0e75702d3bb4a45d271f9ba23bc8fd6c21cb86 (patch) | |
| tree | 0217241498795694b38e810c8ee2e8d08312f90c /man | |
| parent | c75dff3c1a785fb38de4940a18c8397719bbf947 (diff) | |
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.
Diffstat (limited to 'man')
| -rw-r--r-- | man/man1/notmuch-search.1 | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/man/man1/notmuch-search.1 b/man/man1/notmuch-search.1 index d3391f83..59e8f341 100644 --- a/man/man1/notmuch-search.1 +++ b/man/man1/notmuch-search.1 @@ -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 |