From c53d121cfc5e56594ffa3bb7250e04e2cc30587e Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Sun, 6 Feb 2022 23:51:04 +0200 Subject: [PATCH] manpages updates for release 0.35 --- manpages.mdwn | 2 +- manpages/notmuch-1.mdwn | 4 +- manpages/notmuch-address-1.mdwn | 4 +- manpages/notmuch-compact-1.mdwn | 4 +- manpages/notmuch-config-1.mdwn | 93 +++++++------- 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 | 16 +-- manpages/notmuch-new-1.mdwn | 4 +- manpages/notmuch-properties-7.mdwn | 113 ++++++++--------- manpages/notmuch-reindex-1.mdwn | 4 +- manpages/notmuch-reply-1.mdwn | 6 +- manpages/notmuch-restore-1.mdwn | 4 +- manpages/notmuch-search-1.mdwn | 6 +- manpages/notmuch-search-terms-7.mdwn | 4 +- manpages/notmuch-sexp-queries-7.mdwn | 176 ++++++++++++++------------- manpages/notmuch-show-1.mdwn | 18 ++- manpages/notmuch-tag-1.mdwn | 4 +- 20 files changed, 250 insertions(+), 228 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index b97fef0..41b7772 100644 --- a/manpages.mdwn +++ b/manpages.mdwn @@ -25,4 +25,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.34

+

