From 0568dc66970180cbda48af10d27c49fb1a36805e Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Sat, 11 Jul 2020 11:45:56 +0300 Subject: [PATCH] manpages updates for release 0.30 $ cd path/to/notmuch $ ./devel/man-to-mdwn.pl doc/_build/man ../notmuch-wiki $ cd ../notmuch-wiki $ : edit, commit, push --- manpages.mdwn | 2 +- manpages/notmuch-1.mdwn | 29 ++++----- manpages/notmuch-address-1.mdwn | 4 +- manpages/notmuch-compact-1.mdwn | 4 +- manpages/notmuch-config-1.mdwn | 67 +++++++++---------- manpages/notmuch-count-1.mdwn | 4 +- manpages/notmuch-dump-1.mdwn | 4 +- manpages/notmuch-emacs-mua-1.mdwn | 4 +- manpages/notmuch-hooks-5.mdwn | 4 +- manpages/notmuch-insert-1.mdwn | 4 +- manpages/notmuch-new-1.mdwn | 4 +- manpages/notmuch-properties-7.mdwn | 28 +++++++- manpages/notmuch-reindex-1.mdwn | 4 +- manpages/notmuch-reply-1.mdwn | 4 +- manpages/notmuch-restore-1.mdwn | 4 +- manpages/notmuch-search-1.mdwn | 4 +- manpages/notmuch-search-terms-7.mdwn | 97 +++++++++++----------------- manpages/notmuch-show-1.mdwn | 4 +- manpages/notmuch-tag-1.mdwn | 4 +- 19 files changed, 134 insertions(+), 145 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index aa2f987..e9aa5e5 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -24,4 +24,4 @@ The manual pages are licensed under [the GNU General Public License](https://www.gnu.org/licenses/gpl.txt), either version 3.0 or at your option any later version. -

0.29

+

0.30

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index c86fec7..88e1d23 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -128,9 +128,8 @@

  OPTION SYNTAX

        All options accepting an argument can be used with '=' or ':' as a sep‐
-       arator. For the cases where it's not ambiguous (in particular excluding
-       boolean options), a space can also  be  used.  The  following  are  all
-       equivalent:
+       arator.  Except for boolean options (which would be ambiguous), a space
+       can also be used as a separator. The following are all equivalent:
 
           notmuch --config=alt-config config get user.name
           notmuch --config:alt-config config get user.name
@@ -143,25 +142,25 @@
        of notmuch.
 
        NOTMUCH_CONFIG
-              Specifies the location of the notmuch configuration  file.  Not‐
-              much  will  use  ${HOME}/.notmuch-config if this variable is not
+              Specifies  the  location of the notmuch configuration file. Not‐
+              much will use ${HOME}/.notmuch-config if this  variable  is  not
               set.
 
        NOTMUCH_TALLOC_REPORT
-              Location to  write  a  talloc  memory  usage  report.  See  tal-
+              Location  to  write  a  talloc  memory  usage  report.  See tal-
               loc_enable_leak_report_full in talloc(3) for more information.
 
        NOTMUCH_DEBUG_QUERY
