notmuch clon
Find a file
Todd 8fb1cbc1c2 Update documentation
Adds new entry to the NEWS file, and updates the search terms section
of the man page.  The search terms section needs to be updated again
once the new section in the documentation covering probablistic terms
has been committed.
2015-01-24 16:51:20 +01:00
bindings bindings/ruby: gitignore *.o 2015-01-01 16:47:29 +01:00
compat configure: add workaround for systems without zlib.pc 2014-06-21 16:40:39 -03:00
completion Update completions for Emacs and bash 2015-01-24 16:50:02 +01:00
contrib contrib: remove notmuch deliver 2015-01-14 15:25:30 +01:00
debian debian: update ./debian/.gitignore 2015-01-03 15:18:27 +01:00
devel nmbug: Add a 'help' command for folks who don't like --help 2015-01-18 11:00:51 +01:00
doc Update documentation 2015-01-24 16:51:20 +01:00
emacs Update completions for Emacs and bash 2015-01-24 16:50:02 +01:00
lib Add indexing for the mimetype term 2015-01-24 16:47:59 +01:00
packaging packaging: fedora: add ruby bindings 2013-06-02 08:03:47 -03:00
parse-time-string timegm: add portable implementation (Solaris support) 2013-08-23 17:57:35 +02:00
performance-test build: add dataclean 2014-05-28 09:52:10 -03:00
test Add indexing for the mimetype term 2015-01-24 16:47:59 +01:00
util hex-escape: remove unused variable default_buf_size 2014-10-05 07:30:46 +02:00
vim VIM: Improve performance of folders_render 2015-01-23 18:18:54 +01:00
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore gitignore: ignore sh.config and doc/config.dox 2014-10-28 12:12:33 +01:00
.travis.yml travis: Only notify IRC on success if the previous build failed 2014-08-05 08:03:05 -03:00
AUTHORS Drop date.c file, (use identical function from GMime instead). 2009-11-02 14:36:33 -08:00
command-line-arguments.c cli: add support for hierarchical command line option arrays 2014-11-05 23:17:00 +01:00
command-line-arguments.h cli: add support for hierarchical command line option arrays 2014-11-05 23:17:00 +01:00
configure doc: remove support for rst2man 2015-01-22 08:37:25 +01: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
crypto.c crypto: return NULL cryptoctx if protocol string is empty. 2013-07-20 09:13:48 -03:00
debugger.c notmuch-new: Only install SIGALRM if not running under gdb 2009-11-22 05:36:36 +01: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: Flush stdout before fork()ing to run hooks 2014-03-25 21:22:17 -03:00
INSTALL doc: remove support for rst2man 2015-01-22 08:37:25 +01:00
Makefile build: move canonical list of subdirectories to configure script 2014-03-25 08:32:10 -03:00
Makefile.local build: generate sh.config for feeding configure results to shell scripts 2014-07-13 12:15:47 -03:00
mime-node.c cli: mime node: fix compiler warning when building against gmime 2.4 2013-04-14 19:49:16 -03:00
NEWS Update documentation 2015-01-24 16:51:20 +01:00
notmuch-client.h cli: Introduce "notmuch address" command 2014-11-05 23:19:12 +01:00
notmuch-compact.c cli: clean up exit status code returned by the cli commands 2014-01-18 14:45:26 -04:00
notmuch-config.c cli: Be more helpful when .notmuch-config does not exist 2014-09-07 20:01:01 +02:00
notmuch-count.c cli: clean up exit status code returned by the cli commands 2014-01-18 14:45:26 -04:00
notmuch-dump.c dump: make dump take Xapian write lock 2014-07-16 19:33:10 -03:00
notmuch-insert.c cli/insert: add post-insert hook 2014-10-28 19:19:30 +01:00
notmuch-new.c new: Don't report version after upgrade 2014-08-30 10:40:41 -07:00
notmuch-reply.c cli: sanitize the received header before scanning for replies 2014-03-25 21:22:03 -03:00
notmuch-restore.c restore: transparently support gzipped input 2014-04-12 07:59:44 -03:00
notmuch-search.c cli: notmuch address option defaults update 2014-11-09 10:09:51 +01:00
notmuch-setup.c cli: clean up exit status code returned by the cli commands 2014-01-18 14:45:26 -04:00
notmuch-show.c notmuch-show: detect NULL pointer returned from notmuch_query_search_threads 2014-01-24 20:24:11 -04:00
notmuch-tag.c cli: clean up exit status code returned by the cli commands 2014-01-18 14:45:26 -04:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.c cli: Introduce "notmuch address" command 2014-11-05 23:19:12 +01: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 emacs: instruct user to autoload notmuch instead of require'ing it 2014-03-30 11:02:08 -03:00
README.rst README.rst: typo/wording fixes 2014-10-24 14:28:44 +02:00
sprinter-json.c sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
sprinter-sexp.c Adding an S-expression structured output printer. 2012-12-08 09:26:29 -04:00
sprinter-text.c sprinter: add text0 formatter for null character separated text 2012-12-18 17:03:34 -04:00
sprinter.h sprinter: add text0 formatter for null character separated text 2012-12-18 17:03:34 -04:00
tag-util.c cli: add missing \n in error message 2014-03-06 07:46:27 -04:00
tag-util.h cli: export function for illegal tag checking 2014-03-06 07:41:38 -04:00
version version: bump to 0.19 2014-11-14 19:35:44 +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 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:

	(autoload 'notmuch "notmuch" "Notmuch mail" t)

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