0.35

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 19253e3..9c46fcd 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -193,7 +193,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index 1c649c2..30d8cec 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -127,7 +127,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index 3ee6e2d..8f8cf6a 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -50,7 +50,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index bee4eb2..a8c8ccd 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -138,6 +138,16 @@ Default: empty list. Note that notmuch-setup(1) puts deleted;spam here when creating new configuration file. + show.extra_headers + By default notmuch-show(1) includes the following headers in struc‐ + tured output if they are present in the message: Subject, From, To, + Cc, Bcc, Reply-To, Date. This option allows the specification of a + list of further headers to output. + + History: This configuration value was introduced in notmuch 0.35. + + Default: empty list. + maildir.synchronize_flags If true, then the following maildir flags (in message filenames) will be synchronized with the corresponding notmuch tags: @@ -153,7 +163,7 @@ ├─────┼────────────────────────────┤ │R │ replied │ ├─────┼────────────────────────────┤ - │S │ unread (added when 'S' │ + │S │ unread (added when 'S' │ │ │ flag is not present) │ └─────┴────────────────────────────┘ @@ -161,42 +171,41 @@ and update tags, while the notmuch-tag(1) and notmuch-restore(1) commands will notice tag changes and update flags in filenames. - If there have been any changes in the maildir (new messages - added, old ones removed or renamed, maildir flags changed, + If there have been any changes in the maildir (new messages + added, old ones removed or renamed, maildir flags changed, etc.), it is advisable to run notmuch-new(1) before not‐ - much-tag(1) or notmuch-restore(1) commands to ensure the tag - changes are properly synchronized to the maildir flags, as the + much-tag(1) or notmuch-restore(1) commands to ensure the tag + changes are properly synchronized to the maildir flags, as the commands expect the database and maildir to be in sync. Default: true. index.decrypt - 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), notmuch-in‐ + From the command line (i.e. during notmuch-new(1), notmuch-in‐ sert(1), or notmuch-reindex(1)), the user can override the data‐ base'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: ┌──────────────┬───────┬──────┬─────────┬──────┐ │ │ false │ auto │ nostash │ true │ - └──────────────┴───────┴──────┴─────────┴──────┘ - + ├──────────────┼───────┼──────┼─────────┼──────┤ │Index cleart‐ │ │ X │ X │ X │ │ext using │ │ │ │ │ │stashed ses‐ │ │ │ │ │ @@ -211,45 +220,45 @@ ├──────────────┼───────┼──────┼─────────┼──────┤ │Delete │stashed ses‐ │ │ │ │ │ - │sion keys on │ │ │ │ │ + │sion keys on │ │ │ │ │ │reindex │ │ │ │ │ └──────────────┴───────┴──────┴─────────┴──────┘ - Stashed session keys are kept in the database as properties as‐ - sociated with the message. See session-key in notmuch-proper‐ + Stashed session keys are kept in the database as properties as‐ + sociated 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 in- - dex.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 in- + dex.decrypt=true or index.decrypt=nostash without considering the security of your index. Default: auto. index.header.<prefix> - 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 - "retry_lock" (configure option, included by default). (since - notmuch 0.30, "compact" and "field_processor" are always in‐ + "retry_lock" (configure option, included by default). (since + notmuch 0.30, "compact" and "field_processor" are always in‐ cluded.) query.<name> - Expansion for named query called <name>. See not‐ + Expansion for named query called <name>. See not‐ much-search-terms(7) for more information about named queries. squery.<name> Expansion for named query called <name>, using s-expression syn‐ - tax. See notmuch-sexp-queries(7) for more information about + tax. See notmuch-sexp-queries(7) for more information about s-expression queries. @@ -264,10 +273,10 @@ 2. File specified by NOTMUCH_CONFIG environment variable. 3. $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is defined - by NOTMUCH_PROFILE environment variable if set, $XDG_CON- + by NOTMUCH_PROFILE environment variable if set, $XDG_CON- FIG_HOME/notmuch/default/config otherwise. - 4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOT- + 4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOT- MUCH_PROFILE environment variable if set, $HOME/.notmuch-config oth‐ erwise. @@ -280,7 +289,7 @@ 2. Directory specified by config key database.path. - 3. $XDG_DATA_HOME/notmuch/<profile> where <profile> is defined by NOT- + 3. $XDG_DATA_HOME/notmuch/<profile> where <profile> is defined by NOT- MUCH_PROFILE environment variable if set, $XDG_DATA_HOME/notmuch/de- fault otherwise. @@ -295,8 +304,8 @@ 1. Directory specified by database.hook_dir configuration option. - 2. $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile> is defined - by NOTMUCH_PROFILE environment variable if set, $XDG_CON- + 2. $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile> is defined + by NOTMUCH_PROFILE environment variable if set, $XDG_CON- FIG_HOME/notmuch/default/hooks otherwise. 3. <database.path>/.notmuch/hooks @@ -304,8 +313,8 @@

SEE ALSO

-       notmuch(1),  notmuch-count(1),  notmuch-dump(1), notmuch-hooks(5), not‐
-       much-insert(1),  notmuch-new(1),   notmuch-properties(7),   notmuch-re‐
+       notmuch(1), notmuch-count(1), notmuch-dump(1),  notmuch-hooks(5),  not‐
+       much-insert(1),   notmuch-new(1),   notmuch-properties(7),  notmuch-re‐
        ply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7),
        notmuch-show(1), notmuch-tag(1)
@@ -317,7 +326,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 47dd4fc..1470448 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -74,7 +74,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

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

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn index 69866ff..4e6f71d 100644 --- a/manpages/notmuch-emacs-mua-1.mdwn +++ b/manpages/notmuch-emacs-mua-1.mdwn @@ -89,7 +89,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index e636992..6a7ae27 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -63,7 +63,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index affbe16..46a6aa7 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -13,10 +13,10 @@

DESCRIPTION

        notmuch insert reads a message from standard input and delivers it into
-       the maildir directory given by configuration option database.path, then
-       incorporates  the  message into the notmuch database. It is an alterna‐
-       tive to using a separate tool to deliver the message then running  not‐
-       much-new(1) afterwards.
+       the maildir directory given by configuration option database.mail_root,
+       then  incorporates  the message into the notmuch database. It is an al‐
+       ternative to using a separate tool to deliver the message then  running
+       notmuch-new(1) afterwards.
 
        The  new message will be tagged with the tags specified by the new.tags
        configuration option, then by operations specified on the command-line:
