From 85fe2a1e7df8ccbb172ebf5f10e3cf574a08944a Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Sat, 4 Sep 2021 23:56:10 +0300 Subject: [PATCH] manpages updates for release 0.33 --- manpages.mdwn | 2 +- manpages/notmuch-1.mdwn | 60 +++++++------ manpages/notmuch-address-1.mdwn | 10 +-- manpages/notmuch-compact-1.mdwn | 17 +--- manpages/notmuch-config-1.mdwn | 123 +++++++++++++++++---------- manpages/notmuch-count-1.mdwn | 2 +- manpages/notmuch-dump-1.mdwn | 12 +-- manpages/notmuch-emacs-mua-1.mdwn | 14 +-- manpages/notmuch-hooks-5.mdwn | 28 +++--- manpages/notmuch-insert-1.mdwn | 8 +- manpages/notmuch-new-1.mdwn | 10 +-- manpages/notmuch-properties-7.mdwn | 12 +-- manpages/notmuch-reindex-1.mdwn | 2 +- manpages/notmuch-reply-1.mdwn | 49 +++++------ manpages/notmuch-restore-1.mdwn | 4 +- manpages/notmuch-search-1.mdwn | 14 +-- manpages/notmuch-search-terms-7.mdwn | 121 +++++++++++++------------- manpages/notmuch-show-1.mdwn | 80 +++++++++-------- manpages/notmuch-tag-1.mdwn | 2 +- 19 files changed, 309 insertions(+), 261 deletions(-) diff --git a/manpages.mdwn b/manpages.mdwn index 67719ea..da4254a 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.32

+

0.33

