[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
-# Notmuch -- The mail indexer
+# Notmuch -- Just an email system
-## Why Notmuch?
+If you've been looking for a fast, global-search and tag-based email
+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 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
+arbitrary tags...
+
+If you want the convenience of fast, reliable search of all your
+email, but don't want to give a 3rd-party access to your email...
-Because dealing with your mail can be so much better.
+Then notmuch may be exactly what you've been looking for.
+
+## Why is it named Notmuch?
* "Not much mail" is what Notmuch thinks about your email
collection. Even if you receive 12000 messages per month or have on
interface and Xapian does all the heavy lifting, then what's left
here? Not much.
-If you've been looking for a fast, global-search and tag-based email
-reader to use within your text editor or in a terminal, then Notmuch
-may be exactly what you've been looking for.
-
-If you're a developer of an existing email program and would love a
-good library interface for fast, global search with support for
-arbitrary tags, then Notmuch also may be exactly what you've been
-looking for.
-
## News
[[The latest news from notmuch|news]]
-## 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.
-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:
+For a little more detailed guide, see [[Getting Started with
+Notmuch|getting-started]].
+
+## 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]]
* [[General how-tos|howto]]
* [[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
Contributions, such as patches, to Notmuch are most welcome. Please refer to the
[[guide to contributing|contributing]].
-## Bug and patch tracking
+## Troubleshooting and reporting bugs
-The tagging and filtering features of notmuch make it quite suitable
-for use as a bug- and patch-tracker. We are currently experimenting
-with using it for this purpose for notmuch development, using a
-utility called [[nmbug]]. The status of bugs and current patches can also be
-followed [online](http://nmbug.tethera.net/status).
+For hints about troubleshooting and bug reporting see [[bugs]].
-Bug reports should be sent to the Notmuch mailing list notmuch@notmuchmail.org.
+For a list of known bugs see the [[nmbug status page|http://nmbug.notmuchmail.org/status/#Bugs]].
## Contact: Email & IRC
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.
## Feature ideas
## 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]].
projects / notmuch-wiki / blobdiff