aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-maildir.5.scd
diff options
context:
space:
mode:
authorBen Burwell <ben@benburwell.com>2019-07-11 09:44:54 -0400
committerDrew DeVault <sir@cmpwn.com>2019-07-12 11:26:39 -0400
commit7a26b48c228ef59287847e7540b1cf19eacd6070 (patch)
treea460422ead930939e501284b1df275be13d0b66c /doc/aerc-maildir.5.scd
parentd15ba24a2f0c177593533874ce3f4b70a47d832d (diff)
downloadaerc-7a26b48c228ef59287847e7540b1cf19eacd6070.tar.gz
Add maildir docs
Diffstat (limited to 'doc/aerc-maildir.5.scd')
-rw-r--r--doc/aerc-maildir.5.scd40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
new file mode 100644
index 00000000..5765bf81
--- /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 command 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 maildirs
+ rather than one maildir specifically.
+
+ The path portion of the URL following _maildir://_ must be either an absolute
+ path prefixed by */* or a path relative to your home directory prefixed with
+ *~*. For example:
+
+ source = maildir:///home/me/mail
+
+ source = 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 open
+source contributors. For more information about aerc development, see
+https://git.sr.ht/~sircmpwn/aerc.