X-Git-Url: https://git.cworth.org/git?p=obsolete%2Fnotmuch-wiki;a=blobdiff_plain;f=index.mdwn;h=c2160268a67c143ef39611473633d4e86ace7a1d;hp=d2b02f5b5c8a49f543e1367f3a7aa8d2fef8f3f1;hb=HEAD;hpb=8ac9d484a5bacbde77ea380e2eaac0d3c5a89e78 diff --git a/index.mdwn b/index.mdwn index d2b02f5..c216026 100644 --- a/index.mdwn +++ b/index.mdwn @@ -1,4 +1,9 @@ -# Why Notmuch? +[[!img notmuch-logo.png alt="Notmuch logo" class="left"]] +# Notmuch -- The mail indexer + +## Why Notmuch? + +Because dealing with your mail can be so much better. * "Not much mail" is what Notmuch thinks about your email collection. Even if you receive 12000 messages per month or have on @@ -11,7 +16,7 @@ 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 Sup. +* 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 @@ -22,62 +27,137 @@ features can be integrated into any email program.) * 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 POP or IMAP support). 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, Xapian. 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. + 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 +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 free -software released under the GNU -GPL version -3. The latest versions -can be checked out via git with this command: - - git clone git://notmuchmail.org/git/notmuch - -Or you can browse the Notmuch code history -online. And finally, you can subscribe -to the notmuch-commits list to watch every commit made to notmuch -(and to the notmuchmail.org web site). - -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). +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 + +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: + + * [[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]] + * [[Performance|performance]] + +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:/contrib/notmuch-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]] + +## Obtaining Notmuch + +[Notmuch source releases](http://notmuchmail.org/releases/) are available as +source tar balls. + +Notmuch is packaged for the following distributions: + +* [Debian](http://packages.debian.org/search?keywords=notmuch) (Please use at + least the packages from squeeze-backports, squeeze packages are very + outdated!) +* [Fedora](https://community.dev.fedoraproject.org/packages/notmuch) +* [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch) +* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/) +* [Ubuntu](http://packages.ubuntu.com/search?keywords=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]]. + +## 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]]. The status of bugs and 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 if you would like to). You can also browse the -online archives -or the mailing list or download an mbox file -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. +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 +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 +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. -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). Here are +[[instructions on how to edit the wiki|wikiwriteaccess]].