X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=76f27721401a2bcf76b4d8f9a5326ca336da462c;hb=841fd6493f9fede3e3ea6fefabfe5e80a4b1b77f;hp=29c1ae503f2c259378f6ca38c30845884d69fcc0;hpb=066eccd38f279de63578230250632acb9589ece1;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index 29c1ae5..76f2772 100644 --- a/index.mdwn +++ b/index.mdwn @@ -1,9 +1,22 @@ [[!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 @@ -34,15 +47,6 @@ Because dealing with your mail can be so much better. 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]] @@ -50,9 +54,9 @@ looking for. ## Documentation 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: +This command 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 documentation: * [[Notmuch manual pages|manpages]] * [[General how-tos|howto]] @@ -71,7 +75,7 @@ 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 +[[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]]. @@ -93,11 +97,12 @@ Notmuch is packaged for at least the following distributions: * [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) * [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). +Notmuch can be installed on OS X using [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). ## Development and Contributing @@ -123,15 +128,11 @@ its 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