diff --git a/manpages/notmuch-1.mdwn b/manpages/notmuch-1.mdwn index 355d9c4..0c353ee 100644 --- a/manpages/notmuch-1.mdwn +++ b/manpages/notmuch-1.mdwn @@ -50,9 +50,9 @@ --config=FILE Specify the configuration file to use. This overrides any con‐ - 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. + figuration file specified by NOTMUCH_CONFIG. The empty string is + a permitted and sometimes useful value of FILE, which tells not- + much to use only configuration metadata from the database. --uuid=HEX Enforce that the database UUID (a unique identifier which per‐ @@ -76,7 +76,7 @@ The setup command will prompt for your full name, your primary email address, any alternate email addresses you use, and the directory con‐ taining your email archives. Your answers will be written to a configu‐ - ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config . + ration file in NOTMUCH_CONFIG (if set) or ${HOME}/.notmuch-config . This configuration file will be created with descriptive comments, mak‐ ing it easy to edit by hand later to change the configuration. Or you can run notmuch setup again to change the configuration. @@ -90,7 +90,7 @@ Mail storage that uses mbox format, (where one mbox file contains many messages), will not work with notmuch. If that's how your mail is cur‐ rently stored, it is recommended you first convert it to maildir format - with a utility such as mb2md before running notmuch setup . + with a utility such as mb2md(1) before running notmuch setup. Invoking notmuch with no command argument will run setup if the setup command has not previously been completed. @@ -99,38 +99,39 @@

  OTHER COMMANDS

        Several  of the notmuch commands accept search terms with a common syn‐
-       tax. See notmuch-search-terms(7) for more details on the supported syn‐
+       tax. See notmuch-search-terms(7) for more details on the supported syn‐
        tax.
 
-       The  search,  show,  address  and  count commands are used to query the
-       email database.
+       The  notmuch-search(1),  notmuch-show(1),  notmuch-address(1)  and not‐
+       much-count(1) commands are used to query the email database.
 
-       The reply command is useful for preparing a template for an  email  re‐
-       ply.
+       The notmuch-reply(1) command is useful for preparing a template for  an
+       email reply.
 
-       The tag command is the only command available for manipulating database
-       contents.
+       The notmuch-tag(1) command is the only command available for manipulat‐
+       ing database contents.
 
-       The dump and restore commands can be used to create a textual  dump  of
-       email tags for backup purposes, and to restore from that dump.
+       The notmuch-dump(1) and notmuch-restore(1) commands can be used to cre‐
+       ate  a  textual  dump of email tags for backup purposes, and to restore
+       from that dump.
 
-       The  config  command  can be used to get or set settings in the notmuch
-       configuration file.
+       The notmuch-config(1) command can be used to get or set settings in the
+       notmuch configuration file.

  CUSTOM COMMANDS

-       If the given command is not known to notmuch, notmuch tries to  execute
-       the external notmuch-<subcommand> in ${PATH} instead. This allows users
-       to have their own notmuch related tools to be run via the notmuch  com‐
-       mand. By design, this does not allow notmuch's own commands to be over‐
-       ridden using external commands.
+       If  the given command is not known to notmuch, notmuch tries to execute
+       the external notmuch-<subcommand> in PATH instead. This allows users to
+       have their own notmuch related tools to be run via the notmuch command.
+       By design, this does not allow notmuch's own commands to be  overridden
+       using external commands.

  OPTION SYNTAX

        All options accepting an argument can be used with '=' or ':' as a sep‐
-       arator.  Except for boolean options (which would be ambiguous), a space
+       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
@@ -144,9 +145,16 @@
        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.  See
+              notmuch-config(1) for details.
+
+       NOTMUCH_DATABASE
+              Specifies the location of the notmuch database. See notmuch-con‐
+              fig(1) for details.
+
+       NOTMUCH_PROFILE
+              Selects among notmuch configurations. See notmuch-config(1)  for
+              details.
 
        NOTMUCH_TALLOC_REPORT
               Location  to  write a talloc memory usage report. See talloc_en-
@@ -188,4 +196,4 @@
        2009-2021, Carl Worth and many others
-

0.32

+

0.33

diff --git a/manpages/notmuch-address-1.mdwn b/manpages/notmuch-address-1.mdwn index 74ba453..4f5d9b9 100644 --- a/manpages/notmuch-address-1.mdwn +++ b/manpages/notmuch-address-1.mdwn @@ -20,7 +20,7 @@ Supported options for address include - --format=(json|sexp|text|text0) + --format=(json|sexp|text|text0) Presents the results in either JSON, S-Expressions, newline character separated plain-text (default), or null character sep‐ arated plain-text (compatible with xargs(1) -0 option where @@ -78,7 +78,7 @@ quently among the matching messages. If --output=count is specified, include all variants in the count. - --sort=(newest-first|oldest-first) + --sort=(newest-first|oldest-first) This option can be used to present results in either chronologi‐ cal order (oldest-first) or reverse chronological order (new- est-first). @@ -116,8 +116,8 @@ 
        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-terms(7),   notmuch-show(1),  not‐
-       much-tag(1), notmuch-search(1)
+       notmuch-restore(1),  notmuch-search(1),  notmuch-search-terms(7),  not‐
+       much-show(1), notmuch-tag(1)

AUTHOR

@@ -130,4 +130,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-compact-1.mdwn b/manpages/notmuch-compact-1.mdwn index a99cd0e..9d98415 100644 --- a/manpages/notmuch-compact-1.mdwn +++ b/manpages/notmuch-compact-1.mdwn @@ -35,21 +35,10 @@ Do not report database compaction progress to stdout. -

ENVIRONMENT

-
-       The following environment variables can be used to control the behavior
-       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.
-
-

SEE ALSO

-       notmuch(1), notmuch-count(1), notmuch-dump(1),  notmuch-hooks(5),  not‐
-       much-insert(1),  notmuch-new(1),  notmuch-reply(1), notmuch-restore(1),
+       notmuch(1),  notmuch-count(1),  notmuch-dump(1), notmuch-hooks(5), not‐
+       much-insert(1), notmuch-new(1),  notmuch-reply(1),  notmuch-restore(1),
        notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -64,4 +53,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-config-1.mdwn b/manpages/notmuch-config-1.mdwn index c06a307..6ffaba6 100644 --- a/manpages/notmuch-config-1.mdwn +++ b/manpages/notmuch-config-1.mdwn @@ -43,28 +43,50 @@ acters. In a multiple-value item (a list), the values are sepa‐ rated by semicolon characters. - The available configuration items are described below. + The available configuration items are described below. Non-absolute + paths are presumed relative to $HOME for items in section database. database.path - Notmuch will store its database here, (in sub-directory named + 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. + Default: see DATABASE LOCATION 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‐ + 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 + History: this configuration value was introduced in notmuch 0.32. - Default: For compatibility with older configurations, the value + Default: For compatibility with older configurations, the value of database.path is used if database.mail_root is unset. + database.backup_dir + Directory to store tag dumps when upgrading database. + + History: this configuration value was introduced in notmuch + 0.32. + + Default: A sibling directory of the Xapian database called back‐ + ups. + database.hook_dir - Directory containing hooks run by notmuch commands. See not‐ - much-hooks(5). + Directory containing hooks run by notmuch commands. See not‐ + much-hooks(5). + + History: this configuration value was introduced in notmuch + 0.32. + + Default: See HOOKS, below. + + database.autocommit + How often to commit transactions to disk. 0 means wait until command + completes, otherwise an integer n specifies to commit to disk after + every n completed transactions. + + History: this configuration value was introduced in notmuch 0.33. user.name Your full name. @@ -90,8 +112,8 @@ new.ignore A list to specify files and directories that will not be - searched for messages by notmuch new. Each entry in the list is - either: + searched for messages by notmuch-new(1). Each entry in the list + is either: A file or a directory name, without path, that will be ignored, regardless of the location in the mail store directory hierar‐ @@ -135,16 +157,16 @@ │ │ flag is not present) │ └─────┴────────────────────────────┘ - The notmuch new command will notice flag changes in filenames - and update tags, while the notmuch tag and notmuch restore com‐ - mands will notice tag changes and update flags in filenames. + The notmuch-new(1) command will notice flag changes in filenames + 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, - etc.), it is advisable to run notmuch new before notmuch tag or - notmuch restore 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. + 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 + commands expect the database and maildir to be in sync. Default: true. @@ -173,7 +195,8 @@ ┌──────────────┬───────┬──────┬─────────┬──────┐ │ │ false │ auto │ nostash │ true │ - ├──────────────┼───────┼──────┼─────────┼──────┤ + └──────────────┴───────┴──────┴─────────┴──────┘ + │Index cleart‐ │ │ X │ X │ X │ │ext using │ │ │ │ │ │stashed ses‐ │ │ │ │ │ @@ -225,47 +248,61 @@ much-search-terms(7) for more information about named queries. -

ENVIRONMENT

+

FILES

+ +

  CONFIGURATION

-       The following environment variables can be used to control the behavior
-       of notmuch.
+       Notmuch configuration file search order:
 
-       NOTMUCH_CONFIG
-              Specifies the location of the notmuch configuration file.
+       1. File specified by notmuch --config global option; see notmuch(1).
 
-       NOTMUCH_PROFILE
-              Selects among notmuch configurations.
-
+ 2. File specified by NOTMUCH_CONFIG environment variable. -

FILES

+ 3. $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is defined + by NOTMUCH_PROFILE environment variable if set, $XDG_CON- + FIG_HOME/notmuch/default/config otherwise. -

  CONFIGURATION

+ 4. $HOME/.notmuch-config.<profile> where <profile> is defined by NOT- + MUCH_PROFILE environment variable if set, $HOME/.notmuch-config oth‐ + erwise. + + +

  DATABASE LOCATION

-       If NOTMUCH_CONFIG is unset, notmuch tries (in order)
+       Notmuch database search order:
+
+       1. Directory specified by NOTMUCH_DATABASE environment variable.
 
-       • $XDG_CONFIG_HOME/notmuch/<profile>/config where <profile> is  defined
-         by $NOTMUCH_PROFILE or "default"
+       2. Directory specified by config key database.path.
 
-       • ${HOME}/.notmuch-config<profile> where <profile> is .$NOTMUCH_PROFILE
-         or ""
+       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.
+
+       4. Directory specified by MAILDIR environment variable.
+
+       5. $HOME/mail
-

  Hooks

+

  HOOKS

-       If database.hook_dir is unset, notmuch tries (in order)
+       Notmuch hook directory search order:
+
+       1. Directory specified by database.hook_dir configuration option.
 
-       • $XDG_CONFIG_HOME/notmuch/<profile>/hooks where <profile>  is  defined
-         by $NOTMUCH_PROFILE or "default"
+       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.
 
-       • <database.path>/.notmuch/hooks
+       3. <database.path>/.notmuch/hooks

SEE ALSO

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

@@ -278,4 +315,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-count-1.mdwn b/manpages/notmuch-count-1.mdwn index c9c20f3..ea5a5e1 100644 --- a/manpages/notmuch-count-1.mdwn +++ b/manpages/notmuch-count-1.mdwn @@ -77,4 +77,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-dump-1.mdwn b/manpages/notmuch-dump-1.mdwn index bb5325c..a97f2d2 100644 --- a/manpages/notmuch-dump-1.mdwn +++ b/manpages/notmuch-dump-1.mdwn @@ -55,11 +55,11 @@ gle message-id query is mandatory for notmuch-restore(1). sup The sup dump file format is specifically chosen to be - compatible with the format of files produced by sup-dump. - So if you've previously been using sup for mail, then the - notmuch restore command provides you a way to import all - of your tags (or labels as sup calls them). Each line has - the following form: + compatible with the format of files produced by + sup-dump(1). So if you've previously been using sup for + mail, then the notmuch-restore(1) command provides you a + way to import all of your tags (or labels as sup calls + them). Each line has the following form: <*message-id*\ > **(** <*tag*\ > ... **)** @@ -117,4 +117,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-emacs-mua-1.mdwn b/manpages/notmuch-emacs-mua-1.mdwn index 39d5352..9c200d6 100644 --- a/manpages/notmuch-emacs-mua-1.mdwn +++ b/manpages/notmuch-emacs-mua-1.mdwn @@ -43,9 +43,9 @@ Even if a window system is available, use the current terminal. --client - Use emacsclient, rather than emacs. For emacsclient to work, you - need an already running Emacs with a server, or use --auto-dae- - mon. + Use emacsclient(1), rather than emacs(1). For emacsclient(1) to + work, you need an already running Emacs with a server, or use + --auto-daemon. --auto-daemon Automatically start Emacs in daemon mode, if the Emacs server is @@ -61,9 +61,9 @@ Output the resulting elisp to stdout instead of evaluating it. The supported positional parameters and short options are a compatible - subset of the mutt MUA command-line options. The options and positional - parameters modifying the message can't be combined with the mailto: - URL. + subset of the mutt(1) MUA command-line options. The options and posi‐ + tional parameters modifying the message can't be combined with the + mailto: URL. Options may be specified multiple times. @@ -92,4 +92,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index 931ea8a..aa3eee9 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -20,29 +20,29 @@ The currently available hooks are described below. pre-new - 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. + This hook is invoked by the notmuch-new(1) command before scan‐ + ning or importing new messages into the database. If this hook + exits with a non-zero status, notmuch will abort further pro‐ + cessing of the notmuch-new(1) 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 ap‐ - plied. The hook will not be run if there have been any errors - during the scan or import. + This hook is invoked by the notmuch-new(1) 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 during the scan or import. Typically this hook is used to perform additional query-based tagging on the imported messages. post-insert - This hook is invoked by the insert command after the message has - been delivered, added to the database, and initial tags have - been applied. The hook will not be run if there have been any - errors during the message delivery; what is regarded as success‐ - ful delivery depends on the --keep option. + This hook is invoked by the notmuch-insert(1) command after the + message has been delivered, added to the database, and initial + tags have been applied. The hook will not be run if there have + been any errors during the message delivery; what is regarded as + successful delivery depends on the --keep option. Typically this hook is used to perform additional query-based tagging on the delivered messages. @@ -66,4 +66,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-insert-1.mdwn b/manpages/notmuch-insert-1.mdwn index 8ae7151..41438ad 100644 --- a/manpages/notmuch-insert-1.mdwn +++ b/manpages/notmuch-insert-1.mdwn @@ -15,8 +15,8 @@ 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 afterwards. + tive to using a separate tool to deliver the message then running not‐ + much-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: @@ -32,7 +32,7 @@ Option arguments must appear before any tag operation arguments. Sup‐ ported options for insert include - --folder=<folder> + --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 @@ -116,4 +116,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-new-1.mdwn b/manpages/notmuch-new-1.mdwn index 004e325..dafa56a 100644 --- a/manpages/notmuch-new-1.mdwn +++ b/manpages/notmuch-new-1.mdwn @@ -18,16 +18,16 @@ full-text indexing on new messages that are found. Each new message will automatically be tagged with both the inbox and unread tags. - You should run notmuch new once after first running notmuch setup to + You should run notmuch new once after first running notmuch-setup(1) to create the initial database. The first run may take a long time if you have a significant amount of mail (several hundred thousand messages or more). Subsequently, you should run notmuch new whenever new mail is delivered and you wish to incorporate it into the database. These sub‐ sequent runs will be much quicker than the initial run. - Invoking notmuch with no command argument will run new if notmuch setup - has previously been completed, but notmuch new has not previously been - run. + Invoking notmuch with no command argument will run new if not- + much-setup(1) has previously been completed, but notmuch new has not + previously been run. notmuch new updates tags according to maildir flag changes if the maildir.synchronize_flags configuration option is enabled. See not‐ @@ -95,4 +95,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-properties-7.mdwn b/manpages/notmuch-properties-7.mdwn index f613125..44d455a 100644 --- a/manpages/notmuch-properties-7.mdwn +++ b/manpages/notmuch-properties-7.mdwn @@ -75,10 +75,10 @@ sage. session-key - When notmuch-show(1) or nomtuch-reply 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 decryp‐ - tion. + 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. @@ -135,7 +135,7 @@ 
        notmuch(1), notmuch-config(1), notmuch-dump(1), notmuch-insert(1), not‐
        much-new(1),  notmuch-reindex(1), notmuch-reply(1), notmuch-restore(1),
-       notmuch-show(1), *notmuch-search-terms(7)
+       notmuch-search-terms(7), notmuch-show(1)

AUTHOR

@@ -148,4 +148,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-reindex-1.mdwn b/manpages/notmuch-reindex-1.mdwn index 5ddf2bb..47a3536 100644 --- a/manpages/notmuch-reindex-1.mdwn +++ b/manpages/notmuch-reindex-1.mdwn @@ -94,4 +94,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-reply-1.mdwn b/manpages/notmuch-reply-1.mdwn index 84c06bf..cf63d9a 100644 --- a/manpages/notmuch-reply-1.mdwn +++ b/manpages/notmuch-reply-1.mdwn @@ -35,7 +35,7 @@ Supported options for reply include - --format=(default|json|sexp|headers-only) + --format=(default|json|sexp|headers-only) default Includes subject and quoted message body as an RFC 2822 @@ -60,7 +60,7 @@ tended for programs that invoke notmuch(1) internally. If omit‐ ted, the latest supported version will be used. - --reply-to=(all|sender) + --reply-to=(all|sender) all (default) Replies to all addresses. @@ -72,33 +72,34 @@ contains something other than only the user's addresses. --decrypt=(false|auto|true) - If true, decrypt any MIME encrypted parts found in the selected con‐ - tent (i.e., "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. + If true, decrypt any MIME encrypted parts found in the selected + content (i.e., "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. - 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 se‐ - cret keys. + 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. - Use false to avoid even automatic decryption. + Use false to avoid even automatic decryption. - Non-automatic decryption expects a functioning gpg-agent(1) to pro‐ - vide any needed credentials. Without one, the decryption will likely - fail. + Non-automatic decryption expects a functioning gpg-agent(1) to + provide any needed credentials. Without one, the decryption will + likely fail. - Default: auto + Default: auto - See notmuch-search-terms(7) for details of the supported syntax for + See notmuch-search-terms(7) for details of the supported syntax for <search-terms>. - Note: It is most common to use notmuch reply with a search string - matching a single message, (such as id:<message-id>), but it can be + Note: It is most common to use notmuch reply with a search string + matching a single message, (such as id:<message-id>), but it can be useful to reply to several messages at once. For example, when a series - of patches are sent in a single thread, replying to the entire thread - allows for the reply to comment on issues found in multiple patches. - The default format supports replying to multiple messages at once, but + of patches are sent in a single thread, replying to the entire thread + allows for the reply to comment on issues found in multiple patches. + The default format supports replying to multiple messages at once, but the JSON and S-Expression formats do not. @@ -113,8 +114,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-restore(1),
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
+       much-hooks(5),  notmuch-insert(1),  notmuch-new(1), notmuch-restore(1),
        notmuch-search(1),   notmuch-search-terms(7),   notmuch-show(1),   not‐
        much-tag(1)
@@ -129,4 +130,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-restore-1.mdwn b/manpages/notmuch-restore-1.mdwn index 2c1bb69..c3943fd 100644 --- a/manpages/notmuch-restore-1.mdwn +++ b/manpages/notmuch-restore-1.mdwn @@ -14,7 +14,7 @@

DESCRIPTION

-       Restores the tags from the given file (see notmuch dump).
+       Restores the tags from the given file (see notmuch-dump(1)).
 
        The input is read from the given filename, if any, or from stdin.
 
@@ -102,4 +102,4 @@
        2009-2021, Carl Worth and many others
-

0.32

+

0.33

diff --git a/manpages/notmuch-search-1.mdwn b/manpages/notmuch-search-1.mdwn index 731a611..35ca05e 100644 --- a/manpages/notmuch-search-1.mdwn +++ b/manpages/notmuch-search-1.mdwn @@ -26,7 +26,7 @@ Supported options for search include - --format=(json|sexp|text|text0) + --format=(json|sexp|text|text0) Presents the results in either JSON, S-Expressions, newline character separated plain-text (default), or null character sep‐ arated plain-text (compatible with xargs(1) -0 option where @@ -83,7 +83,7 @@ ray (--format=json), or as an S-Expression list (--for- mat=sexp). - --sort=(newest-first|oldest-first) + --sort=(newest-first|oldest-first) This option can be used to present results in either chronologi‐ cal order (oldest-first) or reverse chronological order (new- est-first). @@ -163,10 +163,10 @@

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

AUTHOR

@@ -179,4 +179,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index a2e11ef..5818d7f 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -74,8 +74,8 @@ 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 - other tag values added manually with notmuch tag. + default for new messages added by notmuch-new(1) as well as any + other tag values added manually with notmuch-tag(1). id:<message-id> or mid:<message-id> or mid:/<regex>/ For id: and mid:, message ID values are the literal contents of @@ -86,7 +86,7 @@ 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 + umn of output from notmuch-search(1) thread:{<notmuch query>} Threads may be searched for indirectly by providing an arbitrary @@ -151,18 +151,19 @@ The lastmod: prefix can be used to restrict the result by the database revision number of when messages were last modified (tags were added/removed or filenames changed). This is usually - used in conjunction with the --uuid argument to notmuch search - to find messages that have changed since an earlier query. + used in conjunction with the --uuid argument to not‐ + much-search(1) to find messages that have changed since an ear‐ + lier query. query:<name> - The query: prefix allows queries to refer to previously saved + The query: prefix allows queries to refer to previously saved queries added with notmuch-config(1). property:<key>=<value> - The property: prefix searches for messages with a particular - <key>=<value> property pair. Properties are used internally by - notmuch (and extensions) to add metadata to messages. A given - key can be present on a given message with several different + The property: prefix searches for messages with a particular + <key>=<value> property pair. Properties are used internally by + notmuch (and extensions) to add metadata to messages. A given + 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 de‐ @@ -171,23 +172,23 @@

  Operators

-       In addition to individual terms, multiple terms can  be  combined  with
-       Boolean  operators (and, or, not, and xor). Each term in the query will
-       be implicitly connected by a logical AND if  no  explicit  operator  is
-       provided  (except  that  terms  with a common prefix will be implicitly
-       combined with OR).  The  shorthand  '-<term>'  can  be  used  for  'not
+       In  addition  to  individual terms, multiple terms can be combined with
+       Boolean operators (and, or, not, and xor). Each term in the query  will
+       be  implicitly  connected  by  a logical AND if no explicit operator is
+       provided (except that terms with a common  prefix  will  be  implicitly
+       combined  with  OR).   The  shorthand  '-<term>'  can  be used for 'not
        <term>' but unfortunately this does not work at the start of an expres‐
-       sion.  Parentheses can also be used to control the combination  of  the
+       sion.   Parentheses  can also be used to control the combination of the
        Boolean operators, but will have to be protected from interpretation by
        the shell, (such as by putting quotation marks around any parenthesized
        expression).
 
-       In  addition to the standard boolean operators, Xapian provides several
+       In addition to the standard boolean operators, Xapian provides  several
        operators specific to text searching.
 
           notmuch search term1 NEAR term2
 
-       will return results where term1  is  within  10  words  of  term2.  The
+       will  return  results  where  term1  is  within  10 words of term2. The
        threshold can be set like this:
 
           notmuch search term1 NEAR/2 term2
@@ -197,7 +198,7 @@
           notmuch search term1 ADJ term2
 
        will return results where term1 is within 10 words of term2, but in the
-       same order as in the query. The threshold can be set the same  as  with
+       same  order  as in the query. The threshold can be set the same as with
        NEAR:
 
           notmuch search term1 ADJ/7 term2
@@ -211,28 +212,28 @@
           notmuch search details
           notmuch search detail
 
-       will  all  return identical results, because Xapian first "reduces" the
+       will all return identical results, because Xapian first  "reduces"  the
        term to the common stem (here 'detail') and then performs the search.
 
-       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  be‐
-       low  for  details).   Stemming is currently only supported for English.
+       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 be‐
+       low for details).  Stemming is currently only  supported  for  English.
        Searches for words in other languages will be performed unstemmed.

  Wildcards