-              If  set to a non-empty value, the notmuch library will print (to
+              If set to a non-empty value, the notmuch library will print  (to
               stderr) Xapian queries it constructs.
 

SEE ALSO

-       notmuch-address(1),   notmuch-compact(1),    notmuch-config(1),    not‐
+       notmuch-address(1),    notmuch-compact(1),    notmuch-config(1),   not‐
        much-count(1),  notmuch-dump(1),  notmuch-hooks(5),  notmuch-insert(1),
-       notmuch-new(1),   notmuch-properties(7),    notmuch-reindex(1),    not‐
-       much-reply(1),      notmuch-restore(1),     notmuch-search(1),     not‐
+       notmuch-new(1),    notmuch-properties(7),    notmuch-reindex(1),   not‐
+       much-reply(1),     notmuch-restore(1),     notmuch-search(1),      not‐
        much-search-terms(7), notmuch-show(1), notmuch-tag(1)
 
        The notmuch website: https://notmuchmail.org
@@ -169,11 +168,11 @@
 
 

CONTACT

-       Feel free to send questions, comments, or kudos to the notmuch  mailing
-       list  <notmuch@notmuchmail.org>  .  Subscription is not required before
+       Feel  free to send questions, comments, or kudos to the notmuch mailing
+       list <notmuch@notmuchmail.org> . Subscription is  not  required  before
        posting, but is available from the notmuchmail.org website.
 
-       Real-time interaction with the Notmuch community is available  via  IRC
+       Real-time  interaction  with the Notmuch community is available via IRC
        (server: irc.freenode.net, channel: #notmuch).
 
@@ -184,7 +183,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index cefd87b..883a503 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -127,7 +127,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index cee6008..5f1d22c 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -61,7 +61,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 2e4fa2c..9d502a3 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -37,7 +37,7 @@ list Every configuration item is printed to stdout, each on a sepa‐ rate line of the form: - *section*.\ *item*\ =\ *value* + section.item=value No additional whitespace surrounds the dot or equals sign char‐ acters. In a multiple-value item (a list), the values are sepa‐ @@ -136,36 +136,28 @@ Default: true. - crypto.gpg_path - Name (or full path) of gpg binary to use in verification and - decryption of PGP/MIME messages. NOTE: This configuration item - is deprecated, and will be ignored if notmuch is built against - GMime 3.0 or later. - - Default: gpg. - index.decrypt [STORED IN DATABASE] - Policy for decrypting encrypted messages during indexing. Must + Policy for decrypting encrypted messages during indexing. Must be one of: false, auto, nostash, or true. - When indexing an encrypted e-mail message, if this variable is - set to true, notmuch will try to decrypt the message and index - the cleartext, stashing a copy of any discovered session keys + When indexing an encrypted e-mail message, if this variable is + set to true, notmuch will try to decrypt the message and index + the cleartext, stashing a copy of any discovered session keys for the message. If auto, it will try to index the cleartext if - a stashed session key is already known for the message (e.g. - from a previous copy), but will not try to access your secret + a stashed session key is already known for the message (e.g. + from a previous copy), but will not try to access your secret keys. Use false to avoid decrypting even when a stashed session key is already present. - nostash is the same as true except that it will not stash + nostash is the same as true except that it will not stash newly-discovered session keys in the database. - From the command line (i.e. during notmuch-new(1), not‐ - much-insert(1), or notmuch-reindex(1)), the user can override - the database's stored decryption policy with the --decrypt= + From the command line (i.e. during notmuch-new(1), not‐ + much-insert(1), or notmuch-reindex(1)), the user can override + the database's stored decryption policy with the --decrypt= option. - Here is a table that summarizes the functionality of each of + Here is a table that summarizes the functionality of each of these policies: ┌──────────────┬───────┬──────┬─────────┬──────┐ @@ -185,36 +177,37 @@ ├──────────────┼───────┼──────┼─────────┼──────┤ │Delete │stashed ses‐ │ │ │ │ │ - │sion keys on │ │ │ │ │ + │sion keys on │ │ │ │ │ │reindex │ │ │ │ │ └──────────────┴───────┴──────┴─────────┴──────┘ - Stashed session keys are kept in the database as properties + Stashed session keys are kept in the database as properties associated with the message. See session-key in notmuch-proper‐ ties(7) for more details about how they can be useful. - Be aware that the notmuch index is likely sufficient (and a - stashed session key is certainly sufficient) to reconstruct the - cleartext of the message itself, so please ensure that the not‐ - much message index is adequately protected. DO NOT USE - index.decrypt=true or index.decrypt=nostash without considering + Be aware that the notmuch index is likely sufficient (and a + stashed session key is certainly sufficient) to reconstruct the + cleartext of the message itself, so please ensure that the not‐ + much message index is adequately protected. DO NOT USE + index.decrypt=true or index.decrypt=nostash without considering the security of your index. Default: auto. index.header.<prefix> [STORED IN DATABASE] - Define the query prefix <prefix>, based on a mail header. For - example index.header.List=List-Id will add a probabilistic pre‐ - fix List: that searches the List-Id field. User defined pre‐ + Define the query prefix <prefix>, based on a mail header. For + example index.header.List=List-Id will add a probabilistic pre‐ + fix List: that searches the List-Id field. User defined pre‐ fixes must not start with 'a'...'z'; in particular adding a pre‐ - fix with same name as a predefined prefix is not supported. See - notmuch-search-terms(7) for a list of existing prefixes, and an + fix with same name as a predefined prefix is not supported. See + notmuch-search-terms(7) for a list of existing prefixes, and an explanation of probabilistic prefixes. 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)). + Compile time feature <name>. Current possibilities include + "retry_lock" (configure option, included by default). (since + notmuch 0.30, "compact" and "field_processor" are always + included.) query.<name> [STORED IN DATABASE] Expansion for named query called <name>. See not‐ @@ -247,7 +240,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index aedf0f8..332580e 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -74,7 +74,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index f086eba..1c93e84 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -114,7 +114,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn index 0dc8cb8..8aac10c 100644 --- a/manpages/notmuch-emacs-mua-1.mdwn +++ b/manpages/notmuch-emacs-mua-1.mdwn @@ -89,7 +89,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index d24912f..7eb8e81 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -63,7 +63,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 85695d7..91aac93 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -113,7 +113,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index e29f2e8..5b13627 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -93,7 +93,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-properties-7.mdwn b/manpages/notmuch-properties-7.mdwn index f285188..b5d47a3 100644 --- a/manpages/notmuch-properties-7.mdwn +++ b/manpages/notmuch-properties-7.mdwn @@ -107,12 +107,34 @@ tion of the algorithm-specific key. For example, an AES-128 key might be stashed in a notmuch property as: ses- sion-key=7:14B16AF65536C28AF209828DFE34C9E0. + + index.repaired + Some messages arrive in forms that are confusing to view; they can + be mangled by mail transport agents, or the sending mail user agent + may structure them in a way that is confusing. If notmuch knows how + to both detect and repair such a problematic message, it will do so + during indexing. + + If it applies a message repair during indexing, it will use the + index.repaired property to note the type of repair(s) it performed. + + index.repaired=skip-protected-headers-legacy-display indicates that + when indexing the cleartext of an encrypted message, notmuch skipped + over a "legacy-display" text/rfc822-headers part that it found in + that message, since it was able to index the built-in protected + headers directly. + + index.repaired=mixedup indicates the repair of a "Mixed Up" + encrypted PGP/MIME message, a mangling typically produced by Micro‐ + soft's + https://tools.ietf.org/html/draft-dkg-openpgp-pgpmime-message-mangling + for more information.

