X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=9cc052f32e4aa0a823271b1de44f8f8448da60c1;hb=879df316752d69945562ab6c54ebf09f40a1a678;hp=aacdbf65db7ef0e2cc0326ac82f7c977fb922f30;hpb=a2f65066c3971aece4cb5df8bf48d61a1b315384;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index aacdbf6..9cc052f 100644 --- a/index.mdwn +++ b/index.mdwn @@ -14,7 +14,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 @@ -25,12 +25,12 @@ 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 two user interfaces available for it (one for emacs and one @@ -43,70 +43,96 @@ 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 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](/initial_tagging) -* [Emacstips](/emacstips) -* [Remote Usage](/remoteusage) + * [[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 -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: +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 + git clone git://notmuchmail.org/git/notmuch -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 the notmuchmail.org web site. +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/). + +There is a buildbot [here](http://buildbot.notmuchmail.org/grid) (configuration [here](https://github.com/tomprince/buildbot-configs/tree/notmuch)). + +## 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. -Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/). +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 -subscribe to the [notmuch list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would like to). You can also browse the -online archives -of the mailing list, read them as a web forum (nabble), or download a mbox file 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. +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. -## Feature ideas - bin list +The `mb2md` utility can be used to convert the archives to maildir +format which is convenient for reading the archives within notmuch +itself. -We have started a 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 prefer real-time chat, there is often someone on the +[#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC +channel. -## Emacs Tips and Tricks +## Feature ideas -The best supported interface to notmuch is based on emacs and can be tweaked extensively. We have started to collect some tips and tricks [here](/emacstips). +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. -### Website +## Website This wiki is maintained using [ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be -found [here](/wikiwriteaccess). +found [[here|wikiwriteaccess]].