X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=4b0fbc8fd3a493a8996cc7142d095d21ef9ca028;hb=22d1c22ef966958a1615c1934095aaf4be257d94;hp=ec381705102ef17a2fb89564088902bb3d5d936f;hpb=c9f9c63e11d4b8aa534457b9ae042c5c1e34fef3;p=obsolete%2Fnotmuch-wiki
diff --git a/index.mdwn b/index.mdwn
index ec38170..4b0fbc8 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,5 +1,9 @@
[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
-# Why Notmuch?
+# 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
@@ -12,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
@@ -23,85 +27,136 @@
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.
+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
-So far, there is not much documentation. Eventually, the wiki will
-contain a reference for users. This is what we have so far:
+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:/vim/README),
+and a [[Mutt integration script|notmuch-mutt]].
+
+There are also many other [[email clients and frontends|frontends]] based on
+Notmuch.
+
+## Screenshots
-* [Initial Tagging](/initial_tagging)
-* [Emacstips](/emacstips)
+* [[Emacs UI screenshots|screenshots]]
-Apart from the wiki, help is available via email. Join the mailing
-list. Read the archives. Ask questions.
+## Obtaining Notmuch
-## Source code
+[Notmuch source releases](http://notmuchmail.org/releases/) are available as
+source tar balls.
-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:
+Notmuch is packaged for the following distributions:
- git clone git://notmuchmail.org/git/notmuch
+* [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)
-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.
+## Development and Contributing
-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).
+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](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.
+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.
-## 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).
\ No newline at end of file
+This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
+[[instructions on how to edit the wiki|wikiwriteaccess]].