]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-search-1.mdwn
Increment the number of options
[notmuch-wiki] / manpages / notmuch-search-1.mdwn
index 5afb0f731022dcdfc7166d5bfd22a11e48c30aa0..4de091628229f4de616372191bcf0c6465b8e21e 100644 (file)
                    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.
+
                <b>tags</b>
 
                    Output all tags that appear on  any  message  matching  the
 
                Limit the number of displayed results to N.
 
-           <b>--exclude=(true|false|flag)</b>
+           <b>--exclude=(true|false|all|flag)</b>
+
+               A message is called &quot;excluded&quot; 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.
+
+               <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>flag</b> only has an effect when <b>--output=summary</b>.  The  output  is
+               almost  identical to <b>false</b>, but the &quot;match count&quot; is the number
+               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&apos;t print anything.
 
-               Specify whether to omit  messages  matching  search.tag_exclude
-               from  the search results (the default) or not. The extra option
-               <b>flag</b> only has an effect when <b>--output=summary</b> In this case  all
-               matching threads are returned but the &quot;match count&quot; is the num-
-               ber of matching non-excluded messages in the thread.
+               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>
 <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-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-tag</a>(1)
+       <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)
 </pre>
 
-<h2>Notmuch 0.15</h2>
+<h2>Notmuch 0.17</h2>