diff options
| author | Tomi <tomi.ollila@iki.fi> | 2016-07-20 22:01:55 +0300 |
|---|---|---|
| committer | Tomi <tomi.ollila@iki.fi> | 2016-07-20 22:01:55 +0300 |
| commit | 39aab76514c6f6f2b6769b9fd45fd9570664fa49 (patch) | |
| tree | 352bd8d2a0c46769715a44e91e6c95ef17b46ffc | |
| parent | 79b31c279ae0f980ecf4e1bf55e69aa7b21be48d (diff) | |
0.22.1 manpages update -- let's see how it looks like...
| -rw-r--r-- | manpages/notmuch-config-1.mdwn | 9 | ||||
| -rw-r--r-- | manpages/notmuch-dump-1.mdwn | 20 | ||||
| -rw-r--r-- | manpages/notmuch-restore-1.mdwn | 15 | ||||
| -rw-r--r-- | manpages/notmuch-search-terms-7.mdwn | 41 |
4 files changed, 74 insertions, 11 deletions
diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index d661210..7ebcb24 100644 --- 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>. + + <b>built</b>_<b>with.<name></b> + Compile time feature <name>. Current possibilities include "com‐ + pact" (see <a href='../notmuch-compact-1/'>notmuch-compact</a>(1)) and "field_processor" (see <a href='../notmuch-search-terms-7/'>not‐</a> + <a href='../notmuch-search-terms-7/'>much-search-terms</a>(7)). + + <b>query.<name></b> + Expansion for named query called <name>. 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> diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index 05b9caf..fbeb9a3 100644 --- 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. + <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 "#@ ", 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 <<u>format</u>>:<<u>version</u>> <<u>included</u>> + + where <<u>included</u>> is a comma separated list of the above options. + <b>--output=<filename></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 4bbede8..7d4eed2 100644 --- 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. + <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 "#@ ", 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=<filename></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 1457408..ccc203f 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -59,6 +59,8 @@ · 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. @@ -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. + + 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> Operators</h3> @@ -197,14 +203,11 @@ 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> Terms and phrases</h3> @@ -265,9 +268,9 @@ date:<expr>..! can be used as a shorthand for date:<expr>..<expr>. 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:<expr> without "..", for example - date:yesterday, won't work, as it'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 '_', or (in most cases) '-', or (in some cases) @@ -354,6 +357,22 @@ 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. "date:today" + + · named queries e.g. "query:my_special_query" +</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> |
