From 7ab49d222b1bafd16ce17aa2a8f21648fb3ac8fd Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Sun, 2 May 2021 20:32:34 +0300 Subject: [PATCH] manpages updates for release 0.32 --- manpages.mdwn | 2 +- manpages/notmuch-1.mdwn | 30 ++++--- manpages/notmuch-address-1.mdwn | 24 ++--- manpages/notmuch-compact-1.mdwn | 4 +- manpages/notmuch-config-1.mdwn | 129 +++++++++++++++++---------- manpages/notmuch-count-1.mdwn | 8 +- manpages/notmuch-dump-1.mdwn | 22 ++--- manpages/notmuch-emacs-mua-1.mdwn | 4 +- manpages/notmuch-hooks-5.mdwn | 20 ++--- manpages/notmuch-insert-1.mdwn | 16 ++-- manpages/notmuch-new-1.mdwn | 15 ++-- manpages/notmuch-properties-7.mdwn | 34 +++---- manpages/notmuch-reindex-1.mdwn | 18 ++-- manpages/notmuch-reply-1.mdwn | 22 ++--- manpages/notmuch-restore-1.mdwn | 16 ++-- manpages/notmuch-search-1.mdwn | 34 +++---- manpages/notmuch-search-terms-7.mdwn | 84 ++++++++--------- manpages/notmuch-show-1.mdwn | 46 +++++----- manpages/notmuch-tag-1.mdwn | 8 +- news/release-0.32.mdwn | 3 +- 20 files changed, 288 insertions(+), 251 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index 1269dae..67719ea 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.31

+

0.32

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 0340ca8..d962924 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -31,8 +31,8 @@ it does not provide the most convenient interface for that functional‐ ity. More sophisticated interfaces are expected to be built on top of either the command-line interface, or more likely, on top of the not‐ - much library interface. See https://notmuchmail.org for more about - alternate interfaces to notmuch. The emacs-based interface to notmuch + much library interface. See https://notmuchmail.org for more about al‐ + ternate interfaces to notmuch. The emacs-based interface to notmuch (available under emacs/ in the Notmuch source distribution) is probably the most widely used at this time. @@ -42,15 +42,17 @@ Supported global options for notmuch include --help [command-name] - Print a synopsis of available commands and exit. With an - optional command name, show the man page for that subcommand. + Print a synopsis of available commands and exit. With an op‐ + tional command name, show the man page for that subcommand. --version Print the installed version of notmuch, and exit. --config=FILE Specify the configuration file to use. This overrides any con‐ - figuration file specified by ${NOTMUCH_CONFIG}. + figuration file specified by ${NOTMUCH_CONFIG}. The empty string + is a permitted and sometimes useful value of FILE, which tells + notmuch to use only configuration metadata from the database. --uuid=HEX Enforce that the database UUID (a unique identifier which per‐ @@ -103,8 +105,8 @@ The search, show, address and count commands are used to query the email database. - The reply command is useful for preparing a template for an email - reply. + The reply command is useful for preparing a template for an email re‐ + ply. The tag command is the only command available for manipulating database contents. @@ -147,8 +149,8 @@ set. NOTMUCH_TALLOC_REPORT - Location to write a talloc memory usage report. See tal- - loc_enable_leak_report_full in talloc(3) for more information. + Location to write a talloc memory usage report. See talloc_en- + able_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 @@ -159,9 +161,9 @@ 
        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‐
-       much-search-terms(7), notmuch-show(1), notmuch-tag(1)
+       notmuch-new(1),  notmuch-properties(7), notmuch-reindex(1), notmuch-re‐
+       ply(1), notmuch-restore(1), notmuch-search(1), notmuch-search-terms(7),
+       notmuch-show(1), notmuch-tag(1)
 
        The notmuch website: https://notmuchmail.org
