The external html docs are (should be!) nicer to read
[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
# Notmuch Language Bindings [DRAFT]
[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
# Notmuch Language Bindings [DRAFT]
-The Notmuch library, `libnotmuch`, can be used from many programming languages
-using the Notmuch language bindings. The [[command line interface|manpages]] and
-the [[email clients and frontends|frontends]] are based on the language
-bindings.
+The Notmuch library, `libnotmuch`, can be used from many programming
+languages using the Notmuch language bindings. The [command line
+interface](https://notmuchmail.org/doc/latest/man1/notmuch.html) and
+the [[email clients and frontends|frontends]] are based on the
+language bindings.
## <span id="exclude">**killing threads**</span>
## <span id="exclude">**killing threads**</span>
-In a [[hook|manpages/notmuch-hooks-5]]
+In a [hook](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html)
notmuch tag +muted $(notmuch search --output=threads tag:muted)"
notmuch tag +muted $(notmuch search --output=threads tag:muted)"
## How do I search for punctuation, specific special characters, or regexp?
## How do I search for punctuation, specific special characters, or regexp?
-Please see the [[notmuch-search-terms manual
-page|manpages/notmuch-search-terms-7]] first.
+Please see the [notmuch-search-terms manual
+page](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html) first.
The main thing to understand is that Xapian, and therefore Notmuch, searches are
closer to natural language searches than regular expression
The main thing to understand is that Xapian, and therefore Notmuch, searches are
closer to natural language searches than regular expression
No. Tagging is message based.
It is possible, however, to make tags propagate to all messages in a thread
No. Tagging is message based.
It is possible, however, to make tags propagate to all messages in a thread
-using a little bit of scripting in the [[post-new
-hook|manpages/notmuch-hooks-5]]. For example, to add the muted tag to all
+using a little bit of scripting in the [post-new
+hook](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html). For example, to add the muted tag to all
messages in threads that have at least one message with the muted tag:
THREAD_TAGS="muted"
messages in threads that have at least one message with the muted tag:
THREAD_TAGS="muted"
-* [[notmuch-cli|manpages]], the CLI bindings provided with Notmuch.
+* [notmuch-cli](https://notmuchmail.org/doc/latest/man1/notmuch.html), the CLI bindings provided with Notmuch.
* [[notmuch-emacs|notmuch-emacs]], the Emacs email client.
* [notmuch-vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README), the vim frontend.
* [[notmuch-mutt]], mutt interoperability script.
* [[notmuch-emacs|notmuch-emacs]], the Emacs email client.
* [notmuch-vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README), the vim frontend.
* [[notmuch-mutt]], mutt interoperability script.
This is your friendly guide and tutorial to getting started with Notmuch. It
will help you through the first steps of setting up Notmuch.
This is your friendly guide and tutorial to getting started with Notmuch. It
will help you through the first steps of setting up Notmuch.
-All Notmuch commands have [[manual pages|manpages]]. Please refer to them for
+All Notmuch commands have [manual
+pages](https://notmuchmail.org/doc/latest/) Please refer to them for
details.
## Prerequisites
details.
## Prerequisites
long time, so expect that. Also, the resulting database will require roughly the
same amount of storage space as your current collection of email.
long time, so expect that. Also, the resulting database will require roughly the
same amount of storage space as your current collection of email.
-After this step, you can try out the [[Notmuch command-line
-interface|manpages]], or [[Notmuch Emacs interface|notmuch-emacs]].
+After this step, you can try out the [Notmuch command line
+interface](https://notmuchmail.org/doc/latest/man1/notmuch.html), or
+[[Notmuch Emacs interface|notmuch-emacs]].
## Converting Existing mbox to Maildir
## Converting Existing mbox to Maildir
-Notmuch supports running [[user defined hooks|manpages/notmuch-hooks-5]] before
-or after certain commands. Hooks can be arbitrary executable programs or
-scripts. For example, if you always run your mail delivery tool first and
-`notmuch new` after that, you can run the tool from Notmuch `pre-new` hook, and
-simply run `notmuch new` to do both. If you always do some tagging after
-indexing of new messages, you may want to set up a `post-new` or `post-insert`
-hook to do that automatically.
+Notmuch supports running [user defined
+hooks](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html)
+before or after certain commands. Hooks can be arbitrary executable
+programs or scripts. For example, if you always run your mail delivery
+tool first and `notmuch new` after that, you can run the tool from
+Notmuch `pre-new` hook, and simply run `notmuch new` to do both. If
+you always do some tagging after indexing of new messages, you may
+want to set up a `post-new` or `post-insert` hook to do that
+automatically.
## Backing Up and Restoring the Database
## Backing Up and Restoring the Database
## Email Clients and Front Ends
## Email Clients and Front Ends
-Notmuch ships with a powerful set of [[command-line tools|manpages]], an
-[[email client for Emacs|notmuch-emacs]], another
-[client for vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
+Notmuch ships with a powerful set of [command-line
+tools](https://notmuchmail.org/doc/latest/man1/notmuch.html), an
+[[email client for Emacs|notmuch-emacs]], another [client for
+vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
and a [[Mutt integration script|notmuch-mutt]].
There are also many other [[email clients, frontends and tools|frontends]] based
and a [[Mutt integration script|notmuch-mutt]].
There are also many other [[email clients, frontends and tools|frontends]] based
- * [[Notmuch manual pages|manpages]]
+ * [Notmuch official documentation (manual pages)](https://notmuchmail.org/doc/latest/)
* [[Email clients and frontends|frontends]]
* [[General how-tos|howto]]
* [[Frequently Asked Questions|faq]]
* [[Email clients and frontends|frontends]]
* [[General how-tos|howto]]
* [[Frequently Asked Questions|faq]]
## Notmuch MDA -- `notmuch-insert`
## Notmuch MDA -- `notmuch-insert`
-The [[notmuch insert command|manpages/notmuch-insert-1]] is a tool for
+The [notmuch insert command](https://notmuchmail.org/doc/latest/man1/notmuch-insert.html) is a tool for
delivering emails to maildir, indexing them to the Notmuch database, and tagging
them as desired.
delivering emails to maildir, indexing them to the Notmuch database, and tagging
them as desired.
-The Notmuch Emacs interface uses the Notmuch [[command line interface|manpages]]
-to interact with the Notmuch database and your mail store. Please make sure
-you've [[set up Notmuch|getting-started]] first.
+The Notmuch Emacs interface uses the Notmuch [command line
+interface](https://notmuchmail.org/doc/latest/man1/notmuch.html) to
+interact with the Notmuch database and your mail store. Please make
+sure you've [[set up Notmuch|getting-started]] first.
What good is an advanced indexing mail client if we don't know how to
use it to actually find e-mail?
What good is an advanced indexing mail client if we don't know how to
use it to actually find e-mail?
-The [[notmuch-search-terms manual page|manpages/notmuch-search-terms-7]] should
-cover everything in a fairly concise manner. Please refer to that for any
-details.
+The [notmuch-search-terms manual
+pages](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html)
+should cover everything in a fairly concise manner. Please refer to
+that for any details.
Notmuch uses the [Xapian](http://xapian.org/) search engine. The [Xapian
QueryParser](http://xapian.org/docs/queryparser.html) documentation has
Notmuch uses the [Xapian](http://xapian.org/) search engine. The [Xapian
QueryParser](http://xapian.org/docs/queryparser.html) documentation has
For `<since>` and `<until>`, notmuch understands a variety of standard
and natural ways of expressing dates and times, both in absolute terms
For `<since>` and `<until>`, notmuch understands a variety of standard
and natural ways of expressing dates and times, both in absolute terms
-("2012-10-24") and in relative terms ("yesterday"). Please refer to the
-[[notmuch-search-terms manual page|manpages/notmuch-search-terms-7]] for
-details.
+("2012-10-24") and in relative terms ("yesterday"). Please refer to
+the [notmuch-search-terms
+manual](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html)
+for details.