-       It is possible to use a trailing  '*'  as  a  wildcard.  A  search  for
+       It  is  possible  to  use  a  trailing  '*' as a wildcard. A search for
        'wildc*' will match 'wildcard', 'wildcat', etc.

  Boolean and Probabilistic Prefixes

-       Xapian  (and hence notmuch) prefixes are either boolean, supporting ex‐
+       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
+       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
@@ -247,10 +248,10 @@
 
 
   Terms and phrases

 
-       In  general  Xapian  distinguishes  between lists of terms and phrases.
+       In general Xapian distinguishes between lists  of  terms  and  phrases.
        Phrases are indicated by double quotes (but beware you probably need to
-       protect  those  from  your shell) and insist that those unstemmed words
-       occur in that order. One useful, but initially  surprising  feature  is
+       protect those from your shell) and insist that  those  unstemmed  words
+       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"
@@ -279,8 +280,8 @@
 
 
   Quoting

 
-       Double quotes are also used by the  notmuch  query  parser  to  protect
-       boolean  terms, regular expressions, or subqueries containing spaces or
+       Double  quotes  are  also  used  by the notmuch query parser to protect
+       boolean terms, regular expressions, or subqueries containing spaces  or
        other special characters, e.g.
 
           tag:"a tag"
@@ -289,7 +290,7 @@
 
           thread:"{from:mallory and date:2009}"
 
