From: Ben Burwell <ben@benburwell.com>
To: ~sircmpwn/aerc@lists.sr.ht
Cc: Ben Burwell <ben@benburwell.com>
Subject: [PATCH v2 5/5] Add maildir docs
Date: Thu, 11 Jul 2019 09:44:54 -0400
Message-Id: <20190711134454.80318-6-ben@benburwell.com>
In-Reply-To: <20190711134454.80318-1-ben@benburwell.com>
References: <20190711134454.80318-1-ben@benburwell.com>
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

---
From v1, added a note about aerc-maildir to aerc-config which I had
previously overlooked.

 Makefile               |  3 +++
 doc/aerc-config.5.scd  |  3 ++-
 doc/aerc-maildir.5.scd | 40 ++++++++++++++++++++++++++++++++++++++++
 doc/aerc.1.scd         |  3 ++-
 4 files changed, 47 insertions(+), 2 deletions(-)
 create mode 100644 doc/aerc-maildir.5.scd

diff --git a/Makefile b/Makefile
index 4ff1aae..6609640 100644
--- a/Makefile
+++ b/Makefile
@@ -29,6 +29,7 @@ DOCS :=3D \
 	aerc.1 \
 	aerc-config.5 \
 	aerc-imap.5 \
+	aerc-maildir.5 \
 	aerc-smtp.5 \
 	aerc-tutorial.7
=20
@@ -58,6 +59,7 @@ install: all
 	install -m644 aerc.1 $(MANDIR)/man1/aerc.1
 	install -m644 aerc-config.5 $(MANDIR)/man5/aerc-config.5
 	install -m644 aerc-imap.5 $(MANDIR)/man5/aerc-imap.5
+	install -m644 aerc-maildir.5 $(MANDIR)/man5/aerc-maildir.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
@@ -77,6 +79,7 @@ uninstall:
 	$(RM) $(MANDIR)/man1/aerc.1
 	$(RM) $(MANDIR)/man5/aerc-config.5
 	$(RM) $(MANDIR)/man5/aerc-imap.5
+	$(RM) $(MANDIR)/man5/aerc-maildir.5
 	$(RM) $(MANDIR)/man5/aerc-smtp.5
 	$(RM) $(MANDIR)/man7/aerc-tutorial.7
 	$(RM) -r $(SHAREDIR)
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index db69aff..2f4f993 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -201,6 +201,7 @@ Note that many of these configuration options are wri=
tten for you, such as
 	See each protocol's man page for more details:
=20
 	- *aerc-imap*(5)
+	- *aerc-maildir*(5)
=20
 	Default: none
=20
@@ -366,7 +367,7 @@ following special keys are supported:
=20
 # SEE ALSO
=20
-*aerc*(1) *aerc-imap*(5) *aerc-smtp*(5)
+*aerc*(1) *aerc-imap*(5) *aerc-smtp*(5) *aerc-maildir*(5)
=20
 # AUTHORS
=20
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
new file mode 100644
index 0000000..5765bf8
--- /dev/null
+++ b/doc/aerc-maildir.5.scd
@@ -0,0 +1,40 @@
+aerc-maildir(5)
+
+# NAME
+
+aerc-maildir - maildir configuration for *aerc*(1)
+
+# SYNOPSIS
+
+aerc implements the maildir format.
+
+# CONFIGURATION
+
+Maildir accounts currently are not supported with the :new-account comma=
nd and
+must be added manually to the *aerc-config*(5) file.
+
+The following maildir-specific options are available:
+
+*source*
+	maildir://path
+
+	The *source* indicates the path to the directory containing your maildi=
rs
+	rather than one maildir specifically.
+
+	The path portion of the URL following _maildir://_ must be either an ab=
solute
+	path prefixed by */* or a path relative to your home directory prefixed=
 with
+	*~*. For example:
+
+		source =3D maildir:///home/me/mail
+
+		source =3D maildir://~/mail
+
+# SEE ALSO
+
+*aerc*(1) *aerc-config*(5) *aerc-smtp*(5)
+
+# AUTHORS
+
+Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other ope=
n
+source contributors. For more information about aerc development, see
+https://git.sr.ht/~sircmpwn/aerc.
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index ba5c5c7..050396f 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -169,7 +169,8 @@ write log messages to that file:
=20
 # SEE ALSO
=20
-*aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-tutorial*(7)
+*aerc-config*(5) *aerc-imap*(5) *aerc-smtp*(5) *aerc-maildir*(5)
+*aerc-tutorial*(7)
=20
 # AUTHORS
=20
--=20
2.22.0