notmuch clon
Find a file
Mark Walters 190a30b263 emacs: tag-jump: docstring fix
In commit 297d091e1c the key for
switching to the reverse keymap was changed from r to k but the
docstring for the defcustom was not updated. This changeset updates
the documentation to match.
2016-10-15 21:49:48 -03:00
bindings version: bump to 0.23 2016-10-03 22:40:22 -03:00
compat Use https instead of http where possible 2016-06-05 08:32:17 -03:00
completion Use https instead of http where possible 2016-06-05 08:32:17 -03:00
contrib fixed wrong constant values 2016-09-03 20:15:46 -03:00
debian debian: changelog stanza for 0.23-2 2016-10-05 21:27:17 -03:00
devel nmbug: Add --no-renames to default log options 2016-10-04 07:51:22 -03:00
doc add property: query prefix to search for specific properties 2016-09-21 18:14:25 -03:00
emacs emacs: tag-jump: docstring fix 2016-10-15 21:49:48 -03:00
lib lib: document API added in 0.23 2016-10-06 22:46:01 -03:00
packaging Use https instead of http where possible 2016-06-05 08:32:17 -03:00
parse-time-string Use https instead of http where possible 2016-06-05 08:32:17 -03:00
performance-test Use https instead of http where possible 2016-06-05 08:32:17 -03:00
test test: add known broken test for nondestructiveness of count 2016-10-15 10:22:40 -03:00
util Use https instead of http where possible 2016-06-05 08:32:17 -03:00
vim VIM: Improve performance of folders_render 2015-01-23 18:18:54 +01:00
.dir-locals.el .dir-locals.el: changed one-char comment prefix '; ' to two; '; ; ' 2012-01-22 08:41:37 -04:00
.gitignore gitignore: ignore sh.config and doc/config.dox 2014-10-28 12:12:33 +01:00
.mailmap create .mailmap file (for git shortlog/blame) 2016-07-29 06:01:44 +09:00
.travis.yml travis: Only notify IRC on success if the previous build failed 2014-08-05 08:03:05 -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: add support for hierarchical command line option arrays 2014-11-05 23:17:00 +01:00
command-line-arguments.h cli: add support for hierarchical command line option arrays 2014-11-05 23:17:00 +01:00
configure require xapian >= 1.2.6 2016-10-06 22:45:46 -03:00
COPYING Use https instead of http where possible 2016-06-05 08:32:17 -03:00
COPYING-GPL-3 Use https instead of http where possible 2016-06-05 08:32:17 -03:00
crypto.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
debugger.c Use https instead of http where possible 2016-06-05 08:32:17 -03: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 Use https instead of http where possible 2016-06-05 08:32:17 -03:00
INSTALL Use https instead of http where possible 2016-06-05 08:32:17 -03:00
Makefile build: move canonical list of subdirectories to configure script 2014-03-25 08:32:10 -03:00
Makefile.local build system: choose gnu99 as a C standard 2016-09-21 20:09:14 -03:00
mime-node.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
NEWS NEWS: bump date to today 2016-10-03 22:43:23 -03:00
notmuch-client.h CLI: add properties to dump output 2016-09-21 18:14:25 -03:00
notmuch-compact.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-config.c lib: add built_with handling for XAPIAN_DB_RETRY_LOCK 2016-06-29 09:05:49 +02:00
notmuch-count.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-dump.c CLI: add properties to dump output 2016-09-21 18:14:25 -03:00
notmuch-emacs-mua notmuch-emacs-mua: escape $PWD (and cd always) 2016-06-11 13:09:22 -03:00
notmuch-insert.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-new.c CLI: add properties to dump output 2016-09-21 18:14:25 -03:00
notmuch-reply.c cli/reply: only pass gmime message to add recipients to reply message 2016-09-17 09:20:12 -03:00
notmuch-restore.c cli: optionally restore message properties from dump file 2016-09-21 18:14:25 -03:00
notmuch-search.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-setup.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-show.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-tag.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch-time.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
notmuch.c Use https instead of http where possible 2016-06-05 08:32:17 -03: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 Use https instead of http where possible 2016-06-05 08:32:17 -03:00
README Use https instead of http where possible 2016-06-05 08:32:17 -03:00
README.rst Use https instead of http where possible 2016-06-05 08:32:17 -03:00
sprinter-json.c sprinters: bugfix when NULL passed for a string. 2012-08-12 21:25:01 +02:00
sprinter-sexp.c Use https instead of http where possible 2016-06-05 08:32:17 -03: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
status.c CLI: add print_status_database 2016-03-29 22:59:35 -03:00
tag-util.c cli: add missing \n in error message 2014-03-06 07:46:27 -04:00
tag-util.h cli: export function for illegal tag checking 2014-03-06 07:41:38 -04:00
version version: bump to 0.23 2016-10-03 22:40:22 -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:

	https://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