system to use within your text editor or in a terminal...
If you're the kind of person that gets excited about being able to
-write shell scripts for exploring or managing your email...
+write shell scripts for exploring and manipulating your email...
If you're a developer of an existing email program and would love a
good library interface for fast, global search with support for
Then notmuch may be exactly what you've been looking for.
+[[!toc levels=2]]
+
## Why is it named Notmuch?
* "Not much mail" is what Notmuch thinks about your email
Sup is a very good email program written by William Morgan (and
others) and is the direct inspiration for Notmuch. Notmuch began as
an effort to rewrite performance-critical pieces of Sup in C rather
- than ruby. From there, it grew into a separate project. One
+ than Ruby. From there, it grew into a separate project. One
significant contribution Notmuch makes compared to Sup is the
separation of the indexer/searcher from the user interface. (Notmuch
provides a library interface so that its indexing/searching/tagging
## News
-[[The latest news from notmuch|news]]
+[[Notmuch news|news]] (mostly release notes and changes).
-## Documentation
+## Getting Started
+
+To get started with Notmuch, just run "notmuch" at the command line.
+This command will walk you through initial setup, including specifying
+the location of your mail store and how to start the initial indexing.
+
+For a little more detailed guide, see [[Getting Started with
+Notmuch|getting-started]].
-To get started with notmuch, just run "notmuch" at the command line.
-The configuration wizard will walk you through initial setup,
-including specifying the location of your mail store and how to start
-the initial indexing. After that, come back and checkout our docs:
+## 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](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
+and a [[Mutt integration script|notmuch-mutt]].
+
+There are also many other [[email clients and frontends|frontends]] based on
+Notmuch.
+
+## Documentation
* [[Notmuch manual pages|manpages]]
+ * [[Email clients and frontends|frontends]]
* [[General how-tos|howto]]
* [[Frequently Asked Questions|faq]]
* [[Searching]]
* [[Excluding and deleting messages|excluding]]
* [[Initial tagging|Initial_Tagging]]
- * [[Tips for using notmuch within Emacs|emacstips]]
- * [[Remote usage|remoteusage]]
+ * Tips for using Notmuch with [[Emacs|emacstips]], [[Vim|vimtips]], and [[Mutt|mutttips]]
+ * [[Emacs remote usage|remoteusage]]
* [[Performance|performance]]
* [[References|references]]
+ * [[Notmuch Library Language Bindings|bindings]]
Apart from the wiki, help is available via email and on IRC (see
below). Join the mailing list. Read the archives. Ask questions.
-## Email clients and front ends
-
-Notmuch ships with a powerful set of [[command-line tools|manpages]], an
-[[email client for Emacs|emacstips]], another
-[client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
-and a [[Mutt integration script|notmuch-mutt]].
-
-There are also many other [[email clients and frontends|frontends]] based on
-Notmuch. And a few tips about integrating it with [[Mutt|mutttips]] and [[Vim|vimtips]].
-
## Screenshots
* [[Emacs UI screenshots|screenshots]]
[Notmuch source releases](http://notmuchmail.org/releases/) are available as
source tar balls.
-Notmuch is packaged for at least the following distributions:
+Notmuch is packaged for at least the following operating systems and
+distributions:
* [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
* [Debian](http://packages.debian.org/search?keywords=notmuch)
* [Fedora](https://apps.fedoraproject.org/packages/notmuch)
* [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
+* [NetBSD](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html)
* [openSUSE](https://build.opensuse.org/search?search_text=notmuch)
+* OS X [Homebrew](https://github.com/Homebrew/homebrew/blob/master/Library/Formula/notmuch.rb), [MacPorts](https://www.macports.org/ports.php?by=name&substr=notmuch), or [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html).
* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
* [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
-Notmuch can be installed on Mac OS X using [MacPorts](https://www.macports.org/ports.php?by=name&substr=notmuch).
-
-## Development and Contributing
-
-All of the code for Notmuch is available as [free
-software](http://www.fsf.org/licensing/essays/free-sw.html) released
-under the GNU [GPL version
-3](http://www.fsf.org/licensing/licenses/gpl.html). The latest
-versions can be checked out via git with this command:
-
- git clone git://notmuchmail.org/git/notmuch
-
-You can browse the
-[Notmuch code history online](http://git.notmuchmail.org/git/notmuch). And
-finally, you can
-[subscribe to the `notmuch-commits` list](http://notmuchmail.org/mailman/listinfo/notmuch-commits)
-to watch every commit made to notmuch and the notmuchmail.org web
-site.
-
-We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
-its
-[configuration](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
-
-Contributions, such as patches, to Notmuch are most welcome. Please refer to the
-[[guide to contributing|contributing]].
-
-## Troubleshooting and reporting bugs
-
-For hints about troubleshooting and bug reporting see [[bugs]].
-
-For a list of known bugs see the [[nmbug status page|http://nmbug.tethera.net/status/#Bugs]]
-
## Contact: Email & IRC
Comments? Please feel free to email the notmuch mailing list:
-notmuch@notmuchmail.org (subscription is not required, but you can
+<mailto:notmuch@notmuchmail.org> (subscription is not required, but you can
also subscribe to the
[notmuch mailing list](http://notmuchmail.org/mailman/listinfo/notmuch)). You
can also browse the
itself.
If you prefer real-time chat, there is often someone on the
-[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
-channel.
+[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel. Don't
+ask if you can ask a question, just ask, and please wait for an answer, we might
+not be in your timezone.
+
+## Troubleshooting, Reporting Bugs and Feature Requests
+
+Please send bug reports and feature requests to the [Notmuch mailing
+list](http://notmuchmail.org/mailman/listinfo/notmuch)
+<mailto:notmuch@notmuchmail.org>.
+
+For hints about troubleshooting and bug reporting see [[bugs]].
-## Feature ideas
+Please see the [nmbug status page](http://nmbug.notmuchmail.org/status/) for
+lists of [known bugs](http://nmbug.notmuchmail.org/status/#Bugs) and [feature
+requests](http://nmbug.notmuchmail.org/status/#Wish-list).
-If you have a feature idea/request, please send it to the
-[mailing list](http://notmuchmail.org/mailman/listinfo/notmuch). You
-don't have to be subscribed to send, although there might be a delay
-for non-subscribers.
+## Development and Contributing
+
+All of the code for Notmuch is available as [free
+software](http://www.fsf.org/licensing/essays/free-sw.html) released
+under the GNU [GPL version
+3](http://www.fsf.org/licensing/licenses/gpl.html). The latest
+versions can be checked out via git with this command:
+
+ git clone git://notmuchmail.org/git/notmuch
+
+You can browse the [Notmuch code history
+online](http://git.notmuchmail.org/git/notmuch). A notification is sent to the
+[notmuch-commits mailing
+list](http://notmuchmail.org/mailman/listinfo/notmuch-commits) for every commit
+made to Notmuch and the notmuchmail.org web site. [The Notmuch OpenHub project
+page](https://www.openhub.net/p/notmuch) has a nice summary of the codebase and
+activity.
+
+Continuous integration build and test suite status: [![Build Status](https://travis-ci.org/notmuch/notmuch.svg?branch=master)](https://travis-ci.org/notmuch/notmuch)
+
+Contributions, such as patches, to Notmuch are most welcome. Please refer to the
+[[guide to contributing|contributing]].
## Website
-This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
-[[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents are
-mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].
+This website is a wiki, maintained using [ikiwiki](http://ikiwiki.info). Here
+are [[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents
+are mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].