1 Notmuch - thread-based email index, search and tagging.
3 Notmuch is a system for indexing, searching, reading, and tagging
4 large collections of email messages in maildir or mh format. It uses
5 the Xapian library to provide fast, full-text search with a convenient
8 Notmuch is free software, released under the GNU General Public
9 License version 3 (or later).
13 See the INSTALL file for notes on compiling and installing notmuch.
15 Contacting users and developers
16 -------------------------------
17 The website for Notmuch is:
19 http://notmuchmail.org
21 The mailing list address for the notmuch community is:
23 notmuch@notmuchmail.org
25 We welcome any sort of questions, comments, kudos, or code there.
27 Subscription is not required, (but if you do subscribe you'll avoid
28 any delay due to moderation). See the website for subscription
31 There is also an IRC channel dedicated to talk about using and
34 IRC server: irc.freenode.net
39 Notmuch includes a "notmuch" command-line interface to the system.
40 This is not a very convenient interface and it is not expected that
41 users will find it satisfying. Instead, there are two option for
42 obtaining a more sophisticated interface:
44 1. Build on top of the "notmuch" command-line interface.
46 This might be a reasonable option for a very text-oriented
47 client environment. For example, an emacs-based interface for
48 notmuch is already under development and is available in the
49 notmuch.el file in this distribution.
51 If someone were to write a curses-based interface, or similar,
52 it might also be reasonable to build on the "notmuch"
53 command-line interface.
55 2. Build on top of the notmuch library interface.
57 This is a better choice for developing an interface that has
58 full control of the presentation of email threads and
59 messages. It is expected that anyone integrating Notmuch into
60 an existing, graphical email program use the notmuch library
63 The public interface to the notmuch library is contained in
64 the notmuch.h header file. The "notmuch" command-line program
65 in notmuch.c can be used as good example code, since it is a
66 simple program that is written on top of the library
69 As can be seen, alternate interfaces to the Notmuch mail system are
70 still in development. We would appreciate any contributions to these