From: Tomi Ollila <tomi.ollila@iki.fi>
Date: Sat, 4 Sep 2021 20:56:10 +0000 (+0300)
Subject: manpages updates for release 0.33
X-Git-Url: https://git.cworth.org/git?a=commitdiff_plain;h=85fe2a1e7df8ccbb172ebf5f10e3cf574a08944a;p=notmuch-wiki
manpages updates for release 0.33
---
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.
-<h2>0.32</h2>
+<h2>0.33</h2>
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 @@
<b>--config=FILE</b>
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 <u>FILE</u>, which tells
- <b>notmuch</b> to use only configuration metadata from the database.
+ figuration file specified by <u>NOTMUCH</u>_<u>CONFIG</u>. The empty string is
+ a permitted and sometimes useful value of <u>FILE</u>, which tells <b>not-</b>
+ <b>much</b> to use only configuration metadata from the database.
<b>--uuid=HEX</b>
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 <u>NOTMUCH</u>_<u>CONFIG</u> (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 <b>notmuch</b> <b>setup</b> 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 <b>notmuch</b> <b>setup</b> <b>.</b>
+ with a utility such as <b>mb2md</b>(1) before running <b>notmuch</b> <b>setup</b>.
Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if the setup
command has not previously been completed.
@@ -99,38 +99,39 @@
<h3> OTHER COMMANDS</h3>
<pre>
Several of the notmuch commands accept search terms with a common synâ
- tax. See <b>notmuch-search-terms</b>(7) for more details on the supported synâ
+ tax. See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for more details on the supported synâ
tax.
- The <b>search</b>, <b>show</b>, <b>address</b> and <b>count</b> commands are used to query the
- email database.
+ The <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-address-1/'>notmuch-address</a>(1) and <a href='../notmuch-count-1/'>notâ</a>
+ <a href='../notmuch-count-1/'>much-count</a>(1) commands are used to query the email database.
- The <b>reply</b> command is useful for preparing a template for an email reâ
- ply.
+ The <a href='../notmuch-reply-1/'>notmuch-reply</a>(1) command is useful for preparing a template for an
+ email reply.
- The <b>tag</b> command is the only command available for manipulating database
- contents.
+ The <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) command is the only command available for manipulatâ
+ ing database contents.
- The <b>dump</b> and <b>restore</b> commands can be used to create a textual dump of
- email tags for backup purposes, and to restore from that dump.
+ The <a href='../notmuch-dump-1/'>notmuch-dump</a>(1) and <a href='../notmuch-restore-1/'>notmuch-restore</a>(1) commands can be used to creâ
+ ate a textual dump of email tags for backup purposes, and to restore
+ from that dump.
- The <b>config</b> command can be used to get or set settings in the notmuch
- configuration file.
+ The <a href='../notmuch-config-1/'>notmuch-config</a>(1) command can be used to get or set settings in the
+ notmuch configuration file.
</pre>
<h3> CUSTOM COMMANDS</h3>
<pre>
- If the given command is not known to notmuch, notmuch tries to execute
- the external <b>notmuch-<subcommand></b> 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 <b>notmuch-<subcommand></b> in <b>PATH</b> 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.
</pre>
<h3> OPTION SYNTAX</h3>
<pre>
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.
<b>NOTMUCH</b>_<b>CONFIG</b>
- 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
+ <a href='../notmuch-config-1/'>notmuch-config</a>(1) for details.
+
+ <b>NOTMUCH</b>_<b>DATABASE</b>
+ Specifies the location of the notmuch database. See <a href='../notmuch-config-1/'>notmuch-conâ</a>
+ <a href='../notmuch-config-1/'>fig</a>(1) for details.
+
+ <b>NOTMUCH</b>_<b>PROFILE</b>
+ Selects among notmuch configurations. See <a href='../notmuch-config-1/'>notmuch-config</a>(1) for
+ details.
<b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
Location to write a talloc memory usage report. See <b>talloc</b>_<b>en-</b>
@@ -188,4 +196,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <b>address</b> include
- <b>--format=</b>(<b>json</b>|<b>sexp</b>|<b>text</b>|<b>text0</b>)
+ <b>--format=(json|sexp|text|text0)</b>
Presents the results in either JSON, S-Expressions, newline
character separated plain-text (default), or null character sepâ
arated plain-text (compatible with <b>xargs</b>(1) -0 option where
@@ -78,7 +78,7 @@
quently among the matching messages. If <b>--output=count</b> is
specified, include all variants in the count.
- <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
+ <b>--sort=(newest-first|oldest-first)</b>
This option can be used to present results in either chronologiâ
cal order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
<b>est-first</b>).
@@ -116,8 +116,8 @@
<pre>
<a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
<a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
- <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notâ</a>
- <a href='../notmuch-tag-1/'>much-tag</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1)
+ <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notâ</a>
+ <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
@@ -130,4 +130,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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.
</pre>
-<h2>ENVIRONMENT</h2>
-<pre>
- The following environment variables can be used to control the behavior
- of notmuch.
-
- <b>NOTMUCH</b>_<b>CONFIG</b>
- Specifies the location of the notmuch configuration file. Notâ
- much will use ${HOME}/.notmuch-config if this variable is not
- set.
-</pre>
-
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notâ</a>
- <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notâ</a>
+ <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notâ</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
@@ -64,4 +53,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <u>$HOME</u> for items in section <b>database</b>.
<b>database.path</b>
- Notmuch will store its database here, (in sub-directory named
+ Notmuch will store its database here, (in sub-directory named
<b>.notmuch</b> if <b>database.mail</b>_<b>root</b> is unset).
- Default: <b>$MAILDIR</b> variable if set, otherwise <b>$HOME/mail</b>.
+ Default: see <u>DATABASE</u> <u>LOCATION</u>
<b>database.mail</b>_<b>root</b>
- 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 <b>database.mail</b>_<b>root</b> is unset.
+ <b>database.backup</b>_<b>dir</b>
+ 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 <u>backâ</u>
+ <u>ups</u>.
+
<b>database.hook</b>_<b>dir</b>
- Directory containing hooks run by notmuch commands. See <a href='../notmuch-hooks-5/'>notâ</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5).
+ Directory containing hooks run by notmuch commands. See <a href='../notmuch-hooks-5/'>notâ</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5).
+
+ History: this configuration value was introduced in notmuch
+ 0.32.
+
+ Default: See HOOKS, below.
+
+ <b>database.autocommit</b>
+ How often to commit transactions to disk. <u>0</u> means wait until command
+ completes, otherwise an integer <u>n</u> specifies to commit to disk after
+ every <u>n</u> completed transactions.
+
+ History: this configuration value was introduced in notmuch 0.33.
<b>user.name</b>
Your full name.
@@ -90,8 +112,8 @@
<b>new.ignore</b>
A list to specify files and directories that will not be
- searched for messages by <b>notmuch</b> <b>new</b>. Each entry in the list is
- either:
+ searched for messages by <a href='../notmuch-new-1/'>notmuch-new</a>(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 <b>notmuch</b> <b>new</b> command will notice flag changes in filenames
- and update tags, while the <b>notmuch</b> <b>tag</b> and <b>notmuch</b> <b>restore</b> comâ
- mands will notice tag changes and update flags in filenames.
+ The <a href='../notmuch-new-1/'>notmuch-new</a>(1) command will notice flag changes in filenames
+ and update tags, while the <a href='../notmuch-tag-1/'>notmuch-tag</a>(1) and <a href='../notmuch-restore-1/'>notmuch-restore</a>(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 <b>notmuch</b> <b>new</b> before <b>notmuch</b> <b>tag</b> or
- <b>notmuch</b> <b>restore</b> 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 <a href='../notmuch-new-1/'>notmuch-new</a>(1) before <a href='../notmuch-tag-1/'>notâ</a>
+ <a href='../notmuch-tag-1/'>much-tag</a>(1) or <a href='../notmuch-restore-1/'>notmuch-restore</a>(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: <b>true</b>.
@@ -173,7 +195,8 @@
ââââââââââââââââ¬ââââââââ¬âââââââ¬ââââââââââ¬âââââââ
â â false â auto â nostash â true â
- ââââââââââââââââ¼ââââââââ¼âââââââ¼ââââââââââ¼âââââââ¤
+ ââââââââââââââââ´ââââââââ´âââââââ´ââââââââââ´âââââââ
+
âIndex cleartâ â â X â X â X â
âext using â â â â â
âstashed sesâ â â â â â
@@ -225,47 +248,61 @@
<a href='../notmuch-search-terms-7/'>much-search-terms</a>(7) for more information about named queries.
</pre>
-<h2>ENVIRONMENT</h2>
+<h2>FILES</h2>
+
+<h3> CONFIGURATION</h3>
<pre>
- The following environment variables can be used to control the behavior
- of notmuch.
+ Notmuch configuration file search order:
- <b>NOTMUCH</b>_<b>CONFIG</b>
- Specifies the location of the notmuch configuration file.
+ 1. File specified by <b>notmuch</b> <b>--config</b> global option; see <a href='../notmuch-1/'>notmuch</a>(1).
- <b>NOTMUCH</b>_<b>PROFILE</b>
- Selects among notmuch configurations.
-</pre>
+ 2. File specified by <b>NOTMUCH</b>_<b>CONFIG</b> environment variable.
-<h2>FILES</h2>
+ 3. <b>$XDG</b>_<b>CONFIG</b>_<b>HOME/notmuch/<profile>/config</b> where <b><profile></b> is defined
+ by <b>NOTMUCH</b>_<b>PROFILE</b> environment variable if set, <b>$XDG</b>_<b>CON-</b>
+ <b>FIG</b>_<b>HOME/notmuch/default/config</b> otherwise.
-<h3> CONFIGURATION</h3>
+ 4. <b>$HOME/.notmuch-config.<profile></b> where <b><profile></b> is defined by <b>NOT-</b>
+ <b>MUCH</b>_<b>PROFILE</b> environment variable if set, <b>$HOME/.notmuch-config</b> othâ
+ erwise.
+</pre>
+
+<h3> DATABASE LOCATION</h3>
<pre>
- If <b>NOTMUCH</b>_<b>CONFIG</b> is unset, notmuch tries (in order)
+ Notmuch database search order:
+
+ 1. Directory specified by <b>NOTMUCH</b>_<b>DATABASE</b> environment variable.
- ⢠<b>$XDG</b>_<b>CONFIG</b>_<b>HOME/notmuch/<profile>/config</b> where <b><profile></b> is defined
- by <b>$NOTMUCH</b>_<b>PROFILE</b> or "default"
+ 2. Directory specified by config key <b>database.path</b>.
- ⢠<b>${HOME}/.notmuch-config<profile></b> where <b><profile></b> is <b>.$NOTMUCH</b>_<b>PROFILE</b>
- or ""
+ 3. <b>$XDG</b>_<b>DATA</b>_<b>HOME/notmuch/<profile></b> where <b><profile></b> is defined by <b>NOT-</b>
+ <b>MUCH</b>_<b>PROFILE</b> environment variable if set, <b>$XDG</b>_<b>DATA</b>_<b>HOME/notmuch/de-</b>
+ <b>fault</b> otherwise.
+
+ 4. Directory specified by <b>MAILDIR</b> environment variable.
+
+ 5. <b>$HOME/mail</b>
</pre>
-<h3> Hooks</h3>
+<h3> HOOKS</h3>
<pre>
- If <b>database.hook</b>_<b>dir</b> is unset, notmuch tries (in order)
+ Notmuch hook directory search order:
+
+ 1. Directory specified by <b>database.hook</b>_<b>dir</b> configuration option.
- ⢠<b>$XDG</b>_<b>CONFIG</b>_<b>HOME/notmuch/<profile>/hooks</b> where <b><profile></b> is defined
- by <b>$NOTMUCH</b>_<b>PROFILE</b> or "default"
+ 2. <b>$XDG</b>_<b>CONFIG</b>_<b>HOME/notmuch/<profile>/hooks</b> where <b><profile></b> is defined
+ by <b>NOTMUCH</b>_<b>PROFILE</b> environment variable if set, <b>$XDG</b>_<b>CON-</b>
+ <b>FIG</b>_<b>HOME/notmuch/default/hooks</b> otherwise.
- ⢠<b><database.path>/.notmuch/hooks</b>
+ 3. <b><database.path>/.notmuch/hooks</b>
</pre>
<h2>SEE ALSO</h2>
<pre>
<a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notâ</a>
- <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
- <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-properties-7/'>notmuch-properties</a>(7), <a href='../notmuch-show-1/'>notâ</a>
- <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
+ <a href='../notmuch-insert-1/'>much-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-properties-7/'>notmuch-properties</a>(7), <a href='../notmuch-reply-1/'>notmuch-reâ</a>
+ <a href='../notmuch-reply-1/'>ply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),
+ <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
@@ -278,4 +315,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <a href='../notmuch-restore-1/'>notmuch-restore</a>(1).
<b>sup</b> The <b>sup</b> 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
- <b>notmuch</b> <b>restore</b> 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
+ <b>sup-dump</b>(1). So if you've previously been using sup for
+ mail, then the <a href='../notmuch-restore-1/'>notmuch-restore</a>(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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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.
<b>--client</b>
- Use <b>emacsclient</b>, rather than <b>emacs</b>. For <b>emacsclient</b> to work, you
- need an already running Emacs with a server, or use <b>--auto-dae-</b>
- <b>mon</b>.
+ Use <b>emacsclient</b>(1), rather than <b>emacs</b>(1). For <b>emacsclient</b>(1) to
+ work, you need an already running Emacs with a server, or use
+ <b>--auto-daemon</b>.
<b>--auto-daemon</b>
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 <b>mutt</b> MUA command-line options. The options and positional
- parameters modifying the message can't be combined with the mailto:
- URL.
+ subset of the <b>mutt</b>(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.
</pre>
@@ -92,4 +92,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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.
<b>pre-new</b>
- This hook is invoked by the <b>new</b> 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
- <b>new</b> command.
+ This hook is invoked by the <a href='../notmuch-new-1/'>notmuch-new</a>(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 <a href='../notmuch-new-1/'>notmuch-new</a>(1) command.
Typically this hook is used for fetching or delivering new mail
to be imported into the database.
<b>post-new</b>
- This hook is invoked by the <b>new</b> 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 <a href='../notmuch-new-1/'>notmuch-new</a>(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.
<b>post-insert</b>
- This hook is invoked by the <b>insert</b> 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 <b>--keep</b> option.
+ This hook is invoked by the <a href='../notmuch-insert-1/'>notmuch-insert</a>(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 <b>--keep</b> 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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 @@
<b>notmuch</b> <b>insert</b> reads a message from standard input and delivers it into
the maildir directory given by configuration option <b>database.path</b>, then
incorporates the message into the notmuch database. It is an alternaâ
- tive to using a separate tool to deliver the message then running <b>not-</b>
- <b>much</b> <b>new</b> afterwards.
+ tive to using a separate tool to deliver the message then running <a href='../notmuch-new-1/'>notâ</a>
+ <a href='../notmuch-new-1/'>much-new</a>(1) afterwards.
The new message will be tagged with the tags specified by the <b>new.tags</b>
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 <b>insert</b> include
- <b>--folder=<</b>folder<b>></b>
+ <b>--folder=<folder></b>
Deliver the message to the specified folder, relative to the
top-level directory given by the value of <b>database.path</b>. The deâ
fault is the empty string, which means delivering to the
@@ -116,4 +116,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <b>inbox</b> and <b>unread</b> tags.
- You should run <b>notmuch</b> <b>new</b> once after first running <b>notmuch</b> <b>setup</b> to
+ You should run <b>notmuch</b> <b>new</b> once after first running <b>notmuch-setup</b>(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 <b>notmuch</b> <b>new</b> 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 <b>notmuch</b> with no command argument will run <b>new</b> if <b>notmuch</b> <b>setup</b>
- has previously been completed, but <b>notmuch</b> <b>new</b> has not previously been
- run.
+ Invoking <b>notmuch</b> with no command argument will run <b>new</b> if <b>not-</b>
+ <b>much-setup</b>(1) has previously been completed, but <b>notmuch</b> <b>new</b> has not
+ previously been run.
<b>notmuch</b> <b>new</b> updates tags according to maildir flag changes if the
<b>maildir.synchronize</b>_<b>flags</b> configuration option is enabled. See <a href='../notmuch-config-1/'>notâ</a>
@@ -95,4 +95,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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.
<b>session-key</b>
- When <a href='../notmuch-show-1/'>notmuch-show</a>(1) or <b>nomtuch-reply</b> encounters a message with an
- encrypted part, if notmuch finds a <b>session-key</b> property associated
- with the message, it will try that stashed session key for decrypâ
- tion.
+ When <a href='../notmuch-show-1/'>notmuch-show</a>(1) or <a href='../notmuch-reply-1/'>notmuch-reply</a>(1) encounters a message with
+ an encrypted part, if notmuch finds a <b>session-key</b> 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 <b>--decrypt=false</b>.
@@ -135,7 +135,7 @@
<pre>
<a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notâ</a>
<a href='../notmuch-new-1/'>much-new</a>(1), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
- <a href='../notmuch-show-1/'>notmuch-show</a>(1), <b>*notmuch-search-terms</b>(7)
+ <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1)
</pre>
<h2>AUTHOR</h2>
@@ -148,4 +148,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <b>reply</b> include
- <b>--format=</b>(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
+ <b>--format=(default|json|sexp|headers-only)</b>
<b>default</b>
Includes subject and quoted message body as an RFC 2822
@@ -60,7 +60,7 @@
tended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If omitâ
ted, the latest supported version will be used.
- <b>--reply-to=</b>(<b>all</b>|<b>sender</b>)
+ <b>--reply-to=(all|sender)</b>
<b>all</b> (default)
Replies to all addresses.
@@ -72,33 +72,34 @@
contains something other than only the user's addresses.
<b>--decrypt=(false|auto|true)</b>
- If <b>true</b>, 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 <b>--format=json</b> and
- <b>--format=sexp</b>), and on successful decryption the multipart/encrypted
- part will be replaced by the decrypted content.
+ If <b>true</b>, 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 <b>--for-</b>
+ <b>mat=json</b> and <b>--format=sexp</b>), and on successful decryption the
+ multipart/encrypted part will be replaced by the decrypted conâ
+ tent.
- If <b>auto</b>, 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 <b>auto</b>, 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 <b>false</b> to avoid even automatic decryption.
+ Use <b>false</b> to avoid even automatic decryption.
- Non-automatic decryption expects a functioning <b>gpg-agent</b>(1) to proâ
- vide any needed credentials. Without one, the decryption will likely
- fail.
+ Non-automatic decryption expects a functioning <b>gpg-agent</b>(1) to
+ provide any needed credentials. Without one, the decryption will
+ likely fail.
- Default: <b>auto</b>
+ Default: <b>auto</b>
- See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
+ See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
<search-terms>.
- Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string
- matching a single message, (such as id:<message-id>), but it can be
+ Note: It is most common to use <b>notmuch</b> <b>reply</b> 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.
</pre>
@@ -113,8 +114,8 @@
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notâ</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
@@ -129,4 +130,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 @@
<h2>DESCRIPTION</h2>
<pre>
- Restores the tags from the given file (see <b>notmuch</b> <b>dump</b>).
+ Restores the tags from the given file (see <a href='../notmuch-dump-1/'>notmuch-dump</a>(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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 <b>search</b> include
- <b>--format=</b>(<b>json</b>|<b>sexp</b>|<b>text</b>|<b>text0</b>)
+ <b>--format=(json|sexp|text|text0)</b>
Presents the results in either JSON, S-Expressions, newline
character separated plain-text (default), or null character sepâ
arated plain-text (compatible with <b>xargs</b>(1) -0 option where
@@ -83,7 +83,7 @@
ray (<b>--format=json</b>), or as an S-Expression list (<b>--for-</b>
<b>mat=sexp</b>).
- <b>--sort=</b>(<b>newest-first</b>|<b>oldest-first</b>)
+ <b>--sort=(newest-first|oldest-first)</b>
This option can be used to present results in either chronologiâ
cal order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
<b>est-first</b>).
@@ -163,10 +163,10 @@
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
- <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notâ</a>
- <a href='../notmuch-tag-1/'>much-tag</a>(1) <a href='../notmuch-address-1/'>notmuch-address</a>(1)
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-address-1/'>notmuch-address</a>(1) <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1),
+ <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1),
+ <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notâ</a>
+ <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
@@ -179,4 +179,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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 @@
<b>tag:<tag></b> <b>or</b> <b>tag:/<regex>/</b> <b>or</b> <b>is:<tag></b> <b>or</b> <b>is:/<regex>/</b>
For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by
- default for new messages added by <b>notmuch</b> <b>new</b> as well as any
- other tag values added manually with <b>notmuch</b> <b>tag</b>.
+ default for new messages added by <a href='../notmuch-new-1/'>notmuch-new</a>(1) as well as any
+ other tag values added manually with <a href='../notmuch-tag-1/'>notmuch-tag</a>(1).
<b>id:<message-id></b> <b>or</b> <b>mid:<message-id></b> <b>or</b> <b>mid:/<regex>/</b>
For <b>id:</b> and <b>mid:</b>, message ID values are the literal contents of
@@ -86,7 +86,7 @@
The <b>thread:</b> 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 <b>notmuch</b> <b>search</b>
+ umn of output from <a href='../notmuch-search-1/'>notmuch-search</a>(1)
<b>thread:{<notmuch</b> <b>query>}</b>
Threads may be searched for indirectly by providing an arbitrary
@@ -151,18 +151,19 @@
The <b>lastmod:</b> 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 <b>--uuid</b> argument to <b>notmuch</b> <b>search</b>
- to find messages that have changed since an earlier query.
+ used in conjunction with the <b>--uuid</b> argument to <a href='../notmuch-search-1/'>notâ</a>
+ <a href='../notmuch-search-1/'>much-search</a>(1) to find messages that have changed since an earâ
+ lier query.
<b>query:<name></b>
- The <b>query:</b> prefix allows queries to refer to previously saved
+ The <b>query:</b> prefix allows queries to refer to previously saved
queries added with <a href='../notmuch-config-1/'>notmuch-config</a>(1).
<b>property:<key>=<value></b>
- The <b>property:</b> 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 <b>property:</b> 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 <a href='../notmuch-properties-7/'>notmuch-properties</a>(7) for more details.
User defined prefixes are also supported, see <a href='../notmuch-config-1/'>notmuch-config</a>(1) for deâ
@@ -171,23 +172,23 @@
<h3> Operators</h3>
<pre>
- In addition to individual terms, multiple terms can be combined with
- Boolean operators (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). 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 (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). 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.
</pre>
<h3> Wildcards</h3>
<pre>
- 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.
</pre>
<h3> Boolean and Probabilistic Prefixes</h3>
<pre>
- Xapian (and hence notmuch) prefixes are either <b>boolean</b>, supporting exâ
+ Xapian (and hence notmuch) prefixes are either <b>boolean</b>, supporting exâ
act matches like "<u>tag:inbox</u>" or <b>probabilistic</b>, supporting a more flexiâ
- ble <b>term</b> based searching. Certain <b>special</b> prefixes are processed by
- notmuch in a way not strictly fitting either of Xapian's built in
+ ble <b>term</b> based searching. Certain <b>special</b> 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.
<b>Boolean</b>
@@ -247,10 +248,10 @@
<h3> Terms and phrases</h3>
<pre>
- In general Xapian distinguishes between lists of terms and <b>phrases</b>.
+ In general Xapian distinguishes between lists of terms and <b>phrases</b>.
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 @@
<h3> Quoting</h3>
<pre>
- 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 @@
<h2>DATE AND TIME SEARCH</h2>
<pre>
- 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.
</pre>
@@ -310,35 +311,35 @@
<pre>
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.
</pre>
<h3> Single expression</h3>
<pre>
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.
</pre>
@@ -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 @@
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1),
- <b>notmuch-properties</b>(1), <b>*notmuch-reply</b>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notâ</a>
- <a href='../notmuch-search-1/'>much-search</a>(1), <b>*notmuch-show</b>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-properties-7/'>notmuch-properâ</a>
+ <a href='../notmuch-properties-7/'>ties</a>(7), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notâ</a>
+ <a href='../notmuch-search-1/'>much-search</a>(1), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
@@ -434,4 +435,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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.
+ <b>--sort=(newest-first|oldest-first)</b>
+ This option can be used to present results in either chronologiâ
+ cal order (<b>oldest-first</b>) or reverse chronological order (<b>new-</b>
+ <b>est-first</b>).
+
+ 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).
+
<b>--verify</b>
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 <b>--format=json</b> and <b>--format=sexp</b>), and the multiâ
+ supported with <b>--format=json</b> and <b>--format=sexp</b>), and the multiâ
part/signed part will be replaced by the signed data.
<b>--decrypt=(false|auto|true|stash)</b>
- If <b>true</b>, 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 <b>--for-</b>
- <b>mat=json</b> and <b>--format=sexp</b>) and on successful decryption the
- multipart/encrypted part will be replaced by the decrypted conâ
+ If <b>true</b>, 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 <b>--for-</b>
+ <b>mat=json</b> and <b>--format=sexp</b>) and on successful decryption the
+ multipart/encrypted part will be replaced by the decrypted conâ
tent.
- <b>stash</b> behaves like <b>true</b>, 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
+ <b>stash</b> behaves like <b>true</b>, 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 <b>auto</b>, and a session key is already known for the message,
- then it will be decrypted, but notmuch will not try to access
+ If <b>auto</b>, 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 <b>false</b> to avoid even automatic decryption.
- Non-automatic decryption (<b>stash</b> or <b>true</b>, in the absence of a
- stashed session key) expects a functioning <b>gpg-agent</b>(1) to proâ
- vide any needed credentials. Without one, the decryption will
+ Non-automatic decryption (<b>stash</b> or <b>true</b>, in the absence of a
+ stashed session key) expects a functioning <b>gpg-agent</b>(1) to proâ
+ vide any needed credentials. Without one, the decryption will
fail.
Note: setting either <b>true</b> or <b>stash</b> here implies <b>--verify</b>.
@@ -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: <b>--decrypt=stash</b> requires write access to the database.
+ Note: <b>--decrypt=stash</b> requires write access to the database.
Otherwise, <b>notmuch</b> <b>show</b> operates entirely in read-only mode.
Default: <b>auto</b>
<b>--exclude=(true|false)</b>
- 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 <b>--entire-thread</b> 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 <b>--entire-thread</b> 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 <b>--exclude=true.</b>
The default is <b>--exclude=true.</b>
<b>--body=(true|false)</b>
- If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
- messages in the output; if false, bodies are omitted.
- <b>--body=false</b> is only implemented for the text, json and sexp
+ If true (the default) <b>notmuch</b> <b>show</b> includes the bodies of the
+ messages in the output; if false, bodies are omitted.
+ <b>--body=false</b> is only implemented for the text, json and sexp
formats and it is incompatible with <b>--part</b> <b>></b> <b>0.</b>
This is useful if the caller only needs the headers as body-less
output is much faster and substantially smaller.
<b>--include-html</b>
- Include "text/html" parts as part of the output (currently only
- supported with <b>--format=text</b>, <b>--format=json</b> and <b>--format=sexp</b>).
+ Include "text/html" parts as part of the output (currently only
+ supported with <b>--format=text</b>, <b>--format=json</b> and <b>--format=sexp</b>).
By default, unless <b>--part=N</b> is used to select a specific part or
<b>--include-html</b> is used to include all "text/html" parts, no part
with content type "text/html" is included in the output.
- A common use of <b>notmuch</b> <b>show</b> is to display a single thread of email
+ A common use of <b>notmuch</b> <b>show</b> 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 <b>notmuch</b> <b>search</b> command.
+ seen in the first column of output from the <a href='../notmuch-search-1/'>notmuch-search</a>(1) command.
</pre>
<h2>EXIT STATUS</h2>
@@ -209,8 +221,8 @@
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notâ</a>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),
<a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-tag-1/'>notâ</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
@@ -225,4 +237,4 @@
2009-2021, Carl Worth and many others
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>
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
</pre>
-<h2>0.32</h2>
+<h2>0.33</h2>