notmuch clon
Find a file
David Bremner bebf80ea68 test: use file based comparison for search '*' test
This seems a bit easier to maintain, and is more accurate since lines
are not joined together.
2011-12-31 22:59:58 -04:00
bindings Merge branch 'release' 2011-12-06 19:39:33 -04:00
compat fix sum moar typos [text files] 2011-06-23 15:40:50 -07:00
completion fix sum moar typos [build scripts, Makefiles] 2011-06-23 15:44:59 -07:00
contrib contrib/.gitattributes: remove 2011-12-06 11:20:57 -04:00
debian debian: install split man pages. 2011-12-31 15:16:32 -04:00
emacs emacs: Enable more text/plain hook functions by default. 2011-12-28 13:28:54 -04:00
lib Ignore encrypted parts when indexing. 2011-12-29 17:44:43 -04:00
man force install notmuch-setup.1 symlink 2011-12-31 15:16:32 -04:00
packaging fix sum moar typos [text files] 2011-06-23 15:40:50 -07:00
test test: use file based comparison for search '*' test 2011-12-31 22:59:58 -04:00
util build-system: clean $(libutil_modules) rather than listing them individually. 2011-12-12 11:54:16 -04:00
vim vim: fix citation/signature fold lengths 2011-07-16 21:57:38 +03:00
.dir-locals.el Add dir-locals style variables for C++, Elisp, and shell code. 2011-06-23 16:34:57 -07:00
.gitignore Ignore dynamic libraries on OS X. 2011-12-17 21:50:05 -04:00
AUTHORS Drop date.c file, (use identical function from GMime instead). 2009-11-02 14:36:33 -08:00
command-line-arguments.c command-line-arguments.[ch]: make arrays of keyword descriptors const 2011-12-13 00:00:44 -04:00
command-line-arguments.h command-line-arguments.[ch]: make arrays of keyword descriptors const 2011-12-13 00:00:44 -04:00
configure Separate Emacs misc. files dir. from Emacs code dir. 2011-10-28 14:07:44 -03: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
debugger.c notmuch-new: Only install SIGALRM if not running under gdb 2009-11-22 05:36:36 +01:00
gmime-filter-headers.c notmuch: Fix off-by-one errors if a header is >200 characters long. 2010-06-01 16:09:29 -07:00
gmime-filter-headers.h fix sum moar typos [comments in source code] 2011-06-23 15:58:39 -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
hooks.c cli: introduce the concept of user defined hooks 2011-12-11 13:57:31 -04:00
INSTALL INSTALL/README: Clean up the description of how to run the emacs interface. 2010-06-01 10:51:42 -07:00
json.c json_quote_chararray: Always return a newly talloced array 2010-04-20 08:55:31 -07:00
Makefile build-system: update for split man pages 2011-12-31 15:16:32 -04:00
Makefile.local build-system: update for split man pages 2011-12-31 15:16:32 -04:00
mime-node.c Utility function to seek in MIME trees in depth-first order. 2011-12-25 22:21:04 -04:00
NEWS cli: add support for pre and post notmuch new hooks 2011-12-11 13:58:15 -04:00
notmuch-client.h Utility function to seek in MIME trees in depth-first order. 2011-12-25 22:21:04 -04:00
notmuch-config.c cli: factor out config handling code to get/set lists. 2011-12-12 11:16:01 -04:00
notmuch-count.c cli: add support for --output parameter in notmuch count 2011-11-15 19:20:27 -04:00
notmuch-dump.c notmuch-dump: convert to command-line-arguments 2011-12-08 20:24:24 -04:00
notmuch-new.c notmuch: Quiet buildbot warnings. 2011-12-21 07:32:16 -04:00
notmuch-reply.c show: Pass notmuch_message_t instead of path to show_message_body. 2011-12-25 22:17:27 -04:00
notmuch-restore.c notmuch-restore: convert to command-line-arguments 2011-12-08 20:24:24 -04:00
notmuch-search.c notmuch-search: convert to command-line-arguments 2011-12-08 20:24:24 -04:00
notmuch-setup.c notmuch setup: Don't prompt about maildir synchronization 2010-11-11 03:53:14 -08:00
notmuch-show.c show: Pass notmuch_message_t instead of path to show_message_body. 2011-12-25 22:17:27 -04:00
notmuch-tag.c notmuch: Quiet buildbot warnings. 2011-12-21 07:32:16 -04:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.c notmuch: replace built-in help with exec of man 2011-12-31 15:16:32 -04:00
notmuch.desktop notmuch.desktop: Clarify that this is the emacs interface to notmuch. 2010-01-24 07:30:08 +13:00
query-string.c notmuch: Break notmuch.c up into several smaller files. 2009-11-10 12:03:05 -08:00
README INSTALL/README: Clean up the description of how to run the emacs interface. 2010-06-01 10:51:42 -07:00
RELEASING RELEASING: document the semi-automated version propagation. 2011-11-19 10:09:25 -04:00
show-message.c show: Rewrite show_message_body to use the MIME tree interface. 2011-12-25 22:23:15 -04:00
TODO TODO: Add note to fix race condition with directory mtime. 2011-06-29 14:07:06 -07:00
version version: bump for bugfix release 0.10.2 2011-12-05 18:07:00 -04:00

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

Notmuch is a system for indexing, searching, reading, and tagging
large collections of email messages in maildir or mh format. It uses
the Xapian library to provide fast, full-text search with a 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.

Running notmuch
---------------
After installing notmuch, start by running "notmuch setup" which will
interactively prompt for configuration information such as your name,
email address, and the directory which contains your mail archive to
be indexed. You can change any answers later by running "notmuch
setup" again or by editing the .notmuch-config file in your home
directory.

With notmuch configured you should next run "notmuch new" which will
index all of your existing mail. This can take a long time, (several
hours) if you have a lot of email, (hundreds of thousands of
files). When new mail is delivered to your mail archive in the future,
you will want to run "notmuch new" again. These runs will be much
faster as they will only index new messages.

Finally, you can prove to yourself that things are working by running
some command-line searches such as "notmuch search
from:someone@example.com" or "notmuch search subject:topic". See
"notmuch help search-terms" for more details on the available search
syntax.

The command-line search output is not expected to be particularly
friendly for day-to-day usage. Instead, it is expected that you will
use an email interface that builds on the notmuch command-line tool or
the libnotmuch library.

Notmuch installs a full-featured email interface for use within
emacs. To use this, first add the following line to your .emacs file:

	(require 'notmuch)

Then, either run "emacs -f notmuch" or execute the command "M-x
notmuch" from within a running emacs.

If you're interested in a non-emacs-based interface to notmuch, then
please join the notmuch community. Various other interfaces are
already in progress, (an interface within vim, a curses interface,
graphical interfaces based on evolution, and various web-based
interfaces). The authors of these interfaces would love further
testing or contribution. See contact information below.

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