notmuch clon
Find a file
Felipe Contreras 42ff2d3a0d vim: add help file
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
2013-11-20 07:23:30 -06:00
bindings version: set new version and release date 2013-07-28 11:28:03 -03:00
compat timegm: add portable implementation (Solaris support) 2013-08-23 17:57:35 +02:00
completion completion: update bash completion 2013-11-11 07:45:04 -04:00
contrib remove notmuch-pick 2013-11-13 21:24:05 -04:00
debian vim: add help file 2013-11-20 07:23:30 -06:00
devel devel/release-checks.sh: check NOTMUCH_(MAJOR|MINOR|MICRO)_VERSION 2013-11-11 07:44:44 -04:00
emacs emacs: do not put quoted reply in primary selection 2013-11-19 20:18:17 -04:00
lib compact: improve error messages on failures after compaction 2013-11-19 20:15:02 -04:00
man man: document notmuch compact --quiet and --backup=DIRECTORY options 2013-11-07 19:16:15 -04: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 perf: Clean corpus and caches in distclean, not clean 2013-10-25 21:24:43 -03:00
test emacs: Fix search tagging races 2013-11-08 20:52:00 -04:00
util string-util: Disallow empty prefixes in parse_boolean_term 2013-01-07 20:55:21 -04:00
vim vim: add help file 2013-11-20 07:23:30 -06:00
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore emacs: update .gitignore 2013-06-02 20:44:26 -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: make the command line parser's errors more informative. 2012-09-01 23:03:36 -03:00
command-line-arguments.h command-line-arguments.[ch]: make arrays of keyword descriptors const 2011-12-13 00:00:44 -04:00
configure database: Add notmuch_database_compact_close 2013-10-09 21:46:49 -03: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
dump-restore-private.h notmuch-dump: add --format=(batch-tag|sup) 2012-12-08 10:40:54 -04: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: introduce the concept of user defined hooks 2011-12-11 13:57:31 -04:00
INSTALL Recommend libgmime-2.6-dev in INSTALL 2012-05-24 21:54:30 -03:00
Makefile build: fix out-of-tree builds 2013-05-26 18:49:04 -03:00
Makefile.local Place extra_cflags before CONFIGURE_CFLAGS 2013-10-25 21:20:11 -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 NEWS: insert quotable parts in reply as they are displayed in show view 2013-11-19 20:19:02 -04:00
notmuch-client.h search: Add stable queries to thread search results 2013-11-08 20:43:29 -04:00
notmuch-compact.c compact: tidy formatting 2013-11-17 20:25:25 -04:00
notmuch-config.c notmuch-config: use strchr(), not index() (Solaris support) 2013-08-24 11:37:51 +02:00
notmuch-count.c cli: add --output=files option to notmuch count 2013-08-24 11:42:39 +02:00
notmuch-dump.c cli: move config open/close to main() from subcommands 2013-03-08 07:54:41 -04:00
notmuch-insert.c insert: add --create-folder option 2013-07-04 00:05:11 -03:00
notmuch-new.c new: Don't scan unchanged directories with no sub-directories 2013-10-28 16:47:10 -03:00
notmuch-reply.c cli: add --include-html option to notmuch show 2013-08-27 07:57:36 -03:00
notmuch-restore.c cli: move config open/close to main() from subcommands 2013-03-08 07:54:41 -04:00
notmuch-search.c search: Add stable queries to thread search results 2013-11-08 20:43:29 -04: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 tag-util: move out 'tag' command-line check 2013-06-29 14:36:07 -03:00
notmuch-time.c Add some const correctness to talloc 'ctx' parameter. 2009-11-17 19:10:37 -08:00
notmuch.c cli: Separate current and deprecated format version 2013-11-08 20:13:58 -04: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 INSTALL/README: Clean up the description of how to run the emacs interface. 2010-06-01 10:51:42 -07: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 tag-util: do not reset list in parse_tag_command_line 2013-06-29 14:36:23 -03:00
tag-util.h tag-util: do not reset list in parse_tag_command_line 2013-06-29 14:36:23 -03:00
version version: set new version and release date 2013-07-28 11:28:03 -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:

	(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