[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
-# Why Notmuch?
+# Notmuch -- The mail indexer
+
+## Why Notmuch?
* "Not much mail" is what Notmuch thinks about your email
collection. Even if you receive 12000 messages per month or have on
that you can keep your inbox tamed and focus on what really matters
in your life, (which is surely not email).
-* Notmuch is an answer to <a href="http://sup.rubyforge.org/">Sup</a>.
+* Notmuch is an answer to [Sup](http://sup.rubyforge.org/).
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
* Notmuch is not much of an email program. It doesn't receive messages
(no POP or IMAP suport). It doesn't send messages (no mail composer,
no network code at all). And for what it does do (email search) that
- work is provided by an external library, <a
- href="http://xapian.org/">Xapian</a>. So if Notmuch provides no user
+ work is provided by an external library,
+ [Xapian](http://xapian.org). So if Notmuch provides no user
interface and Xapian does all the heavy lifting, then what's left
- here? Not much. </ul>
+ here? Not much.
Notmuch is still in the early stages of development, but there are
-already three user interfaces available for it (one for emacs, one for
-vim, and another using curses for running within a terminal). 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.
+already two user interfaces available for it (one for emacs and one
+for vim). 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.
Otherwise, 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.
-Either way, please feel free to jump in. All of the code for Notmuch
-is available as <a
-href="http://www.fsf.org/licensing/essays/free-sw.html">free
-software</a> released under the GNU
-<a href="http://www.fsf.org/licensing/licenses/gpl.html">GPL version
-3</a>. The latest versions
-can be checked out via git with this command:
+## News
+
+[[The latest news from notmuch|news]]
+
+## Documentation
+
+So far, there is not much documentation. Eventually, the wiki will
+contain a reference for users. This is what we have so far:
+
+ * [[General how-tos|howto]]
+ * [[Initial_Tagging]]
+ * [[Tips for using notmuch within Emacs|emacstips]]
+ * [[Remote Usage|remoteusage]]
+ * [[Performance|performance]]
+ * [[Available frontends|frontends]]
+
+Apart from the wiki, help is available via email. Join the mailing
+list. Read the archives. Ask questions.
+
+## Source code
+
+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](http://git.notmuchmail.org/git/notmuch) online. 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.
+
+Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
- git clone git://notmuchmail.org/git/notmuch
+There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
-Or you can browse the <a
-href="http://git.notmuchmail.org/git/notmuch">Notmuch code history</a>
-online. And finally, you can <a
-href="http://notmuchmail.org/mailman/listinfo/notmuch-commits">subscribe
-to the notmuch-commits list</a> to watch every commit made to notmuch
-(and to the notmuchmail.org web site).
+## Bug-tracking and patches
Patches are most welcome and should be sent to notmuch@notmuchmail.org.
-Please try to follow the [patch submission guidelines of the Git
-project](http://repo.or.cz/w/git.git?a=blob;f=Documentation/SubmittingPatches;hb=HEAD)
-when submitting patches to notmuch. We are currently test-driving a [Patchwork
-instance](http://patchwork.notmuchmail.org/project/notmuch) to help us keep track
-of [the patches](http://patchwork.notmuchmail.org/project/notmuch/list).
+Please try to follow the [[patch submission guidelines|patchformatting]]
+when submitting patches to notmuch.
+
+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 current patches can also be followed [[online|http://nmbug.tethera.net/status]].
+
+## Binary packages
+
+* [Debian](http://packages.debian.org/search?keywords=notmuch), [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
+* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
+
+## Screenshots
+
+* [[Emacs UI screenshots|screenshots]]
+
+## Contact: Email & IRC
Comments? Please feel free to email the notmuch mailing list:
notmuch@notmuchmail.org (subscription is not required, but you can
-<a href="http://notmuchmail.org/mailman/listinfo/notmuch">subscribe to
-the notmuch list</a> if you would like to). You can also browse the
-<a href="http://notmuchmail.org/pipermail/notmuch/">online archives</a>
-or the mailing list or download an <a href="http://notmuchmail.org/archives/notmuch.mbox">mbox file</a>
-of the entire mailing-list. The mb2md utility can then be used to
-convert the archives to maildir format which is convenient for
-reading the archives within notmuch itself.
+subscribe to the [notmuch
+list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would
+like to). You can also browse the [online
+archives](http://notmuchmail.org/pipermail/notmuch/) of the mailing
+list, read them as a [web forum
+(nabble)](http://notmuch.198994.n3.nabble.com/), or download an
+[mbox file](http://notmuchmail.org/archives/notmuch.mbox) of the entire
+mailing-list.
+
+The `mb2md` utility can be used to convert the archives to maildir
+format which is convenient for reading the archives within notmuch
+itself.
+
+If you prefer real-time chat, there is often someone on the
+[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
+channel.
+
+## Feature ideas
-### Website
+We have started a [[feature requests|feature-requests]] page on this
+wiki. No, things you add there won't automatically get implemented -
+but it's a nice way to collect ideas.
-This wiki is maintained using [ikiwiki](http://ikiwiki.info). You can pull and
-push changes using the following URL (no authentication necessary):
+## Website
- git://notmuchmail.org/git/notmuch-wiki
+This wiki is maintained using
+[ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be
+found [[here|wikiwriteaccess]].
projects / notmuch-wiki / blobdiff