-       As with phrases, you need to protect the double quotes from  the  shell
+       As  with  phrases, you need to protect the double quotes from the shell
        e.g.
 
           % notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
@@ -298,11 +299,11 @@
 
 
DATE AND TIME SEARCH

 
-       notmuch  understands a variety of standard and natural ways of express‐
+       notmuch understands a variety of standard and natural ways of  express‐
        ing dates and times, both in absolute terms ("2012-10-24") and in rela‐
-       tive  terms ("yesterday"). Any number of relative terms can be combined
-       ("1 hour 25 minutes") and an absolute date/time can  be  combined  with
-       relative  terms  to  further adjust it. A non-exhaustive description of
+       tive terms ("yesterday"). Any number of relative terms can be  combined
+       ("1  hour  25  minutes") and an absolute date/time can be combined with
+       relative terms to further adjust it. A  non-exhaustive  description  of
        the syntax supported for absolute and relative terms is given below.
 

 
@@ -310,35 +311,35 @@
 
        date:<since>..<until>
 
-       The above expression  restricts  the  results  to  only  messages  from
+       The  above  expression  restricts  the  results  to  only messages from
        <since> to <until>, based on the Date: header.
 
-       <since>  and <until> can describe imprecise times, such as "yesterday".
-       In this case, <since> is taken as the earliest time it  could  describe
+       <since> and <until> can describe imprecise times, such as  "yesterday".
+       In  this  case, <since> is taken as the earliest time it could describe
        (the beginning of yesterday) and <until> is taken as the latest time it
