From 39aab76514c6f6f2b6769b9fd45fd9570664fa49 Mon Sep 17 00:00:00 2001 From: Tomi Date: Wed, 20 Jul 2016 22:01:55 +0300 Subject: [PATCH] 0.22.1 manpages update -- let's see how it looks like... --- manpages/notmuch-config-1.mdwn | 9 ++++++ manpages/notmuch-dump-1.mdwn | 20 ++++++++++++++ manpages/notmuch-restore-1.mdwn | 15 ++++++++++ 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: gpg. + + built_with.<name> + Compile time feature <name>. Current possibilities include "com‐ + pact" (see notmuch-compact(1)) and "field_processor" (see not‐ + much-search-terms(7)). + + query.<name> + Expansion for named query called <name>. See not‐ + much-search-terms(7) for more information about named queries.

ENVIRONMENT

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. + --include=(config|tags) + + Control what kind of metadata is included in the output. + config + 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. + + tags + Output per-message metadata, namely tags. See format 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 <format>:<version> <included> + + where <included> is a comma separated list of the above options. + --output=<filename> Write output to given file instead of stdout. 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. + --include=(config|tags) + Control what kind of metadata is restored. + config + 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. + + tags + Output per-message metadata, namely tags. See format + above for more details. + + The default is to restore both tags and configuration informa‐ + tion + --input=<filename> Read input from given file instead of stdin. 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 from: 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 --uuid argument to notmuch search to find messages that have changed since an earlier query. + + The query: prefix allows queries to refer to previously saved queries + added with notmuch-config(1). Named queries are only available if not‐ + much is built with Xapian Field Processors (see below).

  Operators

@@ -197,14 +203,11 @@ flexible term based searching. The prefixes currently supported by not‐ much are as follows. - ┌───────────────────────────┬────────────────────────────┐ - │Boolean - ├───────────────────────────┼────────────────────────────┤ - │ - │ - │ thread: folder: │ subject: attach‐ │ - │ path: │ ment: mimetype: │ - └───────────────────────────┴────────────────────────────┘ + Boolean + tag:, id:, thread:, folder:, path: + + Probabilistic + from:, to:, subject:, attachment:, mimetype:

  Terms and phrases

@@ -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 Xapian Field Processor 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. +

XAPIAN FIELD PROCESSORS

+
+       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"
+
+

SEE ALSO

        notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
-- 
2.43.0