notmuch clon
Find a file
Austin Clements abedb55a45 perf: Clean corpus and caches in distclean, not clean
Previously, we cleaned the downloaded performance corpus and the
cached indexes on 'make clean'.  This seems heavy-handed, since these
take a long time to download, unpack, and index.  They also aren't
make targets to begin with.  Move cleaning these to 'make distclean'.
This isn't exactly the right meaning of "distclean", but it's closer.
2013-10-25 21:24:43 -03:00
bindings
compat
completion
contrib contrib: pick: update notmuch-show calls 2013-10-14 08:26:37 -03:00
debian debian: remove unneeded notmuch-mutt dependencies 2013-09-08 22:41:48 -03:00
devel
emacs emacs: show: use interactive instead of current-prefix-arg 2013-10-19 22:42:49 -03:00
lib database: Add notmuch_database_compact_close 2013-10-09 21:46:49 -03:00
man notmuch-compact: Add man page 2013-10-09 21:47:39 -03:00
packaging
parse-time-string
performance-test perf: Clean corpus and caches in distclean, not clean 2013-10-25 21:24:43 -03:00
test emacs: show: use interactive instead of current-prefix-arg 2013-10-19 22:42:49 -03:00
util
vim
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore
AUTHORS
command-line-arguments.c
command-line-arguments.h
configure database: Add notmuch_database_compact_close 2013-10-09 21:46:49 -03:00
COPYING
COPYING-GPL-3
crypto.c
debugger.c
dump-restore-private.h
gmime-filter-reply.c
gmime-filter-reply.h
hooks.c
INSTALL
Makefile
Makefile.local Place extra_cflags before CONFIGURE_CFLAGS 2013-10-25 21:20:11 -03:00
mime-node.c
NEWS News for Emacs help improvements 2013-10-07 20:32:58 -03:00
notmuch-client.h notmuch-compact: Initial commit of CLI 2013-10-09 21:47:13 -03:00
notmuch-compact.c notmuch-compact: Initial commit of CLI 2013-10-09 21:47:13 -03:00
notmuch-config.c
notmuch-count.c cli: add --output=files option to notmuch count 2013-08-24 11:42:39 +02:00
notmuch-dump.c
notmuch-insert.c
notmuch-new.c
notmuch-reply.c cli: add --include-html option to notmuch show 2013-08-27 07:57:36 -03:00
notmuch-restore.c
notmuch-search.c cli: add --duplicate=N option to notmuch search 2013-08-24 11:41:55 +02:00
notmuch-setup.c cli: move config open/close to main() from subcommands 2013-03-08 07:54:41 -04:00
notmuch-show.c cli: add --include-html option to notmuch show 2013-08-27 07:57:36 -03:00
notmuch-tag.c
notmuch-time.c
notmuch.c notmuch-compact: Initial commit of CLI 2013-10-09 21:47:13 -03:00
notmuch.desktop
query-string.c
README
sprinter-json.c
sprinter-sexp.c
sprinter-text.c
sprinter.h
tag-util.c
tag-util.h
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