notmuch clon
Find a file
David Bremner e7ffb74041 lib/sexp: allow * as alias for "" in range searches.
It can be tedious to use "" inside of a string, e.g. in a shell script.
2022-06-25 19:49:55 -03:00
bindings
compat compat: rename {,notmuch_}canonicalize_file_name 2021-04-24 08:07:00 -03:00
completion
contrib
debian debian: install notmuch-git 2022-06-17 08:40:19 -03:00
devel
doc
emacs
lib lib/sexp: allow * as alias for "" in range searches. 2022-06-25 19:49:55 -03:00
packaging
parse-time-string
performance-test perf-test: emacs tagging 2022-02-25 08:38:21 -04:00
test lib/sexp: allow * as alias for "" in range searches. 2022-06-25 19:49:55 -03:00
util
vim
.dir-locals.el
.gitignore
.mailmap
.travis.yml
AUTHORS
command-line-arguments.c
command-line-arguments.h
configure test: define test_private_C 2022-06-25 12:55:02 -03:00
COPYING
COPYING-GPL-3
debugger.c
gmime-filter-reply.c
gmime-filter-reply.h
hooks.c
INSTALL
Makefile
Makefile.global
Makefile.local
mime-node.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
NEWS
notmuch-client-init.c
notmuch-client.h CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
notmuch-compact.c
notmuch-config.c CLI/setup: special case single item lists 2022-01-24 09:32:39 -04:00
notmuch-count.c
notmuch-dump.c
notmuch-git.py
notmuch-insert.c
notmuch-new.c
notmuch-reindex.c
notmuch-reply.c
notmuch-restore.c CLI: make variable n_requested_db_uuid file scope. 2021-09-04 17:07:19 -07:00
notmuch-search.c
notmuch-setup.c
notmuch-show.c
notmuch-tag.c
notmuch-time.c
notmuch.c
query-string.c
README
README.rst
sprinter-json.c
sprinter-sexp.c
sprinter-text.c
sprinter.h
status.c
tag-util.c
tag-util.h
version.txt

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.libera.chat
	Channel:	#notmuch