notmuch.git  about / heads / tags
Unnamed repository; edit this file 'description' to name the repository.
$ git log --pretty=format:'%h %s (%cs)%d'
cd89065d emacs: Add new option notmuch-search-hide-excluded (2024-04-06)
	(HEAD -> master)
de234097 perf-test/tag: add maildir sync tests (2024-04-05)
8d06dfce emacs: Autoload notmuch-user-agent related functions (2024-04-04)
d1ba5d63 emacs: Mark "notmuch-tree" command for autoloading (2024-04-04)
baaad2a2 NEWS: aspell(1)d few words (2024-03-12)
0c7726dc Merge tag 'debian/0.38.3-1' (2024-03-11)
78f9c6eb debian: update changelog date (2024-03-09)
	(tag: debian/0.38.3-1, tag: archive/debian/0.38.3-1, release)
f8253363 Merge from sid [dgit] (2024-03-09)
801ca7fa Revert "debian: start changelog for 0.38.3-1" (2024-03-09)
d0469c5b version: bump to 0.38.3 (2024-03-09)
	(tag: 0.38.3)
...

$ git cat-file blob HEAD:README
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

# heads (aka `branches'):
$ git for-each-ref --sort=-creatordate refs/heads \
	--format='%(HEAD) %(refname:short) %(subject) (%(creatordate:short))'
* master       emacs: Add new option notmuch-search-hide-excluded (2024-04-06)
  release      debian: update changelog date (2024-03-09)
  pristine-tar pristine-tar data for notmuch_0.38.3.orig.tar.xz (2024-03-09)
  debian/bookworm-backports changelog for backport 0.38.1-1~bpo12+1 (2023-11-01)
  nmweb        Merge remote-tracking branch 'origin/master' into nmweb (2023-09-18)
  fix/ghost-cleanup start program to do a census of ghost messages (2023-04-25)
  debian/bullseye-backports debian: 0.37-1~bpo11+2 (2022-10-10)
  next         lib/open: create database path in some cases (2022-08-11)
  debian/buster-backports Changelog for backport of 0.31.4-2 (2021-09-10)
  shared-options CLI: make variable n_requested_db_uuid file scope. (2021-08-22)
...

# tags:
$ git for-each-ref --sort=-creatordate refs/tags \
	--format='%(refname:short) %(subject) (%(creatordate:short))'
archive/debian/0.38.3-1 notmuch release 0.38.3-1 for unstable (sid) [dgit] (2024-03-09)
debian/0.38.3-1 notmuch release 0.38.3-1 for unstable (sid) [dgit] (2024-03-09)
0.38.3       notmuch 0.38.3 release (2024-03-09)
0.38.2       notmuch 0.38.2 release (2023-12-01)
archive/debian/0.38.2-1 notmuch release 0.38.2-1 for unstable (sid) [dgit] (2023-12-01)
debian/0.38.2-1 notmuch release 0.38.2-1 for unstable (sid) [dgit] (2023-12-01)
archive/debian/0.38.1-1_bpo12+1 notmuch release 0.38.1-1~bpo12+1 for bookworm-backports (bookworm-backports) [dgit] (2023-11-01)
debian/0.38.1-1_bpo12+1 notmuch release 0.38.1-1~bpo12+1 for bookworm-backports (bookworm-backports) [dgit] (2023-11-01)
0.38.1       notmuch 0.38.1 release (2023-10-26)
archive/debian/0.38.1-1 notmuch release 0.38.1-1 for unstable (sid) [dgit] (2023-10-26)
...

# associated public inboxes:
# (number on the left is used for dev purposes)
            https://yhetil.org/notmuch/

git clone https://yhetil.org/notmuch.git