notmuch clon
Find a file
Carl Worth 5e2a479e69 README: Add a simple file explaining notmuch and pointing out resources.
This is part of getting notmuch ready for a more public announcement.
2009-11-02 07:18:49 -08:00
.gitignore Add a simple manual page for notmuch. 2009-11-02 07:18:31 -08:00
AUTHORS Rename sha1.c to libsha1.c 2009-10-21 23:27:48 -07:00
COPYING Add copy of GNU General Public License (version 3). 2009-10-21 16:25:08 -07:00
COPYING-GPL-3 Add copy of GNU General Public License (version 3). 2009-10-21 16:25:08 -07:00
database-private.h Add full-text indexing using the GMime library for parsing. 2009-10-28 12:50:10 -07:00
database.cc notmuch show: Add a one-line summary of the message before the header. 2009-10-29 17:30:56 -07:00
date.c Add -Wwrite-strings and fix warnings. 2009-10-25 15:55:23 -07:00
index.cc index: Don't bother indexing quoted portions of messages (and signatures). 2009-10-28 15:41:42 -07:00
libsha1.c Rename sha1.c to libsha1.c 2009-10-21 23:27:48 -07:00
libsha1.h Add sha1.c and libsha1.h for doing SHA-1-based message-ID generation. 2009-10-21 21:33:02 -07:00
Makefile Add a simple manual page for notmuch. 2009-11-02 07:18:31 -08:00
message-file.c notmuch show: Add body of message as well. 2009-10-29 09:06:53 -07:00
message.cc notmuch show: Add a one-line summary of the message before the header. 2009-10-29 17:30:56 -07:00
message.h notmuch: Switch from gmime to custom, ad-hoc parsing of headers. 2009-10-19 13:00:43 -07:00
notmuch-completion.bash Add bash-completion script for notmuch. 2009-10-24 22:28:22 -07:00
notmuch-private.h notmuch search: Add (relative) date to search output 2009-10-29 17:31:07 -07:00
notmuch.1 Add a simple manual page for notmuch. 2009-11-02 07:18:31 -08:00
notmuch.c Add a simple manual page for notmuch. 2009-11-02 07:18:31 -08:00
notmuch.el notmuch.el: Add commands to add tag, remove tag, and archive (== remove inbox tag) 2009-10-31 12:09:06 -07:00
notmuch.h Rename message_results/thread_results to messages/threads. 2009-10-31 16:32:30 -07:00
query.cc Rename message_results/thread_results to messages/threads. 2009-10-31 16:32:30 -07:00
README README: Add a simple file explaining notmuch and pointing out resources. 2009-11-02 07:18:49 -08:00
sha1.c sha1: Add new notmuch_sha1_of_string function 2009-10-23 13:54:53 -07:00
tags.c tags: Replace sort() and reset() with prepare_iterator(). 2009-10-26 14:12:56 -07:00
thread.cc notmuch search: Add (relative) date to search output 2009-10-29 17:31:07 -07:00
TODO Add a simple manual page for notmuch. 2009-11-02 07:18:31 -08:00
xutil.c Add -Wextra and fix warnings. 2009-10-25 15:52:14 -07:00
xutil.h Add wrappers for regcomp and regexec to xutil.c. 2009-10-21 15:07:20 -07:00

Notmuch - thread-based email index, search and tagging.

Notmuch is a system for indexing, searching, reading, and tagging
large collections of email messages. It uses the Xapian library to
provide fast, full-text search of very large collection of email with
a very convenient search syntas.

Notmuch is free software, released under the GNU General Public
License version 3 (or later).

Building notmuch
----------------
See the INSTALL file for notes on compiling and installing notmuch.

Contacting users and developers
-------------------------------
The website for Notmuch is:

	http://notmuchmail.org

We will soon be creating a mailing list for users and developers of
notmuch. Details will appear on the website. Until then, please feel
free to email Carl with any questions you have:

	Carl Worth <cworth@cworth.org>

There is also an IRC channel dedicated to talk about using and
developing notmuch:

	IRC server:	irc.freenode.net
	Channel:	#notmuch

Interface options
-----------------
Notmuch includes a "notmuch" command-line interface to the system.
This is not a very convenient interface and it is not expected that
users will find it satisfying. Instead, there are two option for
obtaining a more sophisticated interface:

     1. Build on top of the "notmuch" command-line interface.

	This might be a reasonable option for a very text-oriented
	client environment. For example, an emacs-based interface for
	notmuch is already under development and is available in the
	notmuch.el file in this distribution.

	If someone were to write a curses-based interface, or similar,
	it might also be reasonable to buil on the "notmuch"
	command-line interface.

     2. Build on top of the notmuch library interface.

	This is a better choice for developing an interface that has
	full control of the presentation of email threads and
	messages. It is expected that anyone integrating Notmuch into
	an existing, graphical email program use the notmuch library
	interface.

	The public interface to the notmuch library is contained in
	the notmuch.h header file. The "notmuch" command-line program
	in notmuch.c can be used as good example code, since it is a
	simple program that is written on top of the library
	interface.

As can be seen, alternate interfaces to the Notmuch mail system are
still in development. We would appreciate any contributions to these
efforts.