notmuch clon
Find a file
David Bremner c527358794 doc: do not generate python module index
This currently seems unhelpful, and not generating it removes if from
the navigation bar, which prevents mis-clicking.
2022-07-14 16:31:11 -04:00
bindings bindings/python-cffi: fix docstring 2022-07-05 07:34:25 -03:00
compat compat: rename {,notmuch_}canonicalize_file_name 2021-04-24 08:07:00 -03:00
completion completion: use mail_root for path completion in bash/zsh 2022-01-03 08:07:38 -04:00
contrib notmuch-mutt: replace shell pipeline with internal pipe processing 2020-08-12 20:40:46 -03:00
debian debian: add git as a build-dependency, for the test suite 2022-07-07 07:24:58 -03:00
devel nmbug: promote to user tool "notmuch-git" 2022-06-17 08:40:19 -03:00
doc doc: do not generate python module index 2022-07-14 16:31:11 -04:00
emacs emacs/show: introduce notmuch-show-height-limit 2022-07-14 11:51:01 -04:00
lib lib/sexp: add parameter expansion for regex and wildcard 2022-07-01 08:37:00 -03:00
packaging Use https instead of http where possible 2016-06-05 08:32:17 -03:00
parse-time-string emacs: Use makefile-gmake-mode in Makefile*s 2020-08-09 21:14:36 -03:00
performance-test perf-test/emacs: test showing longish threads 2022-07-14 04:50:33 -03:00
test emacs/show: introduce notmuch-show-height-limit 2022-07-14 11:51:01 -04:00
util config: ignore leading/trailing spaces in ';'-delimited lists 2021-12-04 12:16:12 -04:00
vim Revert "Vim: Ensure that every queries respect excluded tags" 2021-04-27 20:34:53 -03:00
.dir-locals.el .dir-locals.el: Set variables for correct "shell" mode 2020-08-09 21:14:36 -03:00
.gitignore make git ignore new build products 2022-07-01 08:30:40 -03:00
.mailmap create .mailmap file (for git shortlog/blame) 2016-07-29 06:01:44 +09:00
.travis.yml replace references to freenode with references to libera 2021-07-06 17:20:03 -03:00
AUTHORS AUTHORS: update for 0.31 2020-08-22 09:13:26 -03:00
command-line-arguments.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
command-line-arguments.h cli: run uncrustify 2019-06-14 07:41:27 -03:00
configure test: define test_private_C 2022-06-25 12:55:02 -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
debugger.c cli: run uncrustify 2019-06-14 07:41:27 -03:00
gmime-filter-reply.c CLI: centralize initialization in notmuch_client_init 2021-05-14 06:40:37 -03:00
gmime-filter-reply.h CLI: centralize initialization in notmuch_client_init 2021-05-14 06:40:37 -03:00
hooks.c CLI: set NOTMUCH_CONFIG in hooks. 2022-06-18 08:24:46 -03:00
INSTALL INSTALL: document optional dependency on libsfsexp 2021-10-15 08:49:01 -03:00
Makefile support make goals after initial {'', dist, data}clean goal(s) 2017-03-10 08:04:27 -04:00
Makefile.global build: move {C,CXX}FLAGS to the end of FINAL_{C,CXX}FLAGS 2021-12-31 07:08:06 -04:00
Makefile.local CLI/git: change defaults for repo and prefix 2022-06-17 08:40:19 -03:00
mime-node.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
NEWS emacs: change where notmuch-mua-mail moves point 2022-06-02 08:21:56 -03:00
notmuch-client-init.c CLI: add missing file notmuch-client-init 2021-05-15 08:14:37 -03:00
notmuch-client.h CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
notmuch-compact.c CLI: make variable n_requested_db_uuid file scope. 2021-09-04 17:07:19 -07:00
notmuch-config.c CLI/setup: special case single item lists 2022-01-24 09:32:39 -04:00
notmuch-count.c CLI/{count, dump, reindex, reply, show}: enable sexp queries 2021-09-04 17:07:19 -07:00
notmuch-dump.c CLI/{count, dump, reindex, reply, show}: enable sexp queries 2021-09-04 17:07:19 -07:00
notmuch-git.py CLI/git: add --format-version argument to init subcommand 2022-07-07 07:05:55 -03:00
notmuch-insert.c CLI/insert: escape envelope from 2022-02-19 22:11:35 -04:00
notmuch-new.c cli/new: only ignore .notmuch at top level 2022-01-16 10:52:13 -04:00
notmuch-reindex.c CLI: move indexopts variable out of shared options block 2021-10-23 09:51:50 -03:00
notmuch-reply.c CLI/{count, dump, reindex, reply, show}: enable sexp queries 2021-09-04 17:07:19 -07:00
notmuch-restore.c CLI: make variable n_requested_db_uuid file scope. 2021-09-04 17:07:19 -07:00
notmuch-search.c CLI: move query syntax to shared option 2021-09-04 17:07:19 -07:00
notmuch-setup.c CLI: make variable n_requested_db_uuid file scope. 2021-09-04 17:07:19 -07:00
notmuch-show.c CLI: print extra headers only for non-replies 2022-01-18 21:26:45 -04:00
notmuch-tag.c CLI/tag: enable sexp queries 2021-09-04 17:07:19 -07:00
notmuch-time.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
notmuch.c CLI: pass --config to external commands via NOTMUCH_CONFIG. 2022-06-13 07:28:05 -03:00
query-string.c Use https instead of http where possible 2016-06-05 08:32:17 -03:00
README replace references to freenode with references to libera 2021-07-06 17:20:03 -03:00
README.rst Use https instead of http where possible 2016-06-05 08:32:17 -03:00
sprinter-json.c CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
sprinter-sexp.c CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
sprinter-text.c CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
sprinter.h CLI: stash pointer to database in sprinter structs 2022-01-18 08:08:22 -04:00
status.c status: add print_status_gzbytes 2020-04-13 17:14:50 -03:00
tag-util.c Fix typos 2020-08-09 21:14:36 -03:00
tag-util.h Fix typos 2020-08-09 21:14:36 -03:00
version.txt version: bump to 0.36 2022-04-25 08:45:12 -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.libera.chat
	Channel:	#notmuch