@@ -34,8 +34,8 @@
 
        --folder=<folder>
               Deliver  the  message  to  the specified folder, relative to the
-              top-level directory given by the value of database.path. The de‐
-              fault  is  the  empty  string,  which  means  delivering  to the
+              top-level directory given by the  value  of  database.mail_root.
+              The  default  is the empty string, which means delivering to the
               top-level directory.
 
        --create-folder
@@ -113,7 +113,7 @@
 
 
COPYRIGHT

 
-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 

 
-
0.34

+
0.35

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn
index 69bbc39..caba2ac 100644
--- a/manpages/notmuch-new-1.mdwn
+++ b/manpages/notmuch-new-1.mdwn
@@ -92,7 +92,7 @@
 
 
COPYRIGHT

 
-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 

 
-
0.34

+
0.35

diff --git a/manpages/notmuch-properties-7.mdwn b/manpages/notmuch-properties-7.mdwn
index 81de197..8cfd7f6 100644
--- a/manpages/notmuch-properties-7.mdwn
+++ b/manpages/notmuch-properties-7.mdwn
@@ -75,66 +75,69 @@
               sage.
 
        session-key
-          When notmuch-show(1) or notmuch-reply(1) encounters a  message  with
-          an  encrypted  part, if notmuch finds a session-key property associ‐
-          ated with the message, it will try that stashed session key for  de‐
-          cryption.
-
-          If  you  do  not  want to use any stashed session keys that might be
-          present, you should pass those programs --decrypt=false.
-
-          Using a stashed session key with "notmuch show" will speed  up  ren‐
-          dering  of  long  encrypted threads.  It also allows the user to de‐
-          stroy the secret part of any expired encryption-capable subkey while
-          still  being  able to read any retained messages for which they have
-          stashed the session key.  This enables truly deletable e-mail, since
-          (once  the  session  key  and  asymmetric subkey are both destroyed)
-          there are no keys left that can be used to decrypt any copy  of  the
-          original message previously stored by an adversary.
-
-          However,  access to the stashed session key for an encrypted message
-          permits full byte-for-byte reconstruction of the cleartext  message.
-          This includes attachments, cryptographic signatures, and other mate‐
-          rial that cannot be reconstructed from the index alone.
-
-          See index.decrypt in notmuch-config(1) for more details about how to
-          set notmuch's policy on when to store session keys.
-
-          The  session key should be in the ASCII text form produced by GnuPG.
-          For OpenPGP, that consists of a decimal representation of  the  hash
-          algorithm  used  (identified  by  number from RFC 4880, e.g. 9 means
-          AES-256) followed by a colon, followed by a hexadecimal  representa‐
-          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.
+              When notmuch-show(1) or notmuch-reply(1)  encounters  a  message
+              with  an encrypted part, if notmuch finds a session-key property
+              associated with the message, it will try  that  stashed  session
+              key for decryption.
+
+              If you do not want to use any stashed session keys that might be
+              present, you should pass those programs --decrypt=false.
+
+              Using a stashed session key with "notmuch show"  will  speed  up
+              rendering of long encrypted threads.  It also allows the user to
+              destroy the secret part of any expired encryption-capable subkey
+              while  still  being able to read any retained messages for which
+              they have stashed the session key.  This enables truly deletable
+              e-mail,  since  (once  the session key and asymmetric subkey are
+              both destroyed) there are no keys left that can be used  to  de‐
+              crypt  any  copy of the original message previously stored by an
+              adversary.
+
+              However, access to the stashed session key for an encrypted mes‐
+              sage  permits full byte-for-byte reconstruction of the cleartext
+              message.  This includes attachments,  cryptographic  signatures,
+              and  other  material that cannot be reconstructed from the index
+              alone.
+
+              See index.decrypt in notmuch-config(1) for  more  details  about
+              how to set notmuch's policy on when to store session keys.
+
+              The  session  key  should  be in the ASCII text form produced by
+              GnuPG.  For OpenPGP, that consists of a  decimal  representation
+              of  the hash algorithm used (identified by number from RFC 4880,
+              e.g. 9 means AES-256) followed by a colon, followed by  a  hexa‐
+              decimal representation of the algorithm-specific key.  For exam‐
+              ple, an AES-128 key might be stashed in a notmuch  property  as:
+              session-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 in-
-          dex.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"  en‐
-          crypted  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.
+              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  per‐
+              formed.
+
+              index.repaired=skip-protected-headers-legacy-display   indicates
+              that when indexing the cleartext of an encrypted  message,  not‐
+              much  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" en‐
+              crypted PGP/MIME message, a mangling typically produced  by  Mi‐
+              crosoft'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-search-terms(7), notmuch-show(1)
@@ -145,7 +148,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-reindex-1.mdwn b/manpages/notmuch-reindex-1.mdwn index 12bda60..fca8c92 100644 --- a/manpages/notmuch-reindex-1.mdwn +++ b/manpages/notmuch-reindex-1.mdwn @@ -91,7 +91,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index ed6d311..ad897b5 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -62,7 +62,7 @@ --reply-to=(all|sender) - all (default) + all (default) Replies to all addresses. sender Replies only to the sender. If replying to user's own @@ -127,7 +127,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 8c173dd..75d8bf1 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -99,7 +99,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 18b268e..6ea3bab 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -110,7 +110,7 @@ search terms. This option specifies whether to omit excluded messages in the search process. - true (default) + true (default) Prevent excluded messages from matching the search terms. all Additionally prevent excluded messages from appearing in @@ -176,7 +176,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index b3561a3..5d1cae1 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -432,7 +432,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-sexp-queries-7.mdwn b/manpages/notmuch-sexp-queries-7.mdwn index 6744e91..e6968ad 100644 --- a/manpages/notmuch-sexp-queries-7.mdwn +++ b/manpages/notmuch-sexp-queries-7.mdwn @@ -19,7 +19,7 @@ tax(). Support for this syntax is currently optional, you can test if your build of notmuch supports it with - $ notmuch config get built_with.sexpr_query + $ notmuch config get built_with.sexp_queries

  S-EXPRESSIONS

