<h2>SYNOPSIS</h2>
<pre>
- <b>notmuch</b> <b>search</b> [<u>options</u>...] <<u>search-term</u>>...
+ <b>notmuch</b> <b>search</b> [<u>option</u> ...] <<u>search-term</u>> ...
</pre>
<h2>DESCRIPTION</h2>
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
- separated plain-text (compatible with <b>xargs</b>(1) -0 option where
- available).
+ Presents the results in either JSON, S-Expressions, newline
+ character separated plain-text (default), or null character
+ separated 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
+ intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
+ omitted, the latest supported version will be used.
- <b>--output=(summary|threads|messages|files|tags)</b>
+ --output=(summary|threads|messages|files|tags)
- <b>summary</b>
+ <b>summary</b>
- Output a summary of each thread with any message matching
- the search terms. The summary includes the thread ID, date,
- the number of messages in the thread (both the number
- matched and the total number), the authors of the thread
- and the subject.
+ Output a summary of each thread with any message matching
+ the search terms. The summary includes the thread ID,
+ date, the number of messages in the thread (both the num-
+ ber matched and the total number), the authors of the
+ thread and the subject.
- <b>threads</b>
+ <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).
+ 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).
- <b>messages</b>
+ <b>messages</b>
- Output the message IDs 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).
+ 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).
- <b>files</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).
+ 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).
- Note that each message may have multiple filenames associ-
- ated with it. All of them are included in the output,
- unless limited with the --duplicate=N option.
+ 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
+ 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-
+ put, although these files alone would not match the
+ search.
- <b>tags</b>
+ <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).
+ 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).
- <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 chronolog-
- ical order (<b>oldest-first</b>) or reverse chronological order
- (<b>newest-first</b>).
+ This option can be used to present results in either chrono-
+ logical order (<b>oldest-first</b>) or reverse chronological order
+ (<b>newest-first</b>).
- Note: The thread order will be distinct between these two
- options (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.
+ Note: The thread order will be distinct between these two
+ options (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.
- By default, results will be displayed in reverse chronological
- order, (that is, the newest results will be displayed first).
+ By default, results will be displayed in reverse chronologi-
+ cal order, (that is, the newest results will be displayed
+ first).
<b>--offset=[-]N</b>
- Skip displaying the first N results. With the leading '-',
- start at the Nth result from the end.
+ Skip displaying the first N results. With the leading '-',
+ start at the Nth result from the end.
<b>--limit=N</b>
- Limit the number of displayed results to N.
+ Limit the number of displayed results to N.
<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.
+ 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, <b>true</b>, prevents excluded messages from match-
- ing the search terms.
+ The default value, <b>true</b>, prevents excluded messages from
+ matching the search terms.
- <b>all</b> additionally prevents excluded messages from appearing in
- displayed results, in effect behaving as though the excluded
- messages do not exist.
+ <b>all</b> additionally prevents excluded messages from appearing
+ in displayed results, in effect behaving as though the
+ excluded messages do not exist.
- <b>false</b> allows excluded messages to match search terms and appear
- in displayed results. Excluded messages are still marked in the
- relevant outputs.
+ <b>false</b> allows excluded messages to match search terms and
+ appear in displayed results. Excluded messages are still
+ marked in the relevant outputs.
- <b>flag</b> only has an effect when <b>--output=summary</b>. The output is
- almost identical to <b>false</b>, but the "match count" is the number
- of matching non-excluded messages in the thread, rather than
- the number of matching messages.
+ <b>flag</b> only has an effect when --output=summary. The output is
+ almost identical to <b>false</b>, but the "match count" is the num-
+ ber of matching non-excluded messages in the thread, rather
+ than the number of matching messages.
<b>--duplicate=N</b>
- Effective with <b>--output=files</b>, output the Nth filename associ-
- ated with each message matching the query (N is 1-based). If N
- is greater than the number of files associated with the mes-
- sage, don't print anything.
+ Effective with --output=files, output the Nth filename asso-
+ ciated with each message matching the query (N is 1-based).
+ If N is greater than the number of files associated with the
+ message, don't print anything.
- Note that this option is orthogonal with the <b>folder:</b> search
- prefix. The prefix matches messages based on filenames. This
- option filters filenames of the matching messages.
+ Note that this option is orthogonal with the <b>folder:</b> search
+ prefix. The prefix matches messages based on filenames. This
+ option filters filenames of the matching messages.
</pre>
<h2>EXIT STATUS</h2>
<pre>
This command supports the following special exit status codes
- <b>20</b> The requested format version is too old.
+ <b>20</b>
- <b>21</b> The requested format version is too new.
+ The requested format version is too old.
+
+ <b>21</b>
+
+ The requested format version is too new.
</pre>
<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/'>notmuch-</a>
- <a href='../notmuch-tag-1/'>tag</a>(1)
+ <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)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+ Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+ 2014, Carl Worth and many others
</pre>
-<h2>Notmuch 0.17</h2>
+<h2>0.18</h2>
projects / notmuch-wiki / blobdiff