notmuch clon
Find a file
Peter Feigl 1bf3720b6e Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions.
All the structured output functions in notmuch-reply and notmuch-show
are renamed to a generic name (as they do not contain any json-specific
code anyway). This patch is a preparation to actually using the new
S-Expression sprinter in notmuch-reply and notmuch-show.
2012-12-08 09:28:19 -04:00
bindings
compat Extend compat/README 2012-09-27 12:51:01 -03:00
completion
contrib contrib: pick: use notmuch-clean-address 2012-12-03 07:34:31 -04:00
debian Fixed 2 misspellings of word 'separate' 2012-11-16 15:50:55 -04:00
devel Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. 2012-12-08 09:28:19 -04:00
emacs emacs: show: refresh buffer did not remove overlays 2012-12-06 17:13:23 -04:00
lib lib: fix warnings when building with clang 2012-12-01 08:10:32 -04:00
man man: document the date:since..until range queries 2012-10-31 16:57:51 -03:00
packaging
parse-time-string parse-time-string: add a date/time parser to notmuch 2012-10-31 16:42:29 -03:00
performance-test performance-test: add units to In and Out 2012-11-29 09:28:46 -04:00
test test: use perl instead of sed -r for portability 2012-12-08 09:19:34 -04:00
util hex-escape: (en|de)code strings to/from restricted character set 2012-12-02 09:14:59 -04:00
vim
.dir-locals.el
.gitignore fix .gitignore for gzipped man pages 2012-01-17 14:52:31 -04:00
AUTHORS
command-line-arguments.c cli: make the command line parser's errors more informative. 2012-09-01 23:03:36 -03:00
command-line-arguments.h
configure configure: really expand libdir_expanded 2012-12-01 08:04:30 -04:00
COPYING
COPYING-GPL-3
crypto.c
debugger.c
gmime-filter-headers.c
gmime-filter-headers.h
gmime-filter-reply.c
gmime-filter-reply.h
hooks.c
INSTALL
Makefile test: initial performance testing infrastructure 2012-11-26 08:39:21 -04:00
Makefile.local Adding an S-expression structured output printer. 2012-12-08 09:26:29 -04:00
mime-node.c Avoid potentially dereferencing a NULL pointer 2012-09-27 12:52:34 -03:00
NEWS NEWS: removal of notmuch-folders 2012-12-06 17:14:10 -04:00
notmuch-client.h Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. 2012-12-08 09:28:19 -04:00
notmuch-config.c
notmuch-count.c
notmuch-dump.c notmuch-dump: tidy formatting 2012-11-16 08:46:31 -04:00
notmuch-new.c cli: convert "notmuch new" to the argument parser 2012-12-04 09:10:33 -04:00
notmuch-reply.c Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. 2012-12-08 09:28:19 -04:00
notmuch-restore.c notmuch-restore: tidy formatting 2012-11-16 08:46:07 -04:00
notmuch-search.c
notmuch-setup.c
notmuch-show.c Rename the -json printer functions in notmuch-reply and notmuch-show to generic -sprinter functions. 2012-12-08 09:28:19 -04:00
notmuch-tag.c notmuch-tag: tidy formatting 2012-11-16 08:45:39 -04:00
notmuch-time.c
notmuch.c cli: fix notmuch top level argument parsing 2012-12-04 09:10:19 -04:00
notmuch.desktop
query-string.c
README
sprinter-json.c
sprinter-sexp.c Adding an S-expression structured output printer. 2012-12-08 09:26:29 -04:00
sprinter-text.c
sprinter.h Adding an S-expression structured output printer. 2012-12-08 09:26:29 -04:00
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