@@ -28,13 +28,13 @@ s-expressions inside parentheses. Atoms are either basic value - A basic value is an unquoted string containing no whitespace, - double quotes, or parentheses. + A basic value is an unquoted string containing no whitespace, double + quotes, or parentheses. quoted string - Double quotes (") delimit strings possibly containing whitespace - or parentheses. These can contain double quote characters by es‐ - caping with backslash. E.g. "this is a quote \"". + Double quotes (") delimit strings possibly containing whitespace or + parentheses. These can contain double quote characters by escaping + with backslash. E.g. "this is a quote \"".

  S-EXPRESSION QUERIES

@@ -43,9 +43,11 @@ query consisting of a prefix atom (first element) defining a field, logical operation, or modifier, and 0 or more subqueries. - * "*" matches any non-empty string in the current field. + * + "*" matches any non-empty string in the current field. - () The empty list matches all messages + () + The empty list matches all messages term Match all messages containing term, possibly after stemming or @@ -54,25 +56,25 @@ values) in s-expression queries. For information on phrase split‐ ting see FIELDS. - ( field q_1 q_2 ... q_n ) - Restrict the queries q_1 to q_n to field, and combine with and - (for most fields) or or. See FIELDS for more information. - - ( operator q_1 q_2 ... q_n ) - Combine queries q_1 to q_n. Currently supported operators are - and, or, and not. (not q_1 ... q_n ) is equivalent to (and (not - q_1 ) ... (not q_n )). - - ( modifier q_1 q_2 ... q_n ) - Combine queries q_1 to q_n, and reinterpret the result (e.g. as - a regular expression). See MODIFIERS for more information. - - (macro ( p_1 ... p_n ) body) - Define saved query with parameter substitution. The syntax is - recognized only in saved s-expression queries (see squery.* in - notmuch-config(1)). Parameter names in body must be prefixed - with , to be expanded (see MACRO EXAMPLES). Macros may refer to - other macros, but only to their own parameters [1]. + ( field q1 q2 ... qn ) + Restrict the queries q1 to qn to field, and combine with and (for + most fields) or or. See FIELDS for more information. + + ( operator q1 q2 ... qn ) + Combine queries q1 to qn. Currently supported operators are and, or, + and not. (not q1 ... qn ) is equivalent to (and (not q1 ) ... (not + qn )). + + ( modifier q1 q2 ... qn ) + Combine queries q1 to qn, and reinterpret the result (e.g. as a reg‐ + ular expression). See MODIFIERS for more information. + + (macro ( p1 ... pn ) body) + Define saved query with parameter substitution. The syntax is recog‐ + nized only in saved s-expression queries (see squery.* in not‐ + much-config(1)). Parameter names in body must be prefixed with , to + be expanded (see MACRO EXAMPLES). Macros may refer to other macros, + but only to their own parameters [1].

  FIELDS

@@ -137,7 +139,8 @@ │tag │ and │ term │ yes │ yes │ yes │ ├───────────┼─────────┼────────┼────────┼──────────┼───────┤ │thread │ or │ term │ yes │ yes │ yes │ - ├───────────┼─────────┼────────┼────────┼──────────┼───────┤ + └───────────┴─────────┴────────┴────────┴──────────┴───────┘ + │to │ and │ phrase │ yes │ yes │ no │ └───────────┴─────────┴────────┴────────┴──────────┴───────┘ @@ -148,96 +151,97 @@ that are neither operators nor fields. (infix atom ) - Interpret atom as an infix notmuch query (see not‐ - much-search-terms(7)). Not supported inside fields. + Interpret atom as an infix notmuch query (see not‐ + much-search-terms(7)). Not supported inside fields. - (matching q_1 q_2 ... q_n ) (of q_1 q_2 ... q_n ) - Match all messages have the same values of the current field as - those matching all of q_1 ... q_n. Supported in most term [7] or - phrase fields. Most commonly used in the thread field. + (matching q1 q2 ... qn ) (of q1 q2 ... qn ) + Match all messages have the same values of the current field as + those matching all of q1 ... qn. Supported in most term [7] or + phrase fields. Most commonly used in the thread field. (query atom ) - Expand to the saved query named by atom. See notmuch-config(1) - for more. Note that the saved query must be in infix syntax - (notmuch-search-terms(7)). Not supported inside fields. + Expand to the saved query named by atom. See notmuch-config(1) for + more. Note that the saved query must be in infix syntax (not‐ + much-search-terms(7)). Not supported inside fields. (regex atom ) (rx atom ) - Interpret atom as a POSIX.2 regular expression (see regex(7)). - This applies in term fields and a subset [5] of phrase fields - (see Fields with supported modifiers). + Interpret atom as a POSIX.2 regular expression (see regex(7)). This + applies in term fields and a subset [5] of phrase fields (see Fields + with supported modifiers). (starts-with subword ) - Matches any term starting with subword. This applies in either - phrase or term fields, or outside of fields [6]. Note that a - starts-with query cannot be part of a phrase. The atom * is a - synonym for (starts-with ""). + Matches any term starting with subword. This applies in either + phrase or term fields, or outside of fields [6]. Note that a + starts-with query cannot be part of a phrase. The atom * is a syn‐ + onym for (starts-with "").

EXAMPLES

-       Wizard Match all messages containing the word "wizard", ignoring case.
+       Wizard
+          Match all messages containing the word "wizard", ignoring case.
 
-       added  Match all messages containing "added", but also those containing
-              "add", "additional", "Additional", "adds", etc... via stemming.
+       added
+          Match all messages containing "added",  but  also  those  containing
+          "add", "additional", "Additional", "adds", etc... via stemming.
 
        (and Bob Marley)
-              Match  messages  containing  words  "Bob" and "Marley", or their
-              stems The words need not be adjacent.
+          Match  messages  containing words "Bob" and "Marley", or their stems
+          The words need not be adjacent.
 
        (not Bob Marley)
-              Match messages containing neither "Bob" nor "Marley", nor  their
-              stems,
+          Match messages containing neither  "Bob"  nor  "Marley",  nor  their
+          stems,
 
        "quick fox" quick-fox quick@fox
-              Match  the phrase "quick" followed by "fox" in phrase fields (or
-              outside a field). Match the literal string in a term field.
+          Match the phrase "quick" followed by "fox" in phrase fields (or out‐
+          side a field). Match the literal string in a term field.
 
        (folder (of (id 1234@invalid)))
-              Match any message in the same folder as the one with  Message-Id
-              "1234@invalid"
+          Match any message in the same folder as the one with  Message-Id  "‐
+          1234@invalid"
 
        (id 1234@invalid blah@test)
-              Matches Message-Id "1234@invalid" or Message-Id "blah@test"
+          Matches Message-Id "1234@invalid" or Message-Id "blah@test"
 
-       (and (infix date:2009-11-18..2009-11-18 ) (tag unread))
-              Match messages in the given date range with tag unread.
+       (and (infix "date:2009-11-18..2009-11-18") (tag unread))
+          Match messages in the given date range with tag unread.
 
        (starts-with prelim)
-              Match any words starting with "prelim".
+          Match any words starting with "prelim".
 
-       (subject quick brown fox )
-              Match   messages   whose  subject  contains  "quick"  (anywhere,
-              stemmed) and the phrase "brown fox".
+       (subject quick "brown fox")
+          Match  messages  whose  subject contains "quick" (anywhere, stemmed)
+          and the phrase "brown fox".
 
        (subject (starts-with prelim))
-              Matches any word starting with "prelim", inside a  message  sub‐
-              ject.
+          Matches any word starting with "prelim", inside a message subject.
 
-       (subject (starts-wih quick) brown fox )
-              Match  messages  whose  subject  contains "quick brown fox", but
-              also "brown fox quicksand".
+       (subject (starts-wih quick) "brown fox")
+          Match messages whose subject contains "quick brown  fox",  but  also
+          "brown fox quicksand".
 
        (thread (of (id 1234@invalid)))
-              Match any message in the same thread as the one with  Message-Id
-              "1234@invalid"
+          Match  any  message in the same thread as the one with Message-Id "‐
+          1234@invalid"
 
        (thread (matching (from bob@example.com) (to bob@example.com)))
-              Match  any  (messages  in) a thread containing a message from "‐
-              bob@example.com" and a (possibly distinct) message  to  "bob  at
-              example.com")
+          Match any (messages in)  a  thread  containing  a  message  from  "‐
+          bob@example.com"  and a (possibly distinct) message to "bob at exam‐
+          ple.com")
 
-       (to  (or bob@example.com mallory@example.org)) (or (to bob@example.com)
+       (to (or bob@example.com mallory@example.org)) (or (to  bob@example.com)
        (to mallory@example.org))
-              Match  in  the  "To"  or  "Cc"  headers,  "bob@example.com",  "‐
-              mallory@example.org",  and  also  "bob@example.com.au"  since it
-              contains the adjacent triple "bob", "example", "com".
+          Match   in   the   "To"   or  "Cc"  headers,  "bob@example.com",  "‐
+          mallory@example.org", and also "bob@example.com.au"  since  it  con‐
+          tains the adjacent triple "bob", "example", "com".
 
        (not (to *))
-              Match messages with an empty or invalid 'To' and 'Cc' field.
+          Match messages with an empty or invalid 'To' and 'Cc' field.
 
        (List *)
-              Match messages with a non-empty List-Id header, assuming config‐
-              uration index.header.List=List-Id
+          Match  messages with a non-empty List-Id header, assuming configura‐
+          tion index.header.List=List-Id

  MACRO EXAMPLES

@@ -253,7 +257,7 @@ $ notmuch config set squery.Outer '(macro (x y) (and (tag ,x) (Inner ,y)))' $ notmuch search --query=sexp '(Outer inbox maildir)' - Parameters can be re-used to reduce boilerplate. Any field, including + Parameters can be re-used to reduce boilerplate. Any field, including user defined fields is permitted within a macro. $ notmuch config set squery.About '(macro (name) (or (subject ,name) (List ,name)))' @@ -262,7 +266,7 @@

NOTES

-       [1]  Technically macros impliment lazy evaluation  and  lexical  scope.
+       [1]  Technically  macros  impliment  lazy evaluation and lexical scope.
             There is one top level scope containing all macro definitions, but
             all parameter definitions are local to a given macro.
 
@@ -272,13 +276,13 @@
 
        [4]  a.k.a. boolean prefixes
 
-       [5]  Due to the implemention of phrase fields in Xapian, regex  queries
+       [5]  Due  to the implemention of phrase fields in Xapian, regex queries
             could only match individual words.
 
-       [6]  Due  the  the way body is implemented in notmuch, this modifier is
+       [6]  Due the the way body is implemented in notmuch, this  modifier  is
             not supported in the body field.
 
-       [7]  Due to the way recursive path queries are implemented in  notmuch,
+       [7]  Due  to the way recursive path queries are implemented in notmuch,
             this modifier is not supported in the path field.
@@ -289,7 +293,7 @@

COPYRIGHT

-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
-

0.34

+

0.35

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn index 74106c1..11278cb 100644 --- a/manpages/notmuch-show-1.mdwn +++ b/manpages/notmuch-show-1.mdwn @@ -33,7 +33,7 @@ --format=(text|json|sexp|mbox|raw) - text (default for messages) + text (default for messages) The default plain-text format has all text-content MIME parts decoded. Various components in the output, (mes- sage, header, body, attachment, and MIME part), will be @@ -70,7 +70,7 @@ is termed "mboxrd" format and described in detail here: http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html - raw (default if --part is given) + raw (default if --part is given) Write the raw bytes of the given MIME part of a message to standard out. For this format, it is an error to spec‐ ify a query that matches more than one message. @@ -210,6 +210,12 @@ seen in the first column of output from the notmuch-search(1) command. +

CONFIGURATION

+
+       Structured  output (json / sexp) is influenced by the configuration op‐
+       tion show.extra_headers. See notmuch-config(1) for details.
+
+

EXIT STATUS

        This command supports the following special exit status codes
@@ -221,8 +227,8 @@
 
 
SEE ALSO

 
-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
-       much-hooks(5),  notmuch-insert(1),  notmuch-new(1),   notmuch-reply(1),
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
+       much-hooks(5),   notmuch-insert(1),  notmuch-new(1),  notmuch-reply(1),
        notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  not‐
        much-tag(1)
 

@@ -234,7 +240,7 @@
 
 
COPYRIGHT

 
-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 

 
-
0.34

+
0.35

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn
index 8673f23..2b3e578 100644
--- a/manpages/notmuch-tag-1.mdwn
+++ b/manpages/notmuch-tag-1.mdwn
@@ -113,7 +113,7 @@
 
 
COPYRIGHT

 
-       2009-2021, Carl Worth and many others
+       2009-2022, Carl Worth and many others
 

 
-
0.34

+
0.35

-- 
2.43.0