X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=4b0fbc8fd3a493a8996cc7142d095d21ef9ca028;hb=d180d9ac638424ce594204c2a6d9923e169282b8;hp=4a55b784636d7e54164e9cf220f139f5c8268ada;hpb=4eec3beb80ff596ced2be515c64185c01903fb45;p=obsolete%2Fnotmuch-wiki diff --git a/index.mdwn b/index.mdwn index 4a55b78..4b0fbc8 100644 --- a/index.mdwn +++ b/index.mdwn @@ -51,12 +51,11 @@ looking for. 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]] * [[Searching]] * [[Excluding and deleting messages|excluding]] * [[Initial tagging|Initial_Tagging]] @@ -64,20 +63,39 @@ docs: * [[Remote usage|remoteusage]] * [[Performance|performance]] -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. ## Screenshots * [[Emacs UI screenshots|screenshots]] -## Binary packages +## Obtaining Notmuch -* [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/) +[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) -## Source code +## Development and Contributing All of the code for Notmuch is available as [free software](http://www.fsf.org/licensing/essays/free-sw.html) released @@ -85,43 +103,44 @@ 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. + git clone git://notmuchmail.org/git/notmuch -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 @@ -139,6 +158,5 @@ but it's a nice way to collect ideas. ## 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]].