0.22.1 manpages update -- let's see how it looks like...

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn
index d6612104d68dccecdd7ffc7d7d1b582d4b9ea86e..7ebcb2406fa86d6231ad3f9b9a5aeaed1b497239 100644 (file)
--- a/manpages/notmuch-config-1.mdwn
+++ b/manpages/notmuch-config-1.mdwn
@@ -129,6 +129,15 @@
               decryption of PGP/MIME messages.
 
               Default: <b>gpg</b>.
               decryption of PGP/MIME messages.
 
               Default: <b>gpg</b>.

+
+          <b>built</b>_<b>with.&lt;name&gt;</b>
+              Compile time feature &lt;name&gt;. Current possibilities include &quot;com‐
+              pact&quot;  (see  <a href='../notmuch-compact-1/'>notmuch-compact</a>(1)) and &quot;field_processor&quot; (see <a href='../notmuch-search-terms-7/'>not‐</a>
+              <a href='../notmuch-search-terms-7/'>much-search-terms</a>(7)).
+
+          <b>query.&lt;name&gt;</b>
+              Expansion   for   named   query   called   &lt;name&gt;.   See    <a href='../notmuch-search-terms-7/'>not‐</a>
+              <a href='../notmuch-search-terms-7/'>much-search-terms</a>(7) for more information about named queries.

 </pre>
 
 <h2>ENVIRONMENT</h2>
 </pre>
 
 <h2>ENVIRONMENT</h2>

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn
index 05b9caf172798820c71f0cdecb9c32b5bc1979e8..fbeb9a328a962133355fe3039fa6b2b73f5f6d28 100644 (file)
--- a/manpages/notmuch-dump-1.mdwn
+++ b/manpages/notmuch-dump-1.mdwn
@@ -68,6 +68,26 @@
                      characters.  Note  also that tags with spaces will not be
                      correctly restored with this format.
 
                      characters.  Note  also that tags with spaces will not be
                      correctly restored with this format.
 

+          <b>--include=(config|tags)</b>
+
+          Control what kind of metadata is included in the output.
+              <b>config</b>
+                 Output configuration data stored in the database.  Each  line
+                 starts  with  &quot;#@  &quot;, followed by a space seperated key-value
+                 pair.  Both key and value are hex encoded if needed.
+
+              <b>tags</b>
+                 Output per-message metadata, namely tags.  See  <u>format</u>  above
+                 for description of the output.
+
+              The  default  is to include both tags and configuration informa‐
+              tion. As of version 2 of the dump format, there is a header line
+              of the following form
+
+                #notmuch-dump &lt;<u>format</u>&gt;:&lt;<u>version</u>&gt; &lt;<u>included</u>&gt;
+
+              where &lt;<u>included</u>&gt; is a comma separated list of the above options.
+

           <b>--output=&lt;filename&gt;</b>
                  Write output to given file instead of stdout.
 </pre>
           <b>--output=&lt;filename&gt;</b>
                  Write output to given file instead of stdout.
 </pre>

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn
index 4bbede8e6156f90dd89d8da8bc1e0e063bba4d00..7d4eed242b9c0658fc2f94c0ff73a546e0a9ba25 100644 (file)
--- a/manpages/notmuch-restore-1.mdwn
+++ b/manpages/notmuch-restore-1.mdwn
@@ -54,6 +54,21 @@
                         batch-tag  format  contains  no parentheses, should be
                         accurate.
 
                         batch-tag  format  contains  no parentheses, should be
                         accurate.
 

+          <b>--include=(config|tags)</b>
+              Control what kind of metadata is restored.
+                 <b>config</b>
+                     Restore configuration data to the database. Each configu‐
+                     ration line starts with &quot;#@ &quot;, followed by a space seper‐
+                     ated key-value pair.  Both key and value are hex  encoded
+                     if needed.
+
+                 <b>tags</b>
+                     Output  per-message  metadata,  namely  tags.  See <u>format</u>
+                     above for more details.
+
+              The default is to restore both tags and  configuration  informa‐
+              tion
+

           <b>--input=&lt;filename&gt;</b>
                  Read input from given file instead of stdin.
 </pre>
           <b>--input=&lt;filename&gt;</b>
                  Read input from given file instead of stdin.
 </pre>

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn
index 14574087e572c11ba43bfdeb3575d252207f8d5a..ccc203fabb444d2ddaf1cdb54faa31f4c95ca58d 100644 (file)
--- a/manpages/notmuch-search-terms-7.mdwn
+++ b/manpages/notmuch-search-terms-7.mdwn
@@ -59,6 +59,8 @@
 
        · lastmod:<initial-revision>..<final-revision>
 
 
        · lastmod:<initial-revision>..<final-revision>
 

