X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=2c4ab9d336c7d087be26b787a1b09f8aaed1dcc6;hb=d6b503a121be3a00144329288109a99f41b615c4;hp=ebb37e09dfaa0ea673bc75a1a74cc309d7d17b4f;hpb=653e0f2c2a337264d666a05bb48893d7e90a5980;p=notmuch-wiki
diff --git a/index.mdwn b/index.mdwn
index ebb37e0..2c4ab9d 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -1,5 +1,24 @@
[[!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.
+
+[[!toc levels=2]]
+
+## 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
@@ -12,91 +31,154 @@
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-heliotrope.github.io/).
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
- than ruby. From there, it grew into a separate project. One
+ than Ruby. From there, it grew into a separate project. One
significant contribution Notmuch makes compared to Sup is the
separation of the indexer/searcher from the user interface. (Notmuch
provides a library interface so that its indexing/searching/tagging
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
-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.
+[[Notmuch news|news]] (mostly release notes and changes).
-## Documentation
+## Getting Started
-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.
-* [Initial Tagging](/initial_tagging)
-* [Emacstips](/emacstips)
+For a little more detailed guide, see [[Getting Started with
+Notmuch|getting-started]].
-Apart from the wiki, help is available via email. Join the mailing
-list. Read the archives. Ask questions.
+## Email Clients and Front Ends
-## Source code
+Notmuch ships with a powerful set of [[command-line tools|manpages]], an
+[[email client for Emacs|notmuch-emacs]], another
+[client for vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
+and a [[Mutt integration script|notmuch-mutt]].
-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:
+There are also many other [[email clients, frontends and tools|frontends]] based
+on 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.
+## Documentation
-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).
+ * [[Notmuch manual pages|manpages]]
+ * [[Email clients and frontends|frontends]]
+ * [[General how-tos|howto]]
+ * [[Frequently Asked Questions|faq]]
+ * [[Searching]]
+ * [[Excluding and deleting messages|excluding]]
+ * [[Initial tagging|Initial_Tagging]]
+ * Tips for using Notmuch with [[Emacs|emacstips]], [[Vim|vimtips]], and [[Mutt|mutttips]]
+ * [[Emacs remote usage|remoteusage]]
+ * [[Performance|performance]]
+ * [[References|references]]
+ * [[Notmuch Library Language Bindings|bindings]]
+
+Apart from the wiki, help is available via email and on IRC (see
+below). Join the mailing list. Read the archives. Ask questions.
+
+## Screenshots
+
+* [[Emacs UI screenshots|screenshots]]
+
+## Obtaining Notmuch
+
+[Notmuch source releases](https://notmuchmail.org/releases/) are available as
+source tar balls.
+
+Notmuch is packaged for at least the following operating systems and
+distributions:
+
+* [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
+* [Debian](http://packages.debian.org/search?keywords=notmuch)
+* [Fedora](https://apps.fedoraproject.org/packages/notmuch)
+* [FreeBSD](http://www.freshports.org/mail/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-core/blob/09baa1c3f5a30f8450d2145d4fd988e4b4d48070/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)
## 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.
+ (subscription is not required, but you can
+also subscribe to the
+[notmuch mailing list](https://notmuchmail.org/mailman/listinfo/notmuch)). You
+can also browse the
+[online list archives](https://notmuchmail.org/pipermail/notmuch/),
+read them as a
+[web forum (nabble)](http://notmuch.198994.n3.nabble.com/), or
+download an [mbox file](https://notmuchmail.org/archives/notmuch.mbox)
+of the entire mailing-list.
+
+### Another mailing list
+
+Currently the mailing list at notmuchmail.org is not working much, so
+we have a temporary (?) list at
+[freelists.org](https://www.freelists.org/list/notmuch). Feel free to
+subscribe if you like, and to CC both lists with problem reports.
+
+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. Don't
+ask if you can ask a question, just ask, and please wait for an answer, we might
+not be in your timezone.
+
+## Troubleshooting, Reporting Bugs and Feature Requests
+
+Please send bug reports and feature requests to the [Notmuch mailing
+list](https://notmuchmail.org/mailman/listinfo/notmuch)
+.
+
+For hints about troubleshooting and bug reporting see [[bugs]].
+
+Please see the [nmbug status page](http://nmbug.notmuchmail.org/status/) for
+lists of [known bugs](http://nmbug.notmuchmail.org/status/#Bugs) and [feature
+requests](http://nmbug.notmuchmail.org/status/#Wish-list).
+
+## Development and Contributing
+
+All of the code for Notmuch is available as [free
+software](https://www.fsf.org/licensing/essays/free-sw.html) released
+under the GNU [GPL version
+3](https://www.fsf.org/licensing/licenses/gpl.html). The latest
+versions can be checked out via git with this command:
-The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself.
+ git clone git://notmuchmail.org/git/notmuch
-If you prefer real-time chat, there is often someone on the [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel.
+You can browse the [Notmuch code history
+online](https://git.notmuchmail.org/git/notmuch). A notification is sent to the
+[notmuch-commits mailing
+list](https://notmuchmail.org/mailman/listinfo/notmuch-commits) for every commit
+made to Notmuch and the notmuchmail.org web site. [The Notmuch OpenHub project
+page](https://www.openhub.net/p/notmuch) has a nice summary of the codebase and
+activity.
-## Emacs Tips and Tricks
+Continuous integration build and test suite status: [![Build Status](https://travis-ci.org/notmuch/notmuch.svg?branch=master)](https://travis-ci.org/notmuch/notmuch)
-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).
+Contributions, such as patches, to Notmuch are most welcome. Please refer to the
+[[guide to contributing|contributing]].
-### 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 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]].