]> git.notmuchmail.org Git - notmuch-wiki/blobdiff - manpages/notmuch-search-1.mdwn
manpages updates for release 0.32
[notmuch-wiki] / manpages / notmuch-search-1.mdwn
index 4adb33bdf0d4e91cdff6fd9bdd0189c26f7c06ac..731a6110b0f05d48eff504a475167b2747dec7e3 100644 (file)
@@ -12,8 +12,8 @@
 
 <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
@@ -33,9 +33,9 @@
               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>)
               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 &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.
+              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)
                      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>COPYRIGHT</h2>
 <pre>
-       2009-2018, Carl Worth and many others
+       2009-2021, Carl Worth and many others
 </pre>
 
-<h2>0.27</h2>
+<h2>0.32</h2>