<h2>DESCRIPTION</h2>
<pre>
- Search for messages matching the given search terms, and display as
- results the threads containing the matched messages.
+ Search for messages matching the given search terms, and display as re‐
+ sults the threads containing the matched messages.
The output consists of one line per thread, giving a thread ID, the
date of the newest (or oldest, depending on the sort option) matched
Supported options for <b>search</b> include
- <b>--format=</b>(<b>json</b>|<b>sexp</b>|<b>text</b>|<b>text0</b>)
+ <b>--format=(json|sexp|text|text0)</b>
Presents the results in either JSON, S-Expressions, newline
character separated plain-text (default), or null character sep‐
arated plain-text (compatible with <b>xargs</b>(1) -0 option where
available).
<b>--format-version=N</b>
- Use the specified structured output format version. This is
- intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
- omitted, the latest supported version will be used.
+ Use the specified structured output format version. This is in‐
+ tended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If omit‐
+ ted, the latest supported version will be used.
<b>--output=(summary|threads|messages|files|tags)</b>
ber matched and the total number), the authors of the
thread and the subject. In the case where a thread con‐
tains multiple files for some messages, the total number
- of files is printed in parentheses (see below for an
- example).
+ of files is printed in parentheses (see below for an ex‐
+ ample).
<b>threads</b>
Output the thread IDs of all threads with any message
- matching the search terms, either one per line (--for‐
- mat=text), separated by null characters (--format=text0),
- as a JSON array (--format=json), or an S-Expression list
- (--format=sexp).
+ matching the search terms, either one per line (<b>--for-</b>
+ <b>mat=text</b>), separated by null characters (<b>--format=text0</b>),
+ as a JSON array (<b>--format=json</b>), or an S-Expression list
+ (<b>--format=sexp</b>).
<b>messages</b>
Output the message IDs of all messages matching the
- search terms, either one per line (--format=text), sepa‐
- rated by null characters (--format=text0), as a JSON
- array (--format=json), or as an S-Expression list (--for‐
- mat=sexp).
+ search terms, either one per line (<b>--format=text</b>), sepa‐
+ rated by null characters (<b>--format=text0</b>), as a JSON ar‐
+ ray (<b>--format=json</b>), or as an S-Expression list (<b>--for-</b>
+ <b>mat=sexp</b>).
<b>files</b> Output the filenames of all messages matching the search
- terms, either one per line (--format=text), separated by
- null characters (--format=text0), as a JSON array (--for‐
- mat=json), or as an S-Expression list (--format=sexp).
+ terms, either one per line (<b>--format=text</b>), separated by
+ null characters (<b>--format=text0</b>), as a JSON array (<b>--for-</b>
+ <b>mat=json</b>), or as an S-Expression list (<b>--format=sexp</b>).
Note that each message may have multiple filenames asso‐
ciated with it. All of them are included in the output
- (unless limited with the --duplicate=N option). This may
+ (unless limited with the <b>--duplicate=N</b> option). This may
be particularly confusing for <b>folder:</b> or <b>path:</b> searches
in a specified directory, as the messages may have dupli‐
cates in other directories that are included in the out‐
search.
<b>tags</b> Output all tags that appear on any message matching the
- search terms, either one per line (--format=text), sepa‐
- rated by null characters (--format=text0), as a JSON
- array (--format=json), or as an S-Expression list (--for‐
- mat=sexp).
+ search terms, either one per line (<b>--format=text</b>), sepa‐
+ rated by null characters (<b>--format=text0</b>), as a JSON ar‐
+ ray (<b>--format=json</b>), or as an S-Expression list (<b>--for-</b>
+ <b>mat=sexp</b>).
- <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
+ <b>--sort=(newest-first|oldest-first)</b>
This option can be used to present results in either chronologi‐
cal order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
<b>est-first</b>).
- Note: The thread order will be distinct between these two
- options (beyond being simply reversed). When sorting by <b>old-</b>
+ Note: The thread order will be distinct between these two op‐
+ tions (beyond being simply reversed). When sorting by <b>old-</b>
<b>est-first</b> the threads will be sorted by the oldest message in
each thread, but when sorting by <b>newest-first</b> the threads will
be sorted by the newest message in each thread.
<b>--exclude=(true|false|all|flag)</b>
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.
+ search.exclude_tags that does not appear explicitly in the
+ search terms. This option specifies whether to omit excluded
+ messages in the search process.
- <b>true</b> (default)
+ <b>true</b> <b>(default)</b>
Prevent excluded messages from matching the search terms.
<b>all</b> Additionally prevent excluded messages from appearing in
- displayed results, in effect behaving as though the
- excluded messages do not exist.
+ displayed results, in effect behaving as though the ex‐
+ cluded messages do not exist.
<b>false</b> Allow excluded messages to match search terms and appear
in displayed results. Excluded messages are still marked
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not‐</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
- <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
- <a href='../notmuch-tag-1/'>much-tag</a>(1) <a href='../notmuch-address-1/'>notmuch-address</a>(1)
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-address-1/'>notmuch-address</a>(1) <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1),
+ <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),
+ <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>not‐</a>
+ <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
<h2>COPYRIGHT</h2>
<pre>
- 2009-2018, Carl Worth and many others
+ 2009-2022, Carl Worth and many others
</pre>
-<h2>0.27</h2>
+<h2>0.35</h2>
projects / notmuch-wiki / blobdiff