notmuch clon
Find a file
Jani Nikula ed43b8ddcd cli: use the arg parser .present feature to handle show --entire-thread
The --entire-thread default depends on other arguments, so we'll have
to figure out if it was explicitly set by the user or not. The arg
parser .present feature helps us clean up the code here.
2017-10-04 22:02:09 -03:00
bindings python: open messages in binary mode 2017-10-02 07:21:33 -03:00
compat Use rooted paths in .gitignore files 2017-08-18 19:42:35 -03:00
completion completion: add bash completion for "notmuch reindex" 2017-08-18 19:50:21 -03:00
contrib database: add n_d_index_file (deprecates n_d_add_message) 2017-08-23 07:38:37 -03:00
debian debian: update gitignore 2017-09-17 15:53:15 -03:00
devel devel: add script to test out-of-tree builds 2017-10-02 07:25:06 -03:00
doc doc: fix typos 2017-09-28 09:00:20 -03:00
emacs emacs: sanitize subject in replies 2017-09-27 08:15:02 -03:00
lib fix reference to notmuch_message_get_properties 2017-09-24 09:15:24 -03:00
packaging
parse-time-string
performance-test perf-test: add memory test for notmuch-insert 2017-08-20 08:48:43 -03:00
test test: expand argument parsing tests 2017-10-04 22:01:50 -03:00
util cppcheck: call va_end in _internal_error 2017-08-30 07:12:13 -03:00
vim
.dir-locals.el
.gitignore gitignore: add .stamps 2017-08-30 20:14:43 -03:00
.mailmap
.travis.yml .travis.yml: Switch to "sudo: false" for faster builds 2017-08-30 07:26:49 -03:00
AUTHORS
command-line-arguments.c cli: add .present field to opt desc to check if the arg was present 2017-10-04 22:01:40 -03:00
command-line-arguments.h cli: add .present field to opt desc to check if the arg was present 2017-10-04 22:01:40 -03:00
configure build: fix unbound variable in configure 2017-08-31 10:09:02 -03:00
COPYING
COPYING-GPL-3
crypto.c crypto: Avoid explicit handling of GMimeCryptoContext in gmime 3 2017-07-15 21:43:08 -03:00
debugger.c
gmime-filter-reply.c lib&cli: use g_object_new instead of g_object_newv 2017-09-04 08:04:44 -03:00
gmime-filter-reply.h
hooks.c
INSTALL
Makefile support make goals after initial {'', dist, data}clean goal(s) 2017-03-10 08:04:27 -04:00
Makefile.global rename libutil.a to libnotmuch_util.a 2017-03-18 21:37:43 -03:00
Makefile.local build: add target to run cppcheck 2017-08-29 22:05:37 -03:00
mime-node.c show: workaround for the missing file problem 2017-08-22 18:48:29 -03:00
NEWS NEWS: news entry for 0.25.1 2017-09-11 22:20:26 -03:00
notmuch-client.h cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-compact.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-config.c config: deprecate/drop crypto.gpg_path under gmime 2.6/3.0 2017-07-14 21:23:52 -03:00
notmuch-count.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-dump.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-insert.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-new.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-reindex.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-reply.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-restore.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-search.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-setup.c
notmuch-show.c cli: use the arg parser .present feature to handle show --entire-thread 2017-10-04 22:02:09 -03:00
notmuch-tag.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
notmuch-time.c
notmuch.c cli: use designated initializers for opt desc 2017-10-04 22:00:42 -03:00
query-string.c
README
README.rst
sprinter-json.c
sprinter-sexp.c
sprinter-text.c
sprinter.h
status.c cli/insert: return EX_TEMPFAIL for some errors 2016-12-07 07:00:40 -04:00
tag-util.c remove ineffective assignments 2017-06-25 09:38:22 -03:00
tag-util.h
version version: bump to 0.25.1 2017-09-11 22:19:46 -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