-       could describe (the end of yesterday). Similarly,  date:january..febru‐
+       could  describe (the end of yesterday). Similarly, date:january..febru‐
        ary matches from the beginning of January to the end of February.
 
-       If  specifying  a  time  range using timestamps in conjunction with the
-       date prefix, each timestamp must be preceded by @ (ASCII  hex  40).  As
-       above,  each  timestamp  is a number representing the number of seconds
+       If specifying a time range using timestamps  in  conjunction  with  the
+       date  prefix,  each  timestamp must be preceded by @ (ASCII hex 40). As
+       above, each timestamp is a number representing the  number  of  seconds
        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  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
+       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.
 
-       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,
+       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‐
+       date:monday  matches from the beginning of Monday until the end of Mon‐
        day.
 

 
@@ -349,15 +350,15 @@
 
        All refer to past, can be repeated and will be accumulated.
 
-       Units can be abbreviated to any length, with  the  otherwise  ambiguous
+       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.  Ad‐
-       ditionally, the unit may be preceded by "last" or "this"  (e.g.,  "last
+       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
-       specification will be relative from the  specified  absolute  date  and
+       When combined with absolute date and time, the relative date  and  time
+       specification  will  be  relative  from the specified absolute date and
        time.
 
        Examples: 5M2d, two weeks
@@ -418,10 +419,10 @@
 
 
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‐
-       much-search(1), *notmuch-show(1), notmuch-tag(1)
+       notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1),  not‐
+       much-hooks(5),   notmuch-insert(1),   notmuch-new(1),   notmuch-proper‐
+       ties(7), notmuch-reindex(1), notmuch-reply(1), notmuch-restore(1), not‐
+       much-search(1), notmuch-show(1), notmuch-tag(1)
 

 
 