SEE ALSO

        notmuch(1), notmuch-config(1), notmuch-dump(1), notmuch-insert(1), not‐
-       much-new(1), notmuch-reindex(1), notmuch-reply(1),  notmuch-restore(1),
+       much-new(1),  notmuch-reindex(1), notmuch-reply(1), notmuch-restore(1),
        notmuch-show(1), *notmuch-search-terms(7)
 
@@ -123,7 +145,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-reindex-1.mdwn b/manpages/notmuch-reindex-1.mdwn index 3af7668..1180c14 100644 --- a/manpages/notmuch-reindex-1.mdwn +++ b/manpages/notmuch-reindex-1.mdwn @@ -91,7 +91,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index cae4c5e..913223c 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -126,7 +126,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 0d6b1ab..d5b4f57 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -99,7 +99,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 098d9be..f727bec 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -176,7 +176,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index e46c6b5..63d9fd8 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -40,9 +40,8 @@ terms to match against specific portions of an email, (where <brackets> indicate user-supplied values). - If notmuch is built with Xapian Field Processors (see below) some of - the prefixes with <regex> forms can be also used to restrict the - results to those whose value matches a regular expression (see + Some of the prefixes with <regex> forms can be also used to restrict + the results to those whose value matches a regular expression (see regex(7)) delimited with //, for example: notmuch search 'from:"/bob@.*[.]example[.]com/"' @@ -51,47 +50,46 @@ Match terms in the body of messages. from:<name-or-address> or from:/<regex>/ - The from: prefix is used to match the name or address of the + The from: prefix is used to match the name or address of the sender of an email message. to:<name-or-address> - The to: prefix is used to match the names or addresses of any + The to: prefix is used to match the names or addresses of any recipient of an email message, (whether To, Cc, or Bcc). subject:<word-or-quoted-phrase> or subject:/<regex>/ - Any term prefixed with subject: will match only text from the - subject of an email. Searching for a phrase in the subject is - supported by including quotation marks around the phrase, imme‐ + Any term prefixed with subject: will match only text from the + subject of an email. Searching for a phrase in the subject is + supported by including quotation marks around the phrase, imme‐ diately following subject:. attachment:<word> - The attachment: prefix can be used to search for specific file‐ + The attachment: prefix can be used to search for specific file‐ names (or extensions) of attachments to email messages. mimetype:<word> - The mimetype: prefix will be used to match text from the con‐ - tent-types of MIME parts within email messages (as specified by + The mimetype: prefix will be used to match text from the con‐ + tent-types of MIME parts within email messages (as specified by the sender). tag:<tag> or tag:/<regex>/ or is:<tag> or is:/<regex>/ - For tag: and is: valid tag values include inbox and unread by - default for new messages added by notmuch new as well as any + For tag: and is: valid tag values include inbox and unread by + default for new messages added by notmuch new as well as any other tag values added manually with notmuch tag. id:<message-id> or mid:<message-id> or mid:/<regex>/ - For id: and mid:, message ID values are the literal contents of - the Message-ID: header of email messages, but without the '<', + For id: and mid:, message ID values are the literal contents of + the Message-ID: header of email messages, but without the '<', '>' delimiters. thread:<thread-id> - The thread: prefix can be used with the thread ID values that - are generated internally by notmuch (and do not appear in email - messages). These thread ID values can be seen in the first col‐ + The thread: prefix can be used with the thread ID values that + are generated internally by notmuch (and do not appear in email + messages). These thread ID values can be seen in the first col‐ umn of output from notmuch search thread:{<notmuch query>} - If notmuch is built with Xapian Field Processors (see below), - threads may be searched for indirectly by providing an arbitrary + Threads may be searched for indirectly by providing an arbitrary notmuch query in {}. For example, the following returns threads containing a message from mallory and one (not necessarily the same message) with Subject containing the word "crypto". @@ -158,9 +156,7 @@ query:<name> The query: prefix allows queries to refer to previously saved - queries added with notmuch-config(1). Named queries are only - available if notmuch is built with Xapian Field Processors (see - below). + queries added with notmuch-config(1). property:<key>=<value> The property: prefix searches for messages with a particular @@ -329,22 +325,21 @@ since 1970-01-01 00:00:00 UTC. For example: date:@<initial-timestamp>..@<final-timestamp> - 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. 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 + Currently, spaces in range expressions are not supported. You can replace the spaces with '_', or (in most cases) '-', or (in some cases) - leave the spaces out altogether. Examples in this man page use spaces + leave the spaces out altogether. Examples in this man page use spaces for clarity. - Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possi‐ - ble to specify date:..<until> or date:<since>.. to not limit the start - or end time, respectively. Pre-1.2.1 Xapian does not report an error on - open ended ranges, but it does not work as expected either. + Open-ended ranges are supported. I.e. it's possible to specify + date:..<until> or date:<since>.. to not limit the start or end time, + respectively. + + +

  Single expression

+
+       date:<expr> works as a shorthand for date:<expr>..<expr>.  For example,
+       date:monday matches from the beginning of Monday until the end of  Mon‐
+       day.
 

  Relative date and time

@@ -421,31 +416,11 @@ 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"
-
-       · regular expression searches, e.g. "subject:/^\[SPAM\]/"
-
-       · thread subqueries, e.g. "thread:{from:bob}"
-
-

SEE ALSO

-       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1), notmuch-reindex(1),
-       notmuch-properties(1),  *notmuch-reply(1),   notmuch-restore(1),   not‐
+       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       much-hooks(5), notmuch-insert(1),  notmuch-new(1),  notmuch-reindex(1),
+       notmuch-properties(1),   *notmuch-reply(1),   notmuch-restore(1),  not‐
        much-search(1), *notmuch-show(1), notmuch-tag(1)
 
@@ -456,7 +431,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 3d5a1c4..0439d1a 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -222,7 +222,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index 09333c7..9ee65ce 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -113,7 +113,7 @@

COPYRIGHT

-       2009-2019, Carl Worth and many others
+       2009-2020, Carl Worth and many others
 
-

0.29

+

0.30

-- 2.43.0