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