+       · query:<name>
+

        The <b>from:</b> prefix is used to match the name or address of the sender  of
        an email message.
 
        The <b>from:</b> prefix is used to match the name or address of the sender  of
        an email message.
 


@@ -130,6 +132,10 @@
        added/removed or filenames changed).  This is usually used in  conjunc‐
        tion  with  the <b>--uuid</b> argument to <b>notmuch</b> <b>search</b> to find messages that
        have changed since an earlier query.
        added/removed or filenames changed).  This is usually used in  conjunc‐
        tion  with  the <b>--uuid</b> argument to <b>notmuch</b> <b>search</b> to find messages that
        have changed since an earlier query.

+
+       The <b>query:</b> prefix allows queries to refer to previously  saved  queries
+       added  with <a href='../notmuch-config-1/'>notmuch-config</a>(1). Named queries are only available if not‐
+       much is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below).

 </pre>
 
 <h3> &nbsp; Operators</h3>
 </pre>
 
 <h3> &nbsp; Operators</h3>


@@ -197,14 +203,11 @@
        flexible <b>term</b> based searching. The prefixes currently supported by not‐
        much are as follows.
 
        flexible <b>term</b> based searching. The prefixes currently supported by not‐
        much are as follows.
 

-              ┌───────────────────────────┬────────────────────────────┐
-              │Boolean
-              ├───────────────────────────┼────────────────────────────┤
-              │
-              │
-              │       <b>thread:</b>     <b>folder:</b> │        <b>subject:</b>    <b>attach‐</b> │
-              │       <b>path:</b>               │        <b>ment:</b> <b>mimetype:</b>     │
-              └───────────────────────────┴────────────────────────────┘
+       <b>Boolean</b>
+              <b>tag:</b>, <b>id:</b>, <b>thread:</b>, <b>folder:</b>, <b>path:</b>
+
+       <b>Probabilistic</b>
+              <b>from:</b>, <b>to:</b>, <b>subject:</b>, <b>attachment:</b>, <b>mimetype:</b>

 </pre>
 
 <h3> &nbsp; Terms and phrases</h3>
 </pre>
 
 <h3> &nbsp; Terms and phrases</h3>


@@ -265,9 +268,9 @@
        date:&lt;expr&gt;..!  can be used as a shorthand for date:&lt;expr&gt;..&lt;expr&gt;. The
        expansion takes place before interpretation,  and  thus,  for  example,
        date:monday..!  matches  from  the beginning of Monday until the end of
        date:&lt;expr&gt;..!  can be used as a shorthand for date:&lt;expr&gt;..&lt;expr&gt;. The
        expansion takes place before interpretation,  and  thus,  for  example,
        date:monday..!  matches  from  the beginning of Monday until the end of

-       Monday. (Note that  entering  date:&lt;expr&gt;  without  &quot;..&quot;,  for  example
-       date:yesterday,  won&apos;t work, as it&apos;s not interpreted as a range expres‐
-       sion at all. Again, use date:yesterday..!)
+       Monday.  With <b>Xapian</b> <b>Field</b> <b>Processor</b>  support  (see  below),  non-range
+       date  queries such as date:yesterday will work, but otherwise will give
+       unexpected results; if in doubt use date:yesterday..!

 
        Currently, we do not support  spaces  in  range  expressions.  You  can
        replace the spaces with &apos;_&apos;, or (in most cases) &apos;-&apos;, or (in some cases)
 
        Currently, we do not support  spaces  in  range  expressions.  You  can
        replace the spaces with &apos;_&apos;, or (in most cases) &apos;-&apos;, or (in some cases)


@@ -354,6 +357,22 @@
        Some time zone codes, e.g. UTC, EET.
 </pre>
 
        Some time zone codes, e.g. UTC, EET.
 </pre>
 

+<h2>XAPIAN FIELD PROCESSORS</h2>
+<pre>
+       Certain optional features of the notmuch query processor  rely  on  the
+       presence  of  the Xapian field processor API. You can determine if your
+       notmuch was built against a sufficiently recent version  of  Xapian  by
+       running
+
+          % notmuch config get built_with.field_processor
+
+       Currently the following features require field processor support:
+
+       · non-range date queries, e.g. &quot;date:today&quot;
+
+       · named queries e.g. &quot;query:my_special_query&quot;
+</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>
 <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>