notmuch clon
Find a file
Carl Worth 1a915d1b38 Makefile: Quote variables used as filenames in shell commands
This allows support for filenames with spaces in them.
2011-01-26 23:36:52 +10:00
bindings Migrate to goconfig pkg 2011-01-26 15:59:19 +10:00
compat Wrap the compat header in extern "C" { } when compiling C++ sources 2010-04-27 10:39:54 -07:00
completion Makefile: Quote variables used as filenames in shell commands 2011-01-26 23:36:52 +10:00
debian debian: Update list of symbols for libnotmuch 2010-11-11 20:51:29 -08:00
emacs Makefile: Quote variables used as filenames in shell commands 2011-01-26 23:36:52 +10:00
lib Makefile: Quote variables used as filenames in shell commands 2011-01-26 23:36:52 +10:00
packaging Update of the spec file to the 0.4 release. 2010-11-11 16:46:38 -08:00
test test: Make it easier to resolve conflicts when adding new tests 2011-01-26 22:37:21 +10:00
vim vim: Get user email address from notmuch config file. 2011-01-26 16:57:58 +10:00
.gitignore make release: Add Debian package building and upload 2010-04-16 13:20:22 -07:00
AUTHORS Drop date.c file, (use identical function from GMime instead). 2009-11-02 14:36:33 -08:00
configure configure: Drop global setting of IFS (without space in it). 2011-01-26 23:29:03 +10: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 Decode headers in reply 2010-04-13 09:23:54 -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/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 test: Fix test suite to integrate with our non-recursive Makefile system. 2010-09-17 12:16:10 -07:00
Makefile.local Makefile: Quote variables used as filenames in shell commands 2011-01-26 23:36:52 +10:00
NEWS NEWS: Add notes for 0.5 release. 2010-11-11 20:41:06 -08:00
notmuch-client.h Avoid abbreviation, preferring notmuch_config_get_maildir_synchronize_flags 2010-11-11 03:40:19 -08:00
notmuch-config.c config: Fix confusing of "tag" and "flag" oin documentation. 2010-11-11 20:39:22 -08:00
notmuch-count.c notmuch count: Remove special handling of "*". 2010-04-09 17:44:01 -07:00
notmuch-dump.c lib: Rename iterator functions to prepare for reverse iteration. 2010-03-09 09:22:29 -08:00
notmuch-new.c new: Enhance progress reporting 2011-01-26 22:10:11 +10:00
notmuch-reply.c notmuch: Eliminate some const-correctness warnings. 2010-10-27 18:07:37 -07:00
notmuch-restore.c lib: Rework interface for maildir_flags synchronization 2010-11-11 03:40:19 -08:00
notmuch-search-tags.c lib: Rename iterator functions to prepare for reverse iteration. 2010-03-09 09:22:29 -08:00
notmuch-search.c notmuch search: Clean up some memory leaks during search loop. 2011-01-26 15:59:19 +10:00
notmuch-setup.c notmuch setup: Don't prompt about maildir synchronization 2010-11-11 03:53:14 -08:00
notmuch-show.c Rename "notmuch cat" to "notmuch show --format=raw" 2010-11-06 12:03:51 -07:00
notmuch-tag.c lib: Rework interface for maildir_flags synchronization 2010-11-11 03:40:19 -08:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.1 Add documentation for the recently added folder-based searching. 2011-01-15 15:37:43 -08:00
notmuch.c notmuch search: Clean up some memory leaks during search loop. 2011-01-26 15:59:19 +10: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 NEWS: Add notes for 0.5 release. 2010-11-11 20:41:06 -08:00
show-message.c notmuch: Add a 'part' subcommand 2010-04-02 09:43:03 +01:00
TODO TODO: Note that folder: has now been implemented. 2011-01-26 15:59:19 +10:00
version Increment notmuch version to 0.5 2010-11-11 20:43:56 -08:00
xutil.c lib: Add GCC visibility(hidden) pragmas to private header files. 2010-11-01 22:35:48 -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 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