notmuch clon
Find a file
Carl Worth e83b40138e lib: Add two functions: notmuch_query_get_query_string and _get_sort
It can be handy to be able to query these settings from an existing
query object.
2010-10-28 10:30:26 -07:00
bindings/python python: have docs reflect current return value behavior 2010-05-18 11:11:59 -07:00
compat Wrap the compat header in extern "C" { } when compiling C++ sources 2010-04-27 11:11:11 -07:00
completion Makefile: Move the completion-specific commands to completion/Makefile.local 2010-04-06 14:36:31 -07:00
debian Merge branch '0.3.x' immediately after the 0.3.1 release 2010-04-27 17:13:47 -07:00
emacs emacs: Eliminate duplicate From header in replies. 2010-10-27 18:44:05 -07:00
lib lib: Add two functions: notmuch_query_get_query_string and _get_sort 2010-10-28 10:30:26 -07:00
packaging packaging: Add a pointer to where the debian packaging really is. 2010-04-06 14:42:09 -07:00
test test: Add test for reply functionality within emacs. 2010-10-27 18:43:09 -07:00
vim Fix typo in message 2010-04-15 19:43:56 -07: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 make install: Run ldconfig or install a DT_RUNPATH in binary as appropriate. 2010-06-04 16:52:56 -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
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 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: Add a new "notmuch config" command for querying configuration. 2010-10-27 13:02:17 -07:00
notmuch-config.c notmuch config: Allow for new "notmuch config set" in addition to get 2010-10-27 15:38:16 -07: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 Sprinkle some const-correctness around new_tags. 2010-04-23 09:19:52 -07:00
notmuch-reply.c notmuch: Eliminate some const-correctness warnings. 2010-10-27 18:07:37 -07:00
notmuch-restore.c lib: Rename iterator functions to prepare for reverse iteration. 2010-03-09 09:22:29 -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: Fix to handle failure of notmuch_query_search_threads. 2010-10-22 18:03:39 -07:00
notmuch-setup.c notmuch: Eliminate some const-correctness warnings. 2010-10-27 18:07:37 -07:00
notmuch-show.c notmuch show: Add a --format=mbox option 2010-06-08 19:45:54 -07:00
notmuch-tag.c notmuch-tag: don't sort messages before applying tag changes 2010-04-21 16:06:09 -07:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.1 notmuch config: Allow for new "notmuch config set" in addition to get 2010-10-27 15:38:16 -07:00
notmuch.c notmuch config: Allow for new "notmuch config set" in addition to get 2010-10-27 15:38:16 -07: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 debian/changelog: Add notes for the 0.3 release 2010-04-27 02:07:45 -07:00
show-message.c notmuch: Add a 'part' subcommand 2010-04-02 09:43:03 +01:00
TODO TODO: Remove several items that have been completed. 2010-10-28 09:02:34 -07:00
version Increment version to 0.3.1 2010-04-27 17:00:34 -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