X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=index.mdwn;h=15332a65204000556da67eff538870bf98b41401;hb=6af7f7dbf56bba07b8e3dcd567f51230c230b8d4;hp=f41baf5532d50374d082e9e6f7dd66ebc2a215b5;hpb=5ea22718b4fa164a6eea415cc0eec8462e0ed634;p=notmuch-wiki diff --git a/index.mdwn b/index.mdwn index f41baf5..15332a6 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,79 +31,146 @@ 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. - -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. - -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. - - -## 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: - - 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. - -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). + here? Not much. + +## News + +[[Notmuch news|news]] (mostly release notes and changes). + +## Getting Started + +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. + +For a little more detailed guide, see [[Getting Started with +Notmuch|getting-started]]. + +## Email Clients and Front Ends + +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]]. + +There are also many other [[email clients and frontends|frontends]] based on +Notmuch. + +## Documentation + + * [[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](http://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) +* [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) ## 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 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](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. 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](http://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](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 -The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself. +You can browse the [Notmuch code history +online](http://git.notmuchmail.org/git/notmuch). A notification is sent to the +[notmuch-commits mailing +list](http://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. -If you prefer real-time chat, there is often someone on the IRC channel #notmuch@irc.freenode.net. +Continuous integration build and test suite status: [![Build Status](https://travis-ci.org/notmuch/notmuch.svg?branch=master)](https://travis-ci.org/notmuch/notmuch) -### Website +Contributions, such as patches, to Notmuch are most welcome. Please refer to the +[[guide to contributing|contributing]]. -This wiki is maintained using [ikiwiki](http://ikiwiki.info). You can pull and -push changes using the following URL (no authentication necessary): +## Website - git://notmuchmail.org/git/notmuch-wiki +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]].