Add notmuch docs

5 files changed, 73 insertions, 1 deletions

diff --git a/Makefile b/Makefile
index d3072d37..a9b5c85f 100644
--- a/Makefile
+++ b/Makefile
@@ -32,6 +32,7 @@ DOCS := \
 	aerc-imap.5 \
 	aerc-maildir.5 \
 	aerc-sendmail.5 \
+	aerc-notmuch.5 \
 	aerc-smtp.5 \
 	aerc-tutorial.7
 
@@ -63,6 +64,7 @@ install: all
 	install -m644 aerc-imap.5 $(MANDIR)/man5/aerc-imap.5
 	install -m644 aerc-maildir.5 $(MANDIR)/man5/aerc-maildir.5
 	install -m644 aerc-sendmail.5 $(MANDIR)/man5/aerc-sendmail.5
+	install -m644 aerc-notmuch.5 $(MANDIR)/man5/aerc-notmuch.5
 	install -m644 aerc-smtp.5 $(MANDIR)/man5/aerc-smtp.5
 	install -m644 aerc-tutorial.7 $(MANDIR)/man7/aerc-tutorial.7
 	install -m644 config/accounts.conf $(SHAREDIR)/accounts.conf
@@ -84,6 +86,7 @@ uninstall:
 	$(RM) $(MANDIR)/man5/aerc-imap.5
 	$(RM) $(MANDIR)/man5/aerc-maildir.5
 	$(RM) $(MANDIR)/man5/aerc-sendmail.5
+	$(RM) $(MANDIR)/man5/aerc-notmuch.5
 	$(RM) $(MANDIR)/man5/aerc-smtp.5
 	$(RM) $(MANDIR)/man7/aerc-tutorial.7
 	$(RM) -r $(SHAREDIR)
diff --git a/README.md b/README.md
index 7b13d401..1f12ed96 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,12 @@ Then compile aerc:
 
     $ make
 
+aerc optionally supports notmuch. To enable it, you need to have a recent
+version of [notmuch](https://notmuchmail.org/#index7h2), including the header
+files (notmuch.h). Then compile aerc with the necessary build tags:
+
+    $ GOFLAGS=-tags=notmuch make
+
 ## Installation
 
     # make install
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index a57f760b..995fe75a 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -257,6 +257,7 @@ Note that many of these configuration options are written for you, such as
 
 	- *aerc-imap*(5)
 	- *aerc-maildir*(5)
+	- *aerc-notmuch*(5)
 
 	Default: none
 
@@ -423,6 +424,7 @@ following special keys are supported:
 # SEE ALSO
 
 *aerc*(1) *aerc-imap*(5) *aerc-smtp*(5) *aerc-maildir*(5) *aerc-sendmail*(5)
+*aerc-notmuch*(5)
 
 # AUTHORS
 
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
index 5765bf81..37a654b4 100644
--- a/doc/aerc-maildir.5.scd
+++ b/doc/aerc-maildir.5.scd
@@ -31,7 +31,7 @@ The following maildir-specific options are available:
 
 # SEE ALSO
 
-*aerc*(1) *aerc-config*(5) *aerc-smtp*(5)
+*aerc*(1) *aerc-config*(5) *aerc-smtp*(5) *aerc-notmuch*(5)
 
 # AUTHORS
 
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd
new file mode 100644
index 00000000..6e982857
--- /dev/null
+++ b/doc/aerc-notmuch.5.scd
@@ -0,0 +1,61 @@
+aerc-notmuch(5)
+
+# NAME
+
+aerc-notmuch - notmuch configuration for *aerc*(1)
+
+# SYNOPSIS
+
+aerc supports using the notmuch email system as a backend, for fast indexing
+and searching.
+
+For this to be enabled, aerc needs to be build with notmuch support.++
+Refer to the installation instructions for details.
+
+# CONFIGURATION
+
+Notmuch accounts currently are not supported with the :new-account command and
+must be added manually.
+
+In accounts.conf (see *aerc-config*(5)), the following notmuch-specific
+options are available:
+
+*source*
+	notmuch://path
+
+	The *source* indicates the path to the directory containing your notmuch
+	database (usually a .notmuch folder).
+
+	The path portion of the URL following _notmuch://_ must be either an absolute
+	path prefixed by */* or a path relative to your home directory prefixed with
+	*~*. For example:
+
+		source = notmuch:///home/me/mail
+
+		source = notmuch://~/mail
+
+*query-map*
+	Path to a file containing a mapping from display name to notmuch query in
+	the form of NAME=QUERY.++
+Multiple entries can be specified, one per line.
+
+	e.g. inbox=tag:inbox and not tag:archived
+
+	Default: none
+
+*exclude-tags*
+	Comma separated list of tags which will be excluded from query results,
+	unless explicitly mentioned in the query.++
+This can for example be useful if you use an archive or spam tag.
+
+	Default: none
+
+# SEE ALSO
+
+*aerc*(1) *aerc-config*(5) *aerc-smtp*(5) *aerc-maildir*(5)
+
+# AUTHORS
+
+Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other open
+source contributors. For more information about aerc development, see
+https://git.sr.ht/~sircmpwn/aerc.