notmuch clon
Find a file
Jani Nikula 59c953656d doc: fix man page build for Sphinx 4.x
Sphinx 4.0 changed the default value of man_make_section_directory
from False to True. We create the section directories and move the
files manually, so fix the immediate man build failure by disabling
the feature.

The Sphinx documentation on this [1] is confusing, and has the change
backwards. Git history says the default changed from False to True.

[1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_make_section_directory
2021-05-19 08:52:48 -03:00
bindings ruby: new notmuch_rb_object_destroy() helper 2021-05-17 07:25:14 -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: changelog for 0.32.1-1 2021-05-15 09:03:19 -03:00
devel devel/uncrustify: add line length limits. 2021-03-12 07:15:41 -04:00
doc doc: fix man page build for Sphinx 4.x 2021-05-19 08:52:48 -03:00
emacs emacs: restore tag-changes and query bindings for tag hooks 2021-05-15 08:34:28 -03:00
lib Merge branch 'release' 2021-05-15 09:10:58 -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: add option to run perf 2021-04-28 08:49:07 -03:00
test test: split emacs functionality to its own file 2021-05-17 07:29:04 -03:00
util compat: rename {,notmuch_}canonicalize_file_name 2021-04-24 08:07:00 -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 test: drop upgrade from v1 tests 2020-07-11 17:20:09 -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: replace $(realpath emacs) with $(cd emacs && pwd -P) 2020-10-21 07:01:37 -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 doc: update install suggestions for fedora derivatives 2020-07-03 06:31:54 -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 Merge branch 'release' 2021-05-15 09:10:58 -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: centralize initialization in notmuch_client_init 2021-05-14 06:40:37 -03:00
notmuch-compact.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-config.c CLI/config: make immutable tables const 2021-05-14 06:41:51 -03:00
notmuch-count.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-dump.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-insert.c CLI: make static message strings const 2021-05-14 06:42:55 -03:00
notmuch-new.c CLI: make static message strings const 2021-05-14 06:42:55 -03:00
notmuch-reindex.c CLI: make static message strings const 2021-05-14 06:42:55 -03:00
notmuch-reply.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-restore.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-search.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-setup.c CLI: rename notmuch_config_t to notmuch_conffile_t 2021-04-06 21:32:36 -03:00
notmuch-show.c CLI: drop notmuch_config_t from subcommand interface. 2021-04-06 21:32:36 -03:00
notmuch-tag.c CLI: make static message strings const 2021-05-14 06:42:55 -03:00
notmuch-time.c cli: run uncrustify 2021-03-13 08:45:34 -04:00
notmuch.c CLI/notmuch: make immutable tables const 2021-05-14 06:44:00 -03: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 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.32.1 2021-05-15 08:59:01 -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