notmuch clon
Find a file
Mark Walters 7cd3cd3003 emacs: make notmuch-show return its buffer
notmuch-pick uses the returned buffer to try and make sure it does not
close the wrong buffer.
2012-09-01 22:59:54 -03:00
bindings version: propagate version changes 2012-08-21 10:43:49 +02:00
compat
completion
contrib contrib/nmbug/nmbug-status: if realname empty, use part of mailaddr 2012-09-01 22:58:49 -03:00
debian debian: mention some upstream news in changelog 2012-08-21 10:43:50 +02:00
devel schemata: update for --body=true|false option 2012-07-24 15:49:33 -03:00
emacs emacs: make notmuch-show return its buffer 2012-09-01 22:59:54 -03:00
lib lib: Treat messages in new/ as maildir messages with no flags set 2012-06-10 20:14:56 -03:00
man version: propagate version changes 2012-08-21 10:43:49 +02:00
packaging
test test: use (format "%S") to print nil in emacs test. 2012-08-30 22:05:51 -03:00
util
vim vim: simplify build 2012-04-21 05:19:30 +03:00
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore fix .gitignore for gzipped man pages 2012-01-17 14:52:31 -04:00
AUTHORS
command-line-arguments.c cli: command line parsing: allow default for keyword options 2012-06-29 22:31:40 -03:00
command-line-arguments.h
configure configure: check whether shell is capable of parameter substring processing 2012-07-25 08:17:24 -03:00
COPYING
COPYING-GPL-3
crypto.c cli: new crypto structure to store crypto contexts and parameters, and functions to support it 2012-06-10 20:05:02 -03: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
gmime-filter-headers.h
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
hooks.c
INSTALL Recommend libgmime-2.6-dev in INSTALL 2012-05-24 21:54:30 -03:00
Makefile
Makefile.local cli: Remove now-unused json.c 2012-08-12 21:28:08 +02:00
mime-node.c cli: use new notmuch_crypto_get_context in mime-node.c 2012-06-10 20:09:42 -03:00
NEWS NEWS: 2 minor consistency changes in sections 0.13.1 and 0.13.2 2012-08-29 19:00:06 -03:00
notmuch-client.h show: Remove now unused fields from notmuch_show_format 2012-08-03 20:40:01 -03:00
notmuch-config.c config: Add 'config list' command 2012-04-28 10:45:31 -03:00
notmuch-count.c lib/cli: Make notmuch_database_open return a status code 2012-05-05 10:11:57 -03:00
notmuch-dump.c notmuch-dump: remove deprecated positional argument for output file 2012-08-06 08:52:33 -03:00
notmuch-new.c new: Unify add_files and add_files_recursive 2012-05-24 21:53:38 -03:00
notmuch-reply.c reply: Convert JSON format to use sprinter 2012-08-12 21:29:38 +02:00
notmuch-restore.c notmuch-restore: replace positional argument for input with option 2012-08-06 08:52:45 -03:00
notmuch-search.c Use the structured formatters in notmuch-search.c. 2012-07-24 09:27:09 -03:00
notmuch-setup.c Make exclusion visible again 2012-03-03 11:56:47 -04:00
notmuch-show.c show: Remove now unused fields from notmuch_show_format 2012-08-03 20:40:01 -03:00
notmuch-tag.c lib/cli: Make notmuch_database_open return a status code 2012-05-05 10:11:57 -03:00
notmuch-time.c
notmuch.c
notmuch.desktop
query-string.c
README
sprinter-json.c sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
sprinter-text.c sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
sprinter.h sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
version version: bump primary version 2012-08-20 13:53:50 +02: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