git.cworth.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 * "Not much mail" is what Notmuch thinks about your email
   7   collection. Even if you receive 12000 messages per month or have on
   8   the order of millions of messages that you've been saving for
   9   decades. Regardless, Notmuch will be able to quickly search all of
  10   it. It's just plain not much mail.
  11
  12 * "Not much mail" is also what you should have in your inbox at any
  13   time. Notmuch gives you what you need, (tags and fast search), so
  14   that you can keep your inbox tamed and focus on what really matters
  15   in your life, (which is surely not email).
  16
  17 * Notmuch is an answer to [Sup](http://sup.rubyforge.org/).
  18   Sup is a very good email program written by William Morgan (and
  19   others) and is the direct inspiration for Notmuch. Notmuch began as
  20   an effort to rewrite performance-critical pieces of Sup in C rather
  21   than ruby. From there, it grew into a separate project. One
  22   significant contribution Notmuch makes compared to Sup is the
  23   separation of the indexer/searcher from the user interface. (Notmuch
  24   provides a library interface so that its indexing/searching/tagging
  25   features can be integrated into any email program.)
  26
  27 * Notmuch is not much of an email program. It doesn't receive messages
  28   (no POP or IMAP suport). It doesn't send messages (no mail composer,
  29   no network code at all). And for what it does do (email search) that
  30   work is provided by an external library,
  31   [Xapian](http://xapian.org).  So if Notmuch provides no user
  32   interface and Xapian does all the heavy lifting, then what's left
  33   here? Not much.
  34
  35 Notmuch is still in the early stages of development, but there are
  36 already two user interfaces available for it (one for emacs and one
  37 for vim). If you've been looking for a fast, global-search and
  38 tag-based email reader to use within your text editor or in a
  39 terminal, then Notmuch may be exactly what you've been looking for.
  40
  41 Otherwise, if you're a developer of an existing email program and
  42 would love a good library interface for fast, global search with
  43 support for arbitrary tags, then Notmuch also may be exactly what
  44 you've been looking for.
  45
  46 ## Documentation
  47
  48 So far, there is not much documentation.  Eventually, the wiki will
  49 contain a reference for users.  This is what we have so far:
  50
  51   * [[General how-tos|howto]]
  52   * [[Initial_Tagging]]
  53   * [[Tips for using notmuch within Emacs|emacstips]]
  54   * [[Remote Usage|remoteusage]]
  55
  56 Apart from the wiki, help is available via email.  Join the mailing
  57 list.  Read the archives.  Ask questions.
  58
  59 ## Source code
  60
  61 Either way, please feel free to jump in. All of the code for Notmuch
  62 is available as [free
  63 software](http://www.fsf.org/licensing/essays/free-sw.html) released
  64 under the GNU [GPL version
  65 3](http://www.fsf.org/licensing/licenses/gpl.html). The latest
  66 versions can be checked out via git with this command:
  67
  68         git clone git://notmuchmail.org/git/notmuch
  69
  70 You can browse the [Notmuch code
  71 history](http://git.notmuchmail.org/git/notmuch) online. And finally,
  72 you can [subscribe to the `notmuch-commits`
  73 list](http://notmuchmail.org/mailman/listinfo/notmuch-commits) to watch
  74 every commit made to notmuch and the notmuchmail.org web site.
  75
  76 Patches are most welcome and should be sent to notmuch&#64;notmuchmail.org.
  77 Please try to follow the [patch submission guidelines of the Git
  78 project](http://repo.or.cz/w/git.git?a=blob;f=Documentation/SubmittingPatches;hb=HEAD)
  79 when submitting patches to notmuch. We are currently test-driving a [Patchwork
  80 instance](http://patchwork.notmuchmail.org/project/notmuch) to help us keep track
  81 of [the patches](http://patchwork.notmuchmail.org/project/notmuch/list).
  82
  83 Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
  84
  85 ## Binary packages
  86
  87 * [Debian](http://packages.debian.org/search?keywords=notmuch), [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
  88
  89 ## Screenshots
  90
  91 * [[Emacs UI screenshots|screenshots]]
  92
  93 ## Contact: Email & IRC
  94
  95 Comments? Please feel free to email the notmuch mailing list:
  96 notmuch&#64;notmuchmail.org (subscription is not required, but you can
  97 subscribe to the [notmuch
  98 list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would
  99 like to). You can also browse the [online
 100 archives](http://notmuchmail.org/pipermail/notmuch/) of the mailing
 101 list, read them as a [web forum
 102 (nabble)](http://notmuch.198994.n3.nabble.com/), or download an
 103 [mbox file](http://notmuchmail.org/archives/notmuch.mbox) of the entire
 104 mailing-list.
 105
 106 The `mb2md` utility can be used to convert the archives to maildir
 107 format which is convenient for reading the archives within notmuch
 108 itself.
 109
 110 If you prefer real-time chat, there is often someone on the
 111 [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC
 112 channel.
 113
 114 ## Feature Ideas
 115
 116 We have started a [[feature requests|feature-requests]] page on this
 117 wiki.  No, things you add there won't automatically get implemented -
 118 but it's a nice way to collect ideas.
 119
 120 ### Website
 121
 122 This wiki is maintained using
 123 [ikiwiki](http://ikiwiki.info). Instructions on how to edit it can be
 124 found [[here|wikiwriteaccess]].