git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-search-1.mdwn

   1 <h1>NOTMUCH-SEARCH(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-search - search for messages matching the given search terms
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>search</b> [<u>option</u> ...] &lt;<u>search-term</u>&gt; ...
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        Search  for  messages  matching  the given search terms, and display as
  16        results the threads containing the matched messages.
  17
  18        The output consists of one line per thread, giving  a  thread  ID,  the
  19        date  of  the  newest (or oldest, depending on the sort option) matched
  20        message in the thread, the number of matched messages  and  total  mes‐
  21        sages  in  the thread, the names of all participants in the thread, and
  22        the subject of the newest (or oldest) message.
  23
  24        See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of  the  supported  syntax  for
  25        &lt;search-terms&gt;.
  26
  27        Supported options for <b>search</b> include
  28
  29           <b>--format=(json|sexp|text|text0)</b>
  30                  Presents  the  results in either JSON, S-Expressions, newline
  31                  character separated plain-text (default), or  null  character
  32                  separated  plain-text  (compatible  with  <b>xargs</b>(1)  -0 option
  33                  where available).
  34
  35           <b>--format-version=N</b>
  36                  Use the specified structured output format version.  This  is
  37                  intended  for  programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
  38                  omitted, the latest supported version will be used.
  39
  40           <b>--output=(summary|threads|messages|files|tags)</b>
  41
  42               <b>summary</b>
  43                      Output a summary of each thread with any message matching
  44                      the  search  terms.  The  summary includes the thread ID,
  45                      date, the number of messages in the thread (both the num‐
  46                      ber  matched  and  the  total number), the authors of the
  47                      thread and the subject.
  48
  49               <b>threads</b>
  50                      Output the thread IDs of all  threads  with  any  message
  51                      matching  the  search  terms, either one per line (--for‐
  52                      mat=text), separated by null characters (--format=text0),
  53                      as  a JSON array (--format=json), or an S-Expression list
  54                      (--format=sexp).
  55
  56               <b>messages</b>
  57                      Output the message  IDs  of  all  messages  matching  the
  58                      search  terms, either one per line (--format=text), sepa‐
  59                      rated by null  characters  (--format=text0),  as  a  JSON
  60                      array (--format=json), or as an S-Expression list (--for‐
  61                      mat=sexp).
  62
  63               <b>files</b>  Output the filenames of all messages matching the  search
  64                      terms,  either one per line (--format=text), separated by
  65                      null characters (--format=text0), as a JSON array (--for‐
  66                      mat=json), or as an S-Expression list (--format=sexp).
  67
  68                      Note  that each message may have multiple filenames asso‐
  69                      ciated with it. All of them are included  in  the  output
  70                      (unless  limited with the --duplicate=N option). This may
  71                      be particularly confusing for <b>folder:</b> or  <b>path:</b>  searches
  72                      in a specified directory, as the messages may have dupli‐
  73                      cates in other directories that are included in the  out‐
  74                      put,  although  these  files  alone  would  not match the
  75                      search.
  76
  77               <b>tags</b>   Output all tags that appear on any message  matching  the
  78                      search  terms, either one per line (--format=text), sepa‐
  79                      rated by null  characters  (--format=text0),  as  a  JSON
  80                      array (--format=json), or as an S-Expression list (--for‐
  81                      mat=sexp).
  82
  83           <b>--sort=(newest-first|oldest-first)</b>
  84                  This option can be used to present results in either  chrono‐
  85                  logical  order  (<b>oldest-first</b>) or reverse chronological order
  86                  (<b>newest-first</b>).
  87
  88                  Note: The thread order will be  distinct  between  these  two
  89                  options  (beyond being simply reversed). When sorting by <b>old-</b>
  90                  <b>est-first</b> the threads will be sorted by the oldest message in
  91                  each  thread,  but  when  sorting by <b>newest-first</b> the threads
  92                  will be sorted by the newest message in each thread.
  93
  94                  By default, results will be displayed in reverse  chronologi‐
  95                  cal  order,  (that  is,  the newest results will be displayed
  96                  first).
  97
  98           <b>--offset=[-]N</b>
  99                  Skip displaying the first N results. With  the  leading  &apos;-&apos;,
 100                  start at the Nth result from the end.
 101
 102           <b>--limit=N</b>
 103                  Limit the number of displayed results to N.
 104
 105           <b>--exclude=(true|false|all|flag)</b>
 106                  A message is called &quot;excluded&quot; if it matches at least one tag
 107                  in search.tag_exclude that does not appear explicitly in  the
 108                  search  terms. This option specifies whether to omit excluded
 109                  messages in the search process.
 110
 111                  The default value,  <b>true</b>,  prevents  excluded  messages  from
 112                  matching the search terms.
 113
 114                  <b>all</b> additionally prevents excluded messages from appearing in
 115                  displayed results, in effect behaving as though the  excluded
 116                  messages do not exist.
 117
 118                  <b>false</b>  allows  excluded  messages  to  match search terms and
 119                  appear in displayed  results.  Excluded  messages  are  still
 120                  marked in the relevant outputs.
 121
 122                  <b>flag</b>  only has an effect when <b>--output=summary</b>. The output is
 123                  almost identical to <b>false</b>, but the &quot;match count&quot; is the  num‐
 124                  ber  of  matching non-excluded messages in the thread, rather
 125                  than the number of matching messages.
 126
 127           <b>--duplicate=N</b>
 128                  Effective with <b>--output=files</b>, output the Nth filename  asso‐
 129                  ciated  with  each message matching the query (N is 1-based).
 130                  If N is greater than the number of files associated with  the
 131                  message, don&apos;t print anything.
 132
 133                  Note  that  this option is orthogonal with the <b>folder:</b> search
 134                  prefix. The prefix matches messages based on filenames.  This
 135                  option filters filenames of the matching messages.
 136 </pre>
 137
 138 <h2>EXIT STATUS</h2>
 139 <pre>
 140        This command supports the following special exit status codes
 141
 142        <b>20</b>     The requested format version is too old.
 143
 144        <b>21</b>     The requested format version is too new.
 145 </pre>
 146
 147 <h2>SEE ALSO</h2>
 148 <pre>
 149        <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>
 150        <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),
 151        <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>
 152        <a href='../notmuch-tag-1/'>much-tag</a>(1)
 153 </pre>
 154
 155 <h2>AUTHOR</h2>
 156 <pre>
 157        Carl Worth and many others
 158 </pre>
 159
 160 <h2>COPYRIGHT</h2>
 161 <pre>
 162        2014, Carl Worth and many others
 163 </pre>
 164
 165 <h2>0.18.1</h2>