git.notmuchmail.org Git - notmuch-wiki/blob - index.mdwn

   1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
   2 # Notmuch -- The mail indexer
   3
   4 ## Why Notmuch?
   5
   6 Because dealing with your mail can be so much better.
   7
   8 * "Not much mail" is what Notmuch thinks about your email
   9   collection. Even if you receive 12000 messages per month or have on
  10   the order of millions of messages that you've been saving for
  11   decades. Regardless, Notmuch will be able to quickly search all of
  12   it. It's just plain not much mail.
  13
  14 * "Not much mail" is also what you should have in your inbox at any
  15   time. Notmuch gives you what you need, (tags and fast search), so
  16   that you can keep your inbox tamed and focus on what really matters
  17   in your life, (which is surely not email).
  18
  19 * Notmuch is an answer to [Sup](http://sup.rubyforge.org/).
  20   Sup is a very good email program written by William Morgan (and
  21   others) and is the direct inspiration for Notmuch. Notmuch began as
  22   an effort to rewrite performance-critical pieces of Sup in C rather
  23   than ruby. From there, it grew into a separate project. One
  24   significant contribution Notmuch makes compared to Sup is the
  25   separation of the indexer/searcher from the user interface. (Notmuch
  26   provides a library interface so that its indexing/searching/tagging
  27   features can be integrated into any email program.)
  28
  29 * Notmuch is not much of an email program. It doesn't receive messages
  30   (no POP or IMAP support). It doesn't send messages (no mail composer,
  31   no network code at all). And for what it does do (email search) that
  32   work is provided by an external library,
  33   [Xapian](http://xapian.org).  So if Notmuch provides no user
  34   interface and Xapian does all the heavy lifting, then what's left
  35   here? Not much.
  36
  37 If you've been looking for a fast, global-search and tag-based email
  38 reader to use within your text editor or in a terminal, then Notmuch
  39 may be exactly what you've been looking for.
  40
  41 If you're a developer of an existing email program and would love a
  42 good library interface for fast, global search with support for
  43 arbitrary tags, then Notmuch also may be exactly what you've been
  44 looking for.
  45
  46 ## News
  47
  48 [[The latest news from notmuch|news]]
  49
  50 ## Documentation
  51
  52 To get started with notmuch, just run "notmuch" at the command line.
  53 The configuration wizard will walk you through initial setup,
  54 including specifying the location of your mail store and how to start
  55 the initial indexing.  After that, come back and checkout our docs:
  56
  57   * [[Notmuch manual pages|manpages]]
  58   * [[General how-tos|howto]]
  59   * [[Searching]]
  60   * [[Excluding and deleting messages|excluding]]
  61   * [[Initial tagging|Initial_Tagging]]
  62   * [[Tips for using notmuch within Emacs|emacstips]]
  63   * [[Remote usage|remoteusage]]
  64   * [[Performance|performance]]
  65
  66 Apart from the wiki, help is available via email and on IRC (see
  67 below).  Join the mailing list.  Read the archives.  Ask questions.
  68
  69 ## Email clients and front ends
  70
  71 Notmuch ships with a powerful set of [[command-line tools|manpages]], an
  72 [[email client for Emacs|emacstips]], another
  73 [client for vim](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
  74 and a [[Mutt integration script|notmuch-mutt]].
  75
  76 There are also many other [[email clients and frontends|frontends]] based on
  77 Notmuch.
  78
  79 ## Screenshots
  80
  81 * [[Emacs UI screenshots|screenshots]]
  82
  83 ## Obtaining Notmuch
  84
  85 [Notmuch source releases](http://notmuchmail.org/releases/) are available as
  86 source tar balls.
  87
  88 Notmuch is packaged for the following distributions:
  89
  90 * [Debian](http://packages.debian.org/search?keywords=notmuch) (Please use at
  91   least the packages from squeeze-backports, squeeze packages are very
  92   outdated!)
  93 * [Fedora](https://community.dev.fedoraproject.org/packages/notmuch)
  94 * [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
  95 * [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
  96 * [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
  97
  98 ## Development
  99
 100 All of the code for Notmuch is available as [free
 101 software](http://www.fsf.org/licensing/essays/free-sw.html) released
 102 under the GNU [GPL version
 103 3](http://www.fsf.org/licensing/licenses/gpl.html). The latest
 104 versions can be checked out via git with this command:
 105
 106         git clone git://notmuchmail.org/git/notmuch
 107
 108 You can browse the
 109 [Notmuch code history online](http://git.notmuchmail.org/git/notmuch). And
 110 finally, you can
 111 [subscribe to the `notmuch-commits` list](http://notmuchmail.org/mailman/listinfo/notmuch-commits)
 112 to watch every commit made to notmuch and the notmuchmail.org web
 113 site.
 114
 115 We have a [buildbot](http://buildbot.notmuchmail.org/grid) (here's
 116 its
 117 [configuration](https://github.com/tomprince/buildbot-configs/tree/notmuch)).
 118
 119 ## Bug-tracking and patches
 120
 121 Patches are most welcome and should be sent to notmuch&#64;notmuchmail.org.
 122 Please try to follow the [[patch submission guidelines|patchformatting]]
 123 when submitting patches.
 124
 125 The tagging and filtering features of notmuch make it quite suitable
 126 for use as a bug- and patch-tracker. We are currently experimenting
 127 with using it for this purpose for notmuch development, using a
 128 utility called [[nmbug]].  The status of current patches can also be
 129 followed [online](http://nmbug.tethera.net/status).
 130
 131 ## Contact: Email & IRC
 132
 133 Comments? Please feel free to email the notmuch mailing list:
 134 notmuch&#64;notmuchmail.org (subscription is not required, but you can
 135 also subscribe to the
 136 [notmuch mailing list](http://notmuchmail.org/mailman/listinfo/notmuch)). You
 137 can also browse the
 138 [online list archives](http://notmuchmail.org/pipermail/notmuch/),
 139 read them as a
 140 [web forum (nabble)](http://notmuch.198994.n3.nabble.com/), or
 141 download an [mbox file](http://notmuchmail.org/archives/notmuch.mbox)
 142 of the entire mailing-list.
 143
 144 The `mb2md` utility can be used to convert the archives to maildir
 145 format which is convenient for reading the archives within notmuch
 146 itself.
 147
 148 If you prefer real-time chat, there is often someone on the
 149 [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
 150 channel.
 151
 152 ## Feature ideas
 153
 154 We have started a [[feature requests|feature-requests]] page on this
 155 wiki.  No, things you add there won't automatically get implemented -
 156 but it's a nice way to collect ideas.
 157
 158 ## Website
 159
 160 This wiki is maintained using [ikiwiki](http://ikiwiki.info). Here are
 161 [[instructions on how to edit the wiki|wikiwriteaccess]].