@@ -183,7 +185,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index c2c102d..74ba453 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -27,9 +27,9 @@ available). --format-version=N - Use the specified structured output format version. This is - intended for programs that invoke notmuch(1) internally. If - omitted, the latest supported version will be used. + Use the specified structured output format version. This is in‐ + tended for programs that invoke notmuch(1) internally. If omit‐ + ted, the latest supported version will be used. --output=(sender|recipients|count|address) Controls which information appears in the output. This option @@ -68,15 +68,15 @@ Deduplicate addresses based on the full, case sensitive name and email address, or mailbox. This is effectively the same as piping the --deduplicate=no output to sort | - uniq, except for the order of results. This is the - default. + uniq, except for the order of results. This is the de‐ + fault. address - Deduplicate addresses based on the case insensitive - address part of the mailbox. Of all the variants (with - different name or case), print the one occurring most - frequently among the matching messages. If --output=count - is specified, include all variants in the count. + Deduplicate addresses based on the case insensitive ad‐ + dress part of the mailbox. Of all the variants (with dif‐ + ferent name or case), print the one occurring most fre‐ + quently among the matching messages. If --output=count is + specified, include all variants in the count. --sort=(newest-first|oldest-first) This option can be used to present results in either chronologi‐ @@ -127,7 +127,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index 4f42635..a99cd0e 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -61,7 +61,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index 0373910..c06a307 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -9,7 +9,7 @@ 
        notmuch config get <section>.<item>
 
-       notmuch config set <section>.<item> [value ...]
+       notmuch config set [--database] <section>.<item> [value ...]
 
        notmuch config list
@@ -19,10 +19,6 @@ The config command can be used to get or set settings in the notmuch configuration file and corresponding database. - Items marked [STORED IN DATABASE] are only in the database. They - should not be placed in the configuration file, and should be accessed - programmatically as described in the SYNOPSIS above. - get The value of the specified configuration item is printed to std‐ out. If the item has multiple values (it is a list), each value is separated by a newline character. @@ -34,6 +30,10 @@ If no values are provided, the specified configuration item will be removed from the configuration file. + With the --database option, updates configuration metadata + stored in the database, rather than the default (text) configu‐ + ration file. + list Every configuration item is printed to stdout, each on a sepa‐ rate line of the form: @@ -46,14 +46,26 @@ The available configuration items are described below. database.path - The top-level directory where your mail currently exists and to - where mail will be delivered in the future. Files should be - individual email messages. Notmuch will store its database - within a sub-directory of the path configured here named .not- - much. + Notmuch will store its database here, (in sub-directory named + .notmuch if database.mail_root is unset). Default: $MAILDIR variable if set, otherwise $HOME/mail. + database.mail_root + The top-level directory where your mail currently exists and to + where mail will be delivered in the future. Files should be in‐ + dividual email messages. + + History: this configuration value was introduced in notmuch + 0.32. + + Default: For compatibility with older configurations, the value + of database.path is used if database.mail_root is unset. + + database.hook_dir + Directory containing hooks run by notmuch commands. See not‐ + much-hooks(5). + user.name Your full name. @@ -90,16 +102,16 @@ A regular expression delimited with // that will be matched against the path of the file or directory relative to the data‐ base path. Matching files and directories will be ignored. The - beginning and end of string must be explicitly anchored. For - example, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but + beginning and end of string must be explicitly anchored. For ex‐ + ample, /.*/foo$/ would match "bar/foo" and "bar/baz/foo", but not "foo" or "bar/foobar". Default: empty list. search.exclude_tags - A list of tags that will be excluded from search results by - default. Using an excluded tag in a query will override that - exclusion. + A list of tags that will be excluded from search results by de‐ + fault. Using an excluded tag in a query will override that ex‐ + clusion. Default: empty list. Note that notmuch-setup(1) puts deleted;spam here when creating new configuration file. @@ -136,7 +148,7 @@ Default: true. - index.decrypt [STORED IN DATABASE] + index.decrypt Policy for decrypting encrypted messages during indexing. Must be one of: false, auto, nostash, or true. @@ -152,12 +164,11 @@ 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= - option. + 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: ┌──────────────┬───────┬──────┬─────────┬──────┐ @@ -169,48 +180,48 @@ │sion keys │ │ │ │ │ ├──────────────┼───────┼──────┼─────────┼──────┤ │Index cleart‐ │ │ │ X │ X │ - │ext using │ │ │ │ │ - │secret keys │ │ │ │ │ + │ext using se‐ │ │ │ │ │ + │cret keys │ │ │ │ │ ├──────────────┼───────┼──────┼─────────┼──────┤ │Stash session │ │ │ │ X │ │keys ├──────────────┼───────┼──────┼─────────┼──────┤ │Delete │stashed ses‐ │ │ │ │ │ - │sion keys on │ │ │ │ │ + │sion keys on │ │ │ │ │ │reindex │ │ │ │ │ └──────────────┴───────┴──────┴─────────┴──────┘ - Stashed session keys are kept in the database as properties - associated 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 - 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 in- + dex.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‐ + 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‐ 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 - included.) + "retry_lock" (configure option, included by default). (since + notmuch 0.30, "compact" and "field_processor" are always in‐ + cluded.) - query.<name> [STORED IN DATABASE] - Expansion for named query called <name>. See not‐ + query.<name> + Expansion for named query called <name>. See not‐ much-search-terms(7) for more information about named queries. @@ -220,9 +231,33 @@ of notmuch. NOTMUCH_CONFIG - Specifies the location of the notmuch configuration file. Not‐ - much will use ${HOME}/.notmuch-config if this variable is not - set. + Specifies the location of the notmuch configuration file. + + NOTMUCH_PROFILE + Selects among notmuch configurations. + + +

FILES

+ +

  CONFIGURATION

+
+       If NOTMUCH_CONFIG is unset, notmuch tries (in order)
+
+       • $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is  defined
+         by $NOTMUCH_PROFILE or "default"
+
+       • ${HOME}/.notmuch-config<profile> where <profile> is .$NOTMUCH_PROFILE
+         or ""
+
+ +

  Hooks

+
+       If database.hook_dir is unset, notmuch tries (in order)
+
+       • $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile>  is  defined
+         by $NOTMUCH_PROFILE or "default"
+
+       • <database.path>/.notmuch/hooks

SEE ALSO

@@ -240,7 +275,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index 2c8ef46..c9c20f3 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -27,8 +27,8 @@ --output=(messages|threads|files) messages - Output the number of matching messages. This is the - default. + Output the number of matching messages. This is the de‐ + fault. threads Output the number of matching threads. @@ -74,7 +74,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index bfa1bc8..bb5325c 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -36,8 +36,8 @@ one message-id per line, followed by a list of tags. batch-tag - The default batch-tag dump format is intended to more - robust against malformed message-ids and tags containing + The default batch-tag dump format is intended to more ro‐ + bust against malformed message-ids and tags containing whitespace or non-ascii(7) characters. Each line has the form: @@ -49,8 +49,8 @@ query, quoted using Xapian boolean term quoting rules: if the ID contains whitespace or a close paren or starts with a double quote, it must be enclosed in double quotes - and double quotes inside the ID must be doubled. The - astute reader will notice this is a special case of the + and double quotes inside the ID must be doubled. The as‐ + tute reader will notice this is a special case of the batch input format for notmuch-tag(1); note that the sin‐ gle message-id query is mandatory for notmuch-restore(1). @@ -86,8 +86,8 @@ tags Output per-message boolean metadata, namely tags. See format above for description of the output. - The default is to include all available types of data. The - option can be specified multiple times to select some subset. As + The default is to include all available types of data. The op‐ + tion can be specified multiple times to select some subset. As of version 3 of the dump format, there is a header line of the following form: @@ -102,9 +102,9 @@

SEE ALSO

        notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-hooks(5), not‐
-       much-insert(1),     notmuch-new(1),     notmuch-properties(7),     not‐
-       much-reply(1),     notmuch-restore(1),     notmuch-search(1),      not‐
-       much-search-terms(7), notmuch-show(1), notmuch-tag(1)
+       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)

AUTHOR

@@ -114,7 +114,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn index 17e0236..39d5352 100644 --- a/manpages/notmuch-emacs-mua-1.mdwn +++ b/manpages/notmuch-emacs-mua-1.mdwn @@ -89,7 +89,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 864fffe..931ea8a 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -7,31 +7,31 @@

SYNOPSIS

-       $DATABASEDIR/.notmuch/hooks/*
+       <hook_dir>/{pre-new, post-new, post-insert}

DESCRIPTION

        Hooks  are  scripts (or arbitrary executables or symlinks to such) that
        notmuch invokes before and after certain actions. These scripts  reside
-       in  the .notmuch/hooks directory within the database directory and must
+       in  a  directory  defined  as described in notmuch-config(1). They must
        have executable permissions.
 
        The currently available hooks are described below.
 
        pre-new
-              This hook is invoked by  the  new  command  before  scanning  or
-              importing  new  messages  into  the database. If this hook exits
-              with a non-zero status, notmuch will abort further processing of
-              the new command.
+              This hook is invoked by the new command before scanning  or  im‐
+              porting  new messages into the database. If this hook exits with
+              a non-zero status, notmuch will abort further processing of  the
+              new command.
 
               Typically  this hook is used for fetching or delivering new mail
               to be imported into the database.
 
        post-new
               This hook is invoked by the new command after new messages  have
-              been  imported  into  the  database  and  initial tags have been
-              applied. The hook will not be run if there have been any  errors
+              been  imported  into the database and initial tags have been ap‐
+              plied. The hook will not be run if there have  been  any  errors
               during the scan or import.
 
               Typically  this  hook  is used to perform additional query-based
@@ -63,7 +63,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn
index 3a0349f..8ae7151 100644
--- a/manpages/notmuch-insert-1.mdwn
+++ b/manpages/notmuch-insert-1.mdwn
@@ -26,16 +26,16 @@
        base (it has same Message-ID), it will be added to the  maildir  folder
        and notmuch database, but the tags will not be changed.
 
-       The  insert  command  supports  hooks.  See  notmuch-hooks(5)  for more
-       details on hooks.
+       The  insert  command  supports hooks. See notmuch-hooks(5) for more de‐
+       tails on hooks.
 
        Option arguments must appear before any tag operation arguments.   Sup‐
        ported options for insert include
 
        --folder=<folder>
               Deliver  the  message  to  the specified folder, relative to the
-              top-level directory given by the  value  of  database.path.  The
-              default  is  the  empty  string,  which  means delivering 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.
 
        --create-folder
@@ -73,8 +73,8 @@
               sion key is certainly sufficient) to reconstruct  the  cleartext
               of the message itself, so please ensure that the notmuch message
               index is adequately protected.  DO  NOT  USE  --decrypt=true  or
-              --decrypt=nostash  without  considering  the  security  of  your
-              index.
+              --decrypt=nostash  without  considering the security of your in‐
+              dex.
 
               See also index.decrypt in notmuch-config(1).
@@ -113,7 +113,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index 8d86c59..004e325 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -58,15 +58,14 @@ Be aware that the index is likely sufficient (and the session key is certainly sufficient) to reconstruct the cleartext of the message itself, so please ensure that the notmuch message index - is adequately protected. DO NOT USE --decrypt=true or - --decrypt=nostash without considering the security of your - index. + is adequately protected. DO NOT USE --decrypt=true or --de- + crypt=nostash without considering the security of your index. See also index.decrypt in notmuch-config(1). --full-scan - By default notmuch-new uses directory modification times - (mtimes) to optimize the scanning of directories for new mail. + By default notmuch-new uses directory modification times + (mtimes) to optimize the scanning of directories for new mail. This option turns that optimization off. @@ -80,7 +79,7 @@

SEE ALSO

-       notmuch(1),  notmuch-config(1), notmuch-count(1), notmuch-dump(1), not‐
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
        much-hooks(5), notmuch-insert(1), notmuch-reply(1), notmuch-restore(1),
        notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -93,7 +92,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-properties-7.mdwn b/manpages/notmuch-properties-7.mdwn
index 0e94e5b..f613125 100644
--- a/manpages/notmuch-properties-7.mdwn
+++ b/manpages/notmuch-properties-7.mdwn
@@ -57,13 +57,13 @@
        index.decryption
               If  a  message  contains encrypted content, and notmuch tries to
               decrypt that content during indexing, it will add  the  property
-              index.decryption=success  when  the  cleartext  was successfully
-              indexed.  If notmuch attempts to decrypt any part of  a  message
+              index.decryption=success when the cleartext was successfully in‐
+              dexed.  If notmuch attempts to decrypt any  part  of  a  message
               during  indexing  and that decryption attempt fails, it will add
               the property index.decryption=failure to the message.
 
-              Note that it's possible  for  a  single  message  to  have  both
-              index.decryption=success and index.decryption=failure.  Consider
+              Note that it's possible for a single message to  have  both  in-
+              dex.decryption=success  and  index.decryption=failure.  Consider
               an encrypted e-mail  message  that  contains  another  encrypted
               e-mail  message  as an attachment -- if the outer message can be
               decrypted, but the attached part cannot,  then  both  properties
@@ -84,13 +84,13 @@
           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
-          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  decrypt  any
-          copy of the original message previously stored by an adversary.
+          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.
@@ -115,8 +115,8 @@
           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.
+          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
@@ -124,8 +124,8 @@
           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‐
+          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.
@@ -145,7 +145,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-reindex-1.mdwn b/manpages/notmuch-reindex-1.mdwn
index e5618b0..5ddf2bb 100644
--- a/manpages/notmuch-reindex-1.mdwn
+++ b/manpages/notmuch-reindex-1.mdwn
@@ -18,8 +18,8 @@
        <search-term>.
 
        The reindex command searches for all  messages  matching  the  supplied
-       search  terms,  and  re-creates  the  full-text index on these messages
-       using the supplied options.
+       search  terms, and re-creates the full-text index on these messages us‐
+       ing the supplied options.
 
        Supported options for reindex include
 
@@ -41,8 +41,8 @@
               sion key is certainly sufficient) to reconstruct  the  cleartext
               of the message itself, so please ensure that the notmuch message
               index is adequately protected.  DO  NOT  USE  --decrypt=true  or
-              --decrypt=nostash  without  considering  the  security  of  your
-              index.
+              --decrypt=nostash  without  considering the security of your in‐
+              dex.
 
               See also index.decrypt in notmuch-config(1).
@@ -58,9 +58,9 @@ A user wants to change their policy going forward to start indexing cleartext. But they also want indexed access to the cleartext of all - previously-received encrypted messages. Some messages might have - already been indexed in the clear (as in the example above). They can - ask notmuch to just reindex the not-yet-indexed messages: + previously-received encrypted messages. Some messages might have al‐ + ready been indexed in the clear (as in the example above). They can ask + notmuch to just reindex the not-yet-indexed messages: notmuch config set index.decrypt true notmuch reindex tag:encrypted and not property:index.decryption=success @@ -91,7 +91,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 54a3a17..84c06bf 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -43,11 +43,11 @@ json Produces JSON output containing headers for a reply mes‐ sage and the contents of the original message. This out‐ - put can be used by a client to create a reply message - intelligently. + put can be used by a client to create a reply message in‐ + telligently. - sexp Produces S-Expression output containing headers for a - reply message and the contents of the original message. + sexp Produces S-Expression output containing headers for a re‐ + ply message and the contents of the original message. This output can be used by a client to create a reply message intelligently. @@ -56,9 +56,9 @@ headers. --format-version=N - Use the specified structured output format version. This is - intended for programs that invoke notmuch(1) internally. If - omitted, the latest supported version will be used. + Use the specified structured output format version. This is in‐ + tended for programs that invoke notmuch(1) internally. If omit‐ + ted, the latest supported version will be used. --reply-to=(all|sender) @@ -79,8 +79,8 @@ part will be replaced by the decrypted content. If auto, and a session key is already known for the message, then it - will be decrypted, but notmuch will not try to access the user's - secret keys. + will be decrypted, but notmuch will not try to access the user's se‐ + cret keys. Use false to avoid even automatic decryption. @@ -126,7 +126,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index c394afe..2c1bb69 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -8,8 +8,8 @@

SYNOPSIS

-       notmuch    restore    [--accumulate]    [--format=(auto|batch-tag|sup)]
-       [--input=<filename>]
+       notmuch restore [--accumulate]  [--format=(auto|batch-tag|sup)]  [--in‐
+       put=<filename>]

DESCRIPTION

@@ -44,8 +44,8 @@ notmuch restore updates the maildir flags according to tag changes if the maildir.synchronize_flags configura‐ - tion option is enabled. See notmuch-config(1) for - details. + tion option is enabled. See notmuch-config(1) for de‐ + tails. auto This option (the default) tries to guess the format from the input. For correctly formed input in either supported @@ -70,8 +70,8 @@ tags Restore per-message metadata, namely tags. See format above for more details. - The default is to restore all available types of data. The - option can be specified multiple times to select some subset. + The default is to restore all available types of data. The op‐ + tion can be specified multiple times to select some subset. --input=<filename> Read input from given file instead of stdin. @@ -99,7 +99,7 @@

COPYRIGHT

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

0.31

+

0.32

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 8146d9c..731a611 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -12,8 +12,8 @@

DESCRIPTION

-       Search  for  messages  matching  the given search terms, and display as
-       results the threads containing the matched messages.
+       Search for messages matching the given search terms, and display as re‐
+       sults the threads containing the matched messages.
 
        The output consists of one line per thread, giving  a  thread  ID,  the
        date  of  the  newest (or oldest, depending on the sort option) matched
@@ -33,9 +33,9 @@
               available).
 
        --format-version=N
-              Use the specified structured  output  format  version.  This  is
-              intended  for  programs  that  invoke  notmuch(1) internally. If
-              omitted, the latest supported version will be used.
+              Use the specified structured output format version. This is  in‐
+              tended  for programs that invoke notmuch(1) internally. If omit‐
+              ted, the latest supported version will be used.
 
        --output=(summary|threads|messages|files|tags)
 
@@ -46,8 +46,8 @@
                      ber  matched  and  the  total number), the authors of the
                      thread and the subject. In the case where a  thread  con‐
                      tains  multiple files for some messages, the total number
-                     of files is printed in  parentheses  (see  below  for  an
-                     example).
+                     of files is printed in parentheses (see below for an  ex‐
+                     ample).
 
               threads
                      Output  the  thread  IDs  of all threads with any message
@@ -59,8 +59,8 @@
               messages
                      Output  the  message  IDs  of  all  messages matching the
                      search terms, either one per line (--format=text),  sepa‐
-                     rated  by  null  characters  (--format=text0),  as a JSON
-                     array (--format=json), or as an S-Expression list (--for-
+                     rated  by null characters (--format=text0), as a JSON ar‐
+                     ray (--format=json), or as an S-Expression  list  (--for-
                      mat=sexp).
 
               files  Output  the filenames of all messages matching the search
@@ -79,8 +79,8 @@
 
               tags   Output  all  tags that appear on any message matching the
                      search terms, either one per line (--format=text),  sepa‐
-                     rated  by  null  characters  (--format=text0),  as a JSON
-                     array (--format=json), or as an S-Expression list (--for-
+                     rated  by null characters (--format=text0), as a JSON ar‐
+                     ray (--format=json), or as an S-Expression  list  (--for-
                      mat=sexp).
 
        --sort=(newest-first|oldest-first)
@@ -88,8 +88,8 @@
               cal order (oldest-first) or reverse  chronological  order  (new-
               est-first).
 
-              Note:  The  thread  order  will  be  distinct  between these two
-              options (beyond being simply reversed).  When  sorting  by  old-
+              Note:  The  thread  order will be distinct between these two op‐
+              tions (beyond being  simply  reversed).  When  sorting  by  old-
               est-first  the  threads  will be sorted by the oldest message in
               each thread, but when sorting by newest-first the  threads  will
               be sorted by the newest message in each thread.
@@ -114,8 +114,8 @@
                      Prevent excluded messages from matching the search terms.
 
               all    Additionally prevent excluded messages from appearing  in
-                     displayed  results,  in  effect  behaving  as  though the
-                     excluded messages do not exist.
+                     displayed  results,  in effect behaving as though the ex‐
+                     cluded messages do not exist.
 
               false  Allow excluded messages to match search terms and  appear
                      in  displayed results. Excluded messages are still marked
@@ -176,7 +176,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn
index d6d3241..a2e11ef 100644
--- a/manpages/notmuch-search-terms-7.mdwn
+++ b/manpages/notmuch-search-terms-7.mdwn
@@ -30,8 +30,8 @@
        terms/phrases in the body, the subject, or any of the sender or recipi‐
        ent headers.
 
-       As  a  special  case,  a  search  string consisting of exactly a single
-       asterisk ("*") will match all messages.
+       As  a  special case, a search string consisting of exactly a single as‐
+       terisk ("*") will match all messages.

  Search prefixes

@@ -107,8 +107,8 @@ specified relative to the top-level maildir (and without the leading slash). By default, path: matches messages in the speci‐ fied directory only. The "/**" suffix can be used to match mes‐ - sages in the specified directory and all its subdirectories - recursively. path:"" matches messages in the root of the mail + sages in the specified directory and all its subdirectories re‐ + cursively. path:"" matches messages in the root of the mail store and, likewise, path:** matches all messages. path: will find a message if any copy of that message is in the @@ -120,8 +120,8 @@ maildir, this includes messages in the "new" and "cur" subdirec‐ tories. The exact syntax for maildir folders depends on your mail configuration. For maildir++, folder:"" matches the inbox - folder (which is the root in maildir++), other folder names - always start with ".", and nested folders are separated by "."s, + folder (which is the root in maildir++), other folder names al‐ + ways start with ".", and nested folders are separated by "."s, such as folder:.classes.topology. For "file system" maildir, the inbox is typically folder:INBOX and nested folders are separated by slashes, such as folder:classes/topology. @@ -165,8 +165,8 @@ key can be present on a given message with several different values. See notmuch-properties(7) for more details. - User defined prefixes are also supported, see notmuch-config(1) for - details. + User defined prefixes are also supported, see notmuch-config(1) for de‐ + tails.

  Operators

@@ -216,8 +216,8 @@ There are two ways to turn this off: a search for a capitalized word will be performed unstemmed, so that one can search for "John" and not - get results for "Johnson"; phrase searches are also unstemmed (see - below for details). Stemming is currently only supported for English. + get results for "Johnson"; phrase searches are also unstemmed (see be‐ + low for details). Stemming is currently only supported for English. Searches for words in other languages will be performed unstemmed. @@ -229,10 +229,10 @@

  Boolean and Probabilistic Prefixes

-       Xapian  (and  hence  notmuch)  prefixes  are either boolean, supporting
-       exact matches like "tag:inbox"  or  probabilistic,  supporting  a  more
-       flexible  term  based searching. Certain special prefixes are processed
-       by notmuch in a way not strictly fitting either of  Xapian's  built  in
+       Xapian  (and hence notmuch) prefixes are either boolean, supporting ex‐
+       act matches like "tag:inbox" or probabilistic, supporting a more flexi‐
+       ble  term  based  searching.  Certain special prefixes are processed by
+       notmuch in a way not strictly  fitting  either  of  Xapian's  built  in
        styles. The prefixes currently supported by notmuch are as follows.
 
        Boolean
@@ -253,13 +253,13 @@
        occur in that order. One useful, but initially  surprising  feature  is
        that the following are equivalent ways to write the same phrase.
 
-       · "a list of words"
+       • "a list of words"
 
-       · a-list-of-words
+       • a-list-of-words
 
-       · a/list/of/words
+       • a/list/of/words
 
-       · a.list.of.words
+       • a.list.of.words
 
        Both parenthesised lists of terms and quoted phrases are ok with proba‐
        bilistic prefixes such as to:, from:, and subject:. In particular
@@ -325,8 +325,8 @@
        since 1970-01-01 00:00:00 UTC. For example:
           date:@<initial-timestamp>..@<final-timestamp>
 
-       Currently, spaces in range  expressions  are  not  supported.  You  can
-       replace the spaces with '_', or (in most cases) '-', or (in some cases)
+       Currently, spaces in range expressions are not supported. You  can  re‐
+       place  the  spaces with '_', or (in most cases) '-', or (in some cases)
        leave the spaces out altogether. Examples in this man page  use  spaces
        for clarity.
 
@@ -352,8 +352,8 @@
        Units can be abbreviated to any length, with  the  otherwise  ambiguous
        single m being m for minutes and M for months.
 
-       Number  can  also  be  written  out one, two, ..., ten, dozen, hundred.
-       Additionally, the unit may be preceded by "last" or "this" (e.g., "last
+       Number can also be written out one, two, ..., ten, dozen, hundred.  Ad‐
+       ditionally, the unit may be preceded by "last" or "this"  (e.g.,  "last
        week" or "this month").
 
        When  combined  with absolute date and time, the relative date and time
@@ -365,40 +365,40 @@
 
 
   Supported absolute time formats

 
-       · H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
+       • H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
 
-       · H[H] (am|a.m.|pm|p.m.)
+       • H[H] (am|a.m.|pm|p.m.)
 
-       · HHMMSS
+       • HHMMSS
 
-       · now
+       • now
 
-       · noon
+       • noon
 
-       · midnight
+       • midnight
 
-       · Examples: 17:05, 5pm
+       • Examples: 17:05, 5pm
 

 
 
   Supported absolute date formats

 
-       · YYYY-MM[-DD]
+       • YYYY-MM[-DD]
 
-       · DD-MM[-[YY]YY]
+       • DD-MM[-[YY]YY]
 
-       · MM-YYYY
+       • MM-YYYY
 
-       · M[M]/D[D][/[YY]YY]
+       • M[M]/D[D][/[YY]YY]
 
-       · M[M]/YYYY
+       • M[M]/YYYY
 
-       · D[D].M[M][.[YY]YY]
+       • D[D].M[M][.[YY]YY]
 
-       · D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
+       • D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
 
-       · Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
+       • Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
 
-       · Wee[kday]
+       • Wee[kday]
 
        Month names can be abbreviated at three or more characters.
 
@@ -409,9 +409,9 @@
 
 
   Time zones

 
-       · (+|-)HH:MM
+       • (+|-)HH:MM
 
-       · (+|-)HH[MM]
+       • (+|-)HH[MM]
 
        Some time zone codes, e.g. UTC, EET.
 

@@ -431,7 +431,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn
index ac528a4..4a3831a 100644
--- a/manpages/notmuch-show-1.mdwn
+++ b/manpages/notmuch-show-1.mdwn
@@ -28,8 +28,8 @@
        --entire-thread=(true|false)
               If true, notmuch show outputs all messages in the thread of  any
               message matching the search terms; if false, it outputs only the
-              matching messages.  For  --format=json  and  --format=sexp  this
-              defaults to true. For other formats, this defaults to false.
+              matching messages. For --format=json and --format=sexp this  de‐
+              faults to true. For other formats, this defaults to false.
 
        --format=(text|json|sexp|mbox|raw)
 
@@ -48,8 +48,8 @@
                      for automated processing. The nested structure of  multi‐
                      part MIME messages is reflected in nested JSON output. By
                      default JSON output includes all messages in  a  matching
-                     thread;   that   is,   by   default,  --format=json  sets
-                     --entire-thread. The caller can disable this behaviour by
+                     thread;  that  is,  by  default, --format=json sets --en-
+                     tire-thread. The caller can  disable  this  behaviour  by
                      setting --entire-thread=false.  The JSON output is always
                      encoded as UTF-8 and any message content included in  the
                      output will be charset-converted to UTF-8.
@@ -88,9 +88,9 @@
                      decoding and similar functions.
 
        --format-version=N
-              Use  the  specified  structured  output  format version. This is
-              intended for programs  that  invoke  notmuch(1)  internally.  If
-              omitted, the latest supported version will be used.
+              Use  the specified structured output format version. This is in‐
+              tended for programs that invoke notmuch(1) internally. If  omit‐
+              ted, the latest supported version will be used.
 
        --part=N
               Output  the  single decoded MIME part N of a single message. The
@@ -112,11 +112,11 @@
 
        --decrypt=(false|auto|true|stash)
               If  true, decrypt any MIME encrypted parts found in the selected
-              content  (e.g.,  "multipart/encrypted"  parts).  Status  of  the
-              decryption  will  be  reported  (currently  only  supported with
-              --format=json and --format=sexp) and  on  successful  decryption
-              the  multipart/encrypted  part will be replaced by the decrypted
-              content.
+              content (e.g., "multipart/encrypted" parts). Status of  the  de‐
+              cryption  will be reported (currently only supported with --for-
+              mat=json and --format=sexp) and  on  successful  decryption  the
+              multipart/encrypted  part will be replaced by the decrypted con‐
+              tent.
 
               stash behaves like true, but upon successful decryption it  will
               also  stash the message's session key in the database, and index
@@ -164,16 +164,16 @@
               Default: auto
 
        --exclude=(true|false)
-              Specify     whether    to    omit    threads    only    matching
-              search.exclude_tags from the search  results  (the  default)  or
-              not. In either case the excluded message will be marked with the
-              exclude flag (except when output=mbox when there is  nowhere  to
-              put the flag).
+              Specify   whether  to  omit  threads  only  matching  search.ex‐
+              clude_tags from the search results (the default) or not. In  ei‐
+              ther  case  the excluded message will be marked with the exclude
+              flag (except when output=mbox when there is nowhere to  put  the
+              flag).
 
-              If  --entire-thread  is  specified  then  complete  threads  are
-              returned regardless (with  the  excluded  flag  being  set  when
-              appropriate)  but threads that only match in an excluded message
-              are not returned when --exclude=true.
+              If  --entire-thread  is  specified then complete threads are re‐
+              turned regardless (with the excluded flag being set when  appro‐
+              priate)  but  threads that only match in an excluded message are
+              not returned when --exclude=true.
 
               The default is --exclude=true.
 
@@ -222,7 +222,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn
index 41de383..e10b979 100644
--- a/manpages/notmuch-tag-1.mdwn
+++ b/manpages/notmuch-tag-1.mdwn
@@ -36,8 +36,8 @@
        Supported options for tag include
 
        --remove-all
-              Remove all tags from each  message  matching  the  search  terms
-              before  applying  the tag changes appearing on the command line.
+              Remove all tags from each message matching the search terms  be‐
+              fore  applying  the  tag  changes appearing on the command line.
               This means setting the tags of each message to the  tags  to  be
               added.  If there are no tags to be added, the messages will have
               no tags.
@@ -113,7 +113,7 @@
 
 
COPYRIGHT

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

 
-
0.31

+
0.32

diff --git a/news/release-0.32.mdwn b/news/release-0.32.mdwn
index d600f4a..4537703 100644
--- a/news/release-0.32.mdwn
+++ b/news/release-0.32.mdwn
@@ -36,7 +36,8 @@ The previously severe slowdowns from large numbers calls to
 notmuch_database_remove_message or notmuch_message_delete in one
 session has been fixed.
 
-### As always, the canonical source of API documentation is `lib/notmuch.h`, or the doxygen formatted documentation in `notmuch(3)`
+As always, the canonical source of API documentation is `lib/notmuch.h`,
+or the doxygen formatted documentation in `notmuch(3)`.
 
 CLI
 ---
-- 
2.43.0