notmuch clon
Find a file
Austin Clements 76490fba3c doc: Emacs manual improvements and expansions
Fix several typos, improve general wording and flow, and add some
information on notmuch-jump.
2014-10-04 20:32:59 +02:00
bindings python: Add binding for notmuch_query_add_tag_exclude 2014-09-23 18:23:39 +02:00
compat configure: add workaround for systems without zlib.pc 2014-06-21 16:40:39 -03:00
completion completion: fail silently if _init_completion is not found 2014-08-22 17:02:41 -07:00
contrib
debian debian: re-enable atomicity test on arm64 2014-09-20 09:51:48 +02:00
devel nmbug: Handle missing @upstream in is_unmerged 2014-07-16 19:31:28 -03:00
doc doc: Emacs manual improvements and expansions 2014-10-04 20:32:59 +02:00
emacs emacs: jump: fix compile warning on emacs 23 2014-09-24 19:55:36 +02:00
lib lib: Simplify close and codify aborting atomic section 2014-10-03 08:58:58 +02:00
packaging
parse-time-string
performance-test build: add dataclean 2014-05-28 09:52:10 -03:00
test emacs: Fix coding system in `notmuch-show-view-raw-message' 2014-09-21 21:23:45 +02:00
util util: Const version of strtok_len 2014-08-06 09:56:36 -03:00
vim vim: improve the way messages are sent 2014-05-03 06:00:22 +09:00
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore
.travis.yml travis: Only notify IRC on success if the previous build failed 2014-08-05 08:03:05 -03:00
AUTHORS
command-line-arguments.c
command-line-arguments.h
configure build: generate sh.config for feeding configure results to shell scripts 2014-07-13 12:15:47 -03:00
COPYING
COPYING-GPL-3
crypto.c
debugger.c
gmime-filter-reply.c
gmime-filter-reply.h
hooks.c
INSTALL
Makefile
Makefile.local build: generate sh.config for feeding configure results to shell scripts 2014-07-13 12:15:47 -03:00
mime-node.c
NEWS NEWS: News for notmuch-jump 2014-10-04 07:32:20 +02:00
notmuch-client.h
notmuch-compact.c
notmuch-config.c cli: Be more helpful when .notmuch-config does not exist 2014-09-07 20:01:01 +02:00
notmuch-count.c
notmuch-dump.c dump: make dump take Xapian write lock 2014-07-16 19:33:10 -03:00
notmuch-insert.c cli/insert: rehash file writing functions 2014-09-24 20:29:58 +02:00
notmuch-new.c new: Don't report version after upgrade 2014-08-30 10:40:41 -07:00
notmuch-reply.c
notmuch-restore.c
notmuch-search.c
notmuch-setup.c
notmuch-show.c
notmuch-tag.c
notmuch-time.c
notmuch.c
notmuch.desktop
query-string.c
README
sprinter-json.c
sprinter-sexp.c
sprinter-text.c
sprinter.h
tag-util.c
tag-util.h
version version: bump to 0.18.1 2014-06-25 07:30:10 -03: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