new file: news/release-0.21.mdwn

[notmuch-wiki] / index.mdwn

diff --git a/index.mdwn b/index.mdwn
index 578cb1834125dbb8746cf22633d11e43b06c932f..cc684bf463d11ac8215b60c1d4c2729e6a8a720f 100644 (file)
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,5 +1,22 @@
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]

-# Why Notmuch?
+# Notmuch -- Just an email system
+
+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...
+
+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
 
 * "Not much mail" is what Notmuch thinks about your email
   collection. Even if you receive 12000 messages per month or have on


@@ -12,7 +29,7 @@
   that you can keep your inbox tamed and focus on what really matters
   in your life, (which is surely not email).
 
   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 <a href="http://sup.rubyforge.org/">Sup</a>.
+* Notmuch is an answer to [Sup](http://supmua.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
   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,80 +40,131 @@
   features can be integrated into any email program.)
 
 * Notmuch is not much of an email program. It doesn't receive messages
   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
   no network code at all). And for what it does do (email search) that

-  work is provided by an external library, <a
-  href="http://xapian.org/">Xapian</a>. 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
   interface and Xapian does all the heavy lifting, then what's left

-  here? Not much.  </ul>
+  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
-reader to use within your text editor or in a terminal, then Notmuch
-may be exactly what you've been looking for.
+## News

 
 

-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.
+[[The latest news from notmuch|news]]

 
 ## Documentation
 
 
 ## 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.
+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:

 
 

-* [[initialtagging|Initial Tagging]]
-* [[emacstips|Emacs Tips]]
+  * [[Notmuch manual pages|manpages]]
+  * [[General how-tos|howto]]
+  * [[Frequently Asked Questions|faq]]
+  * [[Searching]]
+  * [[Excluding and deleting messages|excluding]]
+  * [[Initial tagging|Initial_Tagging]]
+  * [[Tips for using notmuch within Emacs|emacstips]]
+  * [[Remote usage|remoteusage]]
+  * [[Performance|performance]]
+  * [[References|references]]
+  * [[Notmuch Library Language Bindings|bindings]]

 
 

-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.

 
 

-## Source code
+## Email clients and front ends

 
 

-Either way, please feel free to jump in. All of the code for Notmuch
-is available as <a
-href="http://www.fsf.org/licensing/essays/free-sw.html">free
-software</a> released under the GNU 
-<a href="http://www.fsf.org/licensing/licenses/gpl.html">GPL version 
-3</a>. The latest versions
-can be checked out via git with this command:
+Notmuch ships with a powerful set of [[command-line tools|manpages]], an
+[[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]].

 
 

-       git clone git://notmuchmail.org/git/notmuch
+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]].

 
 

-You can browse the <a
-href="http://git.notmuchmail.org/git/notmuch">Notmuch code history</a>
-online. And finally, you can <a
-href="http://notmuchmail.org/mailman/listinfo/notmuch-commits">subscribe
-to the notmuch-commits list</a> to watch every commit made to notmuch
-and the notmuchmail.org web site.
+## Screenshots

 
 

-Patches are most welcome and should be sent to notmuch&#64;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).
+* [[Emacs UI screenshots|screenshots]]

 
 

-## Contact: Email & IRC
+## Obtaining Notmuch

 
 

-Comments? Please feel free to email the notmuch mailing list:
-notmuch&#64;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
-<a href="http://notmuchmail.org/pipermail/notmuch/">online archives</a>
-of the mailing list, read them as a <a href="http://n3.nabble.com/notmuch-f198994.html">web forum (nabble)</a>, or download a <a href="http://notmuchmail.org/archives/notmuch.mbox">mbox file</a> of the entire mailing-list. 
+[Notmuch source releases](http://notmuchmail.org/releases/) are available as
+source tar balls.
+
+Notmuch is packaged for at least the following operating systems and
+distributions:

 
 

-The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself.
+* [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
+* [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)
+* OS X [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).
+* [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
+* [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)

 
 

-If you prefer real-time chat, there is often someone on the [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel.
+## Development and Contributing

 
 

-## Emacs Tips and Tricks
+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:

 
 

-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).
+        git clone git://notmuchmail.org/git/notmuch

 
 

-### Website
+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.

 
 

-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
+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]].
+
+## Troubleshooting and reporting bugs
+
+For hints about troubleshooting and bug reporting see [[bugs]].
+
+For a list of known bugs see the [[nmbug status page|http://nmbug.notmuchmail.org/status/#Bugs]]
+
+## Contact: Email & IRC
+
+Comments? Please feel free to email the notmuch mailing list:
+notmuch&#64;notmuchmail.org (subscription is not required, but you can
+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
+
+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.
+
+## Website
+
+This website is a wiki, maintained using [ikiwiki](http://ikiwiki.info). Here
+are [[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents
+are mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].