AUTHOR

@@ -434,4 +435,4 @@
        2009-2021, Carl Worth and many others
 

 
-
0.32

+
0.33

diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn
index 4a3831a..fb28d27 100644
--- a/manpages/notmuch-show-1.mdwn
+++ b/manpages/notmuch-show-1.mdwn
@@ -103,35 +103,47 @@
               part still has two MIME parts:  part  0  is  the  whole  message
               (headers and body) and part 1 is just the body.
 
+       --sort=(newest-first|oldest-first)
+              This option can be used to present results in either chronologi‐
+              cal order (oldest-first) or reverse  chronological  order  (new-
+              est-first).
+
+              Only  threads  as  a  whole are reordered.  Ordering of messages
+              within each thread will not be affected by this flag, since that
+              order is always determined by the thread's replies.
+
+              By  default,  results will be displayed in reverse chronological
+              order, (that is, the newest results will be displayed first).
+
        --verify
               Compute and report the validity of any MIME cryptographic signa‐
-              tures found in the selected  content  (e.g.,  "multipart/signed"
+              tures  found  in  the selected content (e.g., "multipart/signed"
               parts). Status of the signature will be reported (currently only
-              supported with --format=json and --format=sexp), and the  multi‐
+              supported  with --format=json and --format=sexp), and the multi‐
               part/signed part will be replaced by the signed data.
 
        --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  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‐
