notmuch clon
Find a file
Stefan Schmidt 0414c774d2 INSTALL: emacs install dokumentation.
Write down the steps needed to install and actuall use notmuch in emacs. Should
help emacs newbies.

Signed-off-by: Stefan Schmidt <stefan@datenfreihafen.org>
2009-11-21 21:34:25 +01:00
contrib Checkin some command-only tcsh completions 2009-11-20 18:15:19 +01:00
lib When a search query triggers a Xapian exception, log what the query was. 2009-11-21 00:18:15 +01:00
packaging/fedora notmuch build: add a RPM spec file 2009-11-20 10:37:38 +01:00
.gitignore Improve installation of emacs mode. 2009-11-20 10:34:29 +01:00
AUTHORS Drop date.c file, (use identical function from GMime instead). 2009-11-02 14:36:33 -08:00
configure Add a simple configure script. 2009-11-02 09:11:37 -08: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
gmime-filter-reply.c Filter out carriage-returns in show and reply output. 2009-11-18 23:34:43 +01:00
gmime-filter-reply.h Typsos 2009-11-18 03:21:36 -08:00
INSTALL INSTALL: emacs install dokumentation. 2009-11-21 21:34:25 +01:00
Makefile Makefile: Fix the fallback emacs install path. 2009-11-21 11:40:37 +01:00
Makefile.config Make bash completion directory configurable. 2009-11-21 00:14:06 +01:00
Makefile.local Make bash completion directory configurable. 2009-11-21 00:14:06 +01:00
notmuch-client.h notmuch help: Update documentation (following recent text from notmuch.1) 2009-11-17 23:37:21 -08:00
notmuch-config.c Deal with situation where sysconf(_SC_GETPW_R_SIZE_MAX) returns -1 2009-11-17 12:27:49 -08:00
notmuch-dump.c libnotmuch: Underlying support for doing partial-results searches. 2009-11-12 16:47:27 -08:00
notmuch-new.c Revert "notmuch: Add Maildir directory name as tag name for messages" 2009-11-21 21:21:58 +01:00
notmuch-reply.c notmuch reply: Include text parts in reply, even with disposition attachment. 2009-11-21 01:14:01 +01:00
notmuch-restore.c notmuch restore was skipping entries with no new tags 2009-11-16 12:03:05 -08:00
notmuch-search.c notmuch search: Avoid infinite stream of exceptions from "notmuch search" 2009-11-18 03:29:30 -08:00
notmuch-setup.c notmuch new: Unbreak after the addition of notmuch-config. 2009-11-11 19:50:15 -08:00
notmuch-show.c notmuch show: Don't hide text parts, even with disposition attachment. 2009-11-21 01:10:25 +01:00
notmuch-tag.c Make reply/show/tag all require at least one search term 2009-11-18 23:37:35 +01:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.1 notmuch.1: Fix a couple of typos. 2009-11-17 23:36:44 -08:00
notmuch.c notmuch main(): Remove stale comment. 2009-11-18 05:22:14 -08:00
notmuch.desktop Add a .desktop file entry. 2009-11-20 10:36:15 +01:00
notmuch.el notmuch.el: Don't use end-of-buffer which is inappropriate from programs 2009-11-21 00:58:16 +01:00
query-string.c notmuch: Break notmuch.c up into several smaller files. 2009-11-10 12:03:05 -08:00
README README: Mention the actual mailing list address now that it exists. 2009-11-18 03:24:27 -08:00
show-message.c notmuch show: Don't hide a digital signature. 2009-11-21 01:00:41 +01:00
TODO TODO: Add notes on portability, and remove completed tasks. 2009-11-21 19:54:24 +01: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 syntax.

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

The mailing list address for the notmuch community is:

	notmuch@notmuchmail.org

We welcome any sort of questions, comments, kudos, or code there.

Subscription is not required, (but if you do subscribe you'll avoid
any delay due to moderation). See the website for subscription
information.

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 build 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.