notmuch clon
Find a file
Carl Worth 2b3a219bc9 test: Fix PATH-checking test to work with --valgrind
The --valgrind option munges the PATH variable, so un-munge it before
testing that we have PATH pointing to the source directory.
2010-09-20 15:07:26 -07:00
bindings/python python: have docs reflect current return value behavior 2010-05-18 11:11:59 -07:00
compat
completion
debian
emacs emacs: Allow '|' to operate on multiple messages (by means of prefix argument). 2010-09-16 15:52:12 -07:00
lib lib: Fix use-after-free bug. 2010-09-20 22:01:52 +00:00
packaging
test test: Fix PATH-checking test to work with --valgrind 2010-09-20 15:07:26 -07:00
vim
.gitignore
AUTHORS
configure make install: Run ldconfig or install a DT_RUNPATH in binary as appropriate. 2010-06-04 16:52:56 -07:00
COPYING
COPYING-GPL-3
debugger.c
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
gmime-filter-reply.c
gmime-filter-reply.h
INSTALL INSTALL/README: Clean up the description of how to run the emacs interface. 2010-06-01 10:51:42 -07:00
json.c
Makefile test: Fix test suite to integrate with our non-recursive Makefile system. 2010-09-17 12:16:10 -07:00
Makefile.local test: Fix test suite to integrate with our non-recursive Makefile system. 2010-09-17 12:16:10 -07:00
NEWS NEWS: Document the new "notmuch show --format=mbox" format 2010-06-08 20:21:16 -07:00
notmuch-client.h
notmuch-config.c Avoid segmentation fault with NOTMUCH_CONFIG=/new/config/file notmuch setup 2010-07-19 17:16:18 -07:00
notmuch-count.c
notmuch-dump.c
notmuch-new.c
notmuch-reply.c
notmuch-restore.c
notmuch-search-tags.c
notmuch-search.c
notmuch-setup.c notmuch setup: Prompt for tags to set on new messages. 2010-04-23 10:30:40 -07:00
notmuch-show.c notmuch show: Add a --format=mbox option 2010-06-08 19:45:54 -07:00
notmuch-tag.c
notmuch-time.c
notmuch.1 notmuch show: Add documentation of --format=mbox 2010-09-16 14:47:32 -07:00
notmuch.c notmuch show: Add documentation of --format=mbox 2010-09-16 14:47:32 -07:00
notmuch.desktop
query-string.c
README INSTALL/README: Clean up the description of how to run the emacs interface. 2010-06-01 10:51:42 -07:00
RELEASING
show-message.c
TODO TODO: Add idea for fixing "notmuch count" to always be exact. 2010-06-01 10:51:42 -07:00
version

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