<h2>DESCRIPTION</h2>
<pre>
- Notmuch is a command-line based program for indexing, searching, read-
+ Notmuch is a command-line based program for indexing, searching, read‐
ing, and tagging large collections of email messages.
This page describes how to get started using notmuch from the command
also accessible via <b>notmuch</b> <b>help</b> <b>show</b>
The quickest way to get started with Notmuch is to simply invoke the
- notmuch command with no arguments, which will interactively guide you
+ <b>notmuch</b> command with no arguments, which will interactively guide you
through the process of indexing your mail.
</pre>
<h2>NOTE</h2>
<pre>
- While the command-line program notmuch provides powerful functionality,
- it does not provide the most convenient interface for that functional-
+ While the command-line program <b>notmuch</b> provides powerful functionality,
+ it does not provide the most convenient interface for that functional‐
ity. More sophisticated interfaces are expected to be built on top of
- either the command-line interface, or more likely, on top of the not-
+ either the command-line interface, or more likely, on top of the not‐
much library interface. See <u>http://notmuchmail.org</u> for more about
alternate interfaces to notmuch. The emacs-based interface to notmuch
(available under <b>emacs/</b> in the Notmuch source distribution) is probably
<h2>OPTIONS</h2>
<pre>
- Supported global options for notmuch include
+ Supported global options for <b>notmuch</b> include
- <b>--help</b>
+ <b>--help</b> Print a synopsis of available commands and exit.
- Print a synopsis of available commands and exit.
+ <b>--version</b>
+ Print the installed version of notmuch, and exit.
- <b>--version</b>
-
- Print the installed version of notmuch, and exit.
-
- <b>--config=FILE</b>
-
- Specify the configuration file to use. This overrides any
- configuration file specified by ${NOTMUCH_CONFIG}.
+ <b>--config=FILE</b>
+ Specify the configuration file to use. This overrides any
+ configuration file specified by ${NOTMUCH_CONFIG}.
</pre>
<h2>COMMANDS</h2>
(or to reconfigure it later).
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-
+ 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 .
- This configuration file will be created with descriptive comments, mak-
+ 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.
- The mail directory you specify can contain any number of sub-directo-
- ries and should primarily contain only files with individual email mes-
+ The mail directory you specify can contain any number of sub-directo‐
+ ries and should primarily contain only files with individual email mes‐
sages (eg. maildir or mh archives are perfect). If there are other,
non-email files (such as indexes maintained by other email programs)
then notmuch will do its best to detect those and ignore them.
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-
+ 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>
- Invoking notmuch with no command argument will run <b>setup</b> if the setup
+ Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if the setup
command has not previously been completed.
</pre>
<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-
+ 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.
- The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email
- database.
+ The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the email data‐
+ base.
The <b>reply</b> command is useful for preparing a template for an email
reply.
of notmuch.
<b>NOTMUCH</b>_<b>CONFIG</b>
-
- Specifies the location of the notmuch configuration file. Not-
+ Specifies the location of the notmuch configuration file. Not‐
much will use ${HOME}/.notmuch-config if this variable is not
set.
<b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
-
Location to write a talloc memory usage report. See <b>tal-</b>
<b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
<b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
-
If set to a non-empty value, the notmuch library will print (to
stderr) Xapian queries it constructs.
</pre>
<h2>SEE ALSO</h2>
<pre>
<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/'>not-</a>
- <a href='../notmuch-restore-1/'>much-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-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/'>not‐</a>
+ <a href='../notmuch-restore-1/'>much-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)
The notmuch website: <b>http://notmuchmail.org</b>
2014, Carl Worth and many others
</pre>
-<h2>0.18</h2>
+<h2>0.18.1</h2>
projects / notmuch-wiki / blobdiff