notmuch clon
Find a file
David Bremner b264a49be3 rename built_with.sexpr_query to built_with.sexp_queries
It is confusing to use two different names (sexp vs sexpr) when
compared with the command line option --query=sexp and (furthermore)
singular vs plural when compared with the man page title.
2021-12-03 20:06:06 -04:00
bindings version: bump to 0.34.1 2021-10-31 08:11:25 -03:00
compat compat: rename {,notmuch_}canonicalize_file_name 2021-04-24 08:07:00 -03:00
completion emacs: Use makefile-gmake-mode in Makefile*s 2020-08-09 21:14:36 -03:00
contrib notmuch-mutt: replace shell pipeline with internal pipe processing 2020-08-12 20:40:46 -03:00
debian debian: refinalize changelog 2021-11-03 10:20:49 -03:00
devel devel: script for checking a commit (series) 2021-10-10 20:55:09 -03:00
doc rename built_with.sexpr_query to built_with.sexp_queries 2021-12-03 20:06:06 -04:00
emacs emacs: improve notmuch-*-from-current-query docstrings 2021-10-30 15:19:10 -03:00
lib rename built_with.sexpr_query to built_with.sexp_queries 2021-12-03 20:06:06 -04: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: fix for verbose 2021-08-05 09:04:53 -03:00
test rename built_with.sexpr_query to built_with.sexp_queries 2021-12-03 20:06:06 -04:00
util cli: remove enum names from typedefs 2021-10-23 08:39:16 -03: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 .gitignore: Sort using sort-lines 2020-08-09 21:14:36 -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 configure: whitespace cleanup 2021-10-10 20:58:29 -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: use configured hook directory 2021-02-06 19:57:55 -04: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 debian: don't tag debian tag at release is made. 2020-12-25 12:28:31 -04:00
Makefile.local CLI: centralize initialization in notmuch_client_init 2021-05-14 06:40:37 -03:00
mime-node.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
NEWS NEWS: finalize release date 2021-11-03 10:20:08 -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: move indexopts variable out of shared options block 2021-10-23 09:51:50 -03:00
notmuch-compact.c CLI: make variable n_requested_db_uuid file scope. 2021-09-04 17:07:19 -07:00
notmuch-config.c rename built_with.sexpr_query to built_with.sexp_queries 2021-12-03 20:06:06 -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-insert.c CLI: move indexopts variable out of shared options block 2021-10-23 09:51:50 -03:00
notmuch-new.c CLI: move indexopts variable out of shared options block 2021-10-23 09:51:50 -03: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/{count, dump, reindex, reply, show}: enable sexp queries 2021-09-04 17:07:19 -07: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: move indexopts variable out of shared options block 2021-10-23 09:51:50 -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: run uncrustify 2021-03-13 08:45:34 -04:00
sprinter-sexp.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
sprinter-text.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
sprinter.h sprinter: change integer method to use int64_t 2020-02-13 19:10:42 -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.34.1 2021-10-31 08:11:25 -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