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 now to start
-the initial indexing. After that, come back and checkout how our
-docs:
+including specifying the location of your mail store and how to start
+the initial indexing. After that, come back and checkout our docs:
* [[Notmuch manual pages|manpages]]
* [[General how-tos|howto]]
- * [[Available frontends|frontends]]
+ * [[Frequently Asked Questions|faq]]
* [[Searching]]
* [[Excluding and deleting messages|excluding]]
* [[Initial tagging|Initial_Tagging]]
* [[Tips for using notmuch within Emacs|emacstips]]
* [[Remote usage|remoteusage]]
* [[Performance|performance]]
+ * [[References|references]]
-Apart from the wiki, help is available via email. Join the mailing
-list. Read the archives. Ask questions.
+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]]
-## Packages
+## Obtaining Notmuch
+
+[Notmuch source releases](http://notmuchmail.org/releases/) are available as
+source tar balls.
+Notmuch is packaged for at least the following distributions:
+
+* [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
* [Debian](http://packages.debian.org/search?keywords=notmuch)
-* [Fedora](https://community.dev.fedoraproject.org/packages/notmuch)
+* [Fedora](https://apps.fedoraproject.org/packages/notmuch)
* [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
+* [openSUSE](https://build.opensuse.org/search?search_text=notmuch)
* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
* [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
-## Source code
+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
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/).
+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.
-There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
+We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
+its
+[configuration](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
-## Bug-tracking and patches
+Contributions, such as patches, to Notmuch are most welcome. Please refer to the
+[[guide to contributing|contributing]].
-Patches are most welcome and should be sent to notmuch@notmuchmail.org.
-Please try to follow the [[patch submission guidelines|patchformatting]]
-when submitting patches to notmuch.
+## Bug and patch tracking
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]].
+utility called [[nmbug]]. The status of bugs and current patches can also be
+followed [online](http://nmbug.tethera.net/status).
-The status of current patches can also be followed [[online|http://nmbug.tethera.net/status]].
+Bug reports should be sent to the Notmuch mailing list notmuch@notmuchmail.org.
## Contact: Email & IRC
Comments? Please feel free to email the notmuch mailing list:
notmuch@notmuchmail.org (subscription is not required, but you can
-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.
+also subscribe to the
+[notmuch mailing list](http://notmuchmail.org/mailman/listinfo/notmuch)). You
+can also browse the
+[online list archives](http://notmuchmail.org/pipermail/notmuch/),
+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
## Feature ideas
-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.
+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.
## Website
-This wiki is maintained using
-[ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be
-found [[here|wikiwriteaccess]].
+This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
+[[instructions on how to edit the wiki|wikiwriteaccess]].
projects / notmuch-wiki / blobdiff