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

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