+              If true, decrypt any MIME encrypted parts found in the  selected
+              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
-              the cleartext of the message, enabling automatic  decryption  in
+              stash  behaves like true, but upon successful decryption it will
+              also stash the message's session key in the database, and  index
+              the  cleartext  of the message, enabling automatic decryption in
               the future.
 
-              If  auto,  and  a  session key is already known for the message,
-              then it will be decrypted, but notmuch will not  try  to  access
+              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 keys.
 
               Use false to avoid even automatic decryption.
 
-              Non-automatic  decryption  (stash  or  true, in the absence of a
-              stashed session key) expects a functioning gpg-agent(1) to  pro‐
-              vide  any  needed  credentials. Without one, the decryption will
+              Non-automatic decryption (stash or true, in  the  absence  of  a
+              stashed  session key) expects a functioning gpg-agent(1) to pro‐
+              vide any needed credentials. Without one,  the  decryption  will
               fail.
 
               Note: setting either true or stash here implies --verify.
@@ -147,7 +159,7 @@
                        │already known │       │      │      │       │
                        ├──────────────┼───────┼──────┼──────┼───────┤
                        │Use    secret │       │      │ X    │ X     │
-                       │keys to  show │       │      │      │       │
+                       │keys  to show │       │      │      │       │
                        │cleartext     │       │      │      │       │
                        ├──────────────┼───────┼──────┼──────┼───────┤
                        │Stash     any │       │      │      │ X     │
@@ -158,44 +170,44 @@
                        │sage if found │       │      │      │       │
                        └──────────────┴───────┴──────┴──────┴───────┘
 
-              Note: --decrypt=stash requires write  access  to  the  database.
+              Note:  --decrypt=stash  requires  write  access to the database.
               Otherwise, notmuch show operates entirely in read-only mode.
 
               Default: auto
 
        --exclude=(true|false)
-              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
+              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 re‐
-              turned regardless (with the excluded flag being set when  appro‐
-              priate)  but  threads that only match in an excluded message are
+              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.
 
        --body=(true|false)
-              If true (the default) notmuch show includes the  bodies  of  the
-              messages   in   the   output;  if  false,  bodies  are  omitted.
-              --body=false is only implemented for the  text,  json  and  sexp
+              If  true  (the  default) notmuch show includes the bodies of the
+              messages  in  the  output;  if  false,   bodies   are   omitted.
+              --body=false  is  only  implemented  for the text, json and sexp
               formats and it is incompatible with --part > 0.
 
               This is useful if the caller only needs the headers as body-less
               output is much faster and substantially smaller.
 
        --include-html
-              Include "text/html" parts as part of the output (currently  only
-              supported  with --format=text, --format=json and --format=sexp).
+              Include  "text/html" parts as part of the output (currently only
+              supported with --format=text, --format=json and  --format=sexp).
               By default, unless --part=N is used to select a specific part or
               --include-html is used to include all "text/html" parts, no part
               with content type "text/html" is included in the output.
 
-       A common use of notmuch show is to display a  single  thread  of  email
+       A  common  use  of  notmuch show is to display a single thread of email
        messages. For this, use a search term of "thread:<thread-id>" as can be
-       seen in the first column of output from the notmuch search command.
+       seen in the first column of output from the notmuch-search(1) command.
 

 
 
EXIT STATUS

@@ -209,8 +221,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)
 

@@ -225,4 +237,4 @@
        2009-2021, Carl Worth and many others
-

0.32

+

0.33

diff --git a/manpages/notmuch-tag-1.mdwn b/manpages/notmuch-tag-1.mdwn index e10b979..b07bb57 100644 --- a/manpages/notmuch-tag-1.mdwn +++ b/manpages/notmuch-tag-1.mdwn @@ -116,4 +116,4 @@ 2009-2021, Carl Worth and many others -

0.32

+

0.33

-- 2.43.0