diff options
| author | Ben Burwell <ben@benburwell.com> | 2019-07-11 09:44:54 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2019-07-12 11:26:39 -0400 |
| commit | 7a26b48c228ef59287847e7540b1cf19eacd6070 (patch) | |
| tree | a460422ead930939e501284b1df275be13d0b66c /doc | |
| parent | d15ba24a2f0c177593533874ce3f4b70a47d832d (diff) | |
Add maildir docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/aerc-config.5.scd | 3 | ||||
| -rw-r--r-- | doc/aerc-maildir.5.scd | 40 | ||||
| -rw-r--r-- | doc/aerc.1.scd | 3 |
3 files changed, 44 insertions, 2 deletions
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 written for you, such as See each protocol's man page for more details: - *aerc-imap*(5) + - *aerc-maildir*(5) Default: none @@ -366,7 +367,7 @@ following special keys are supported: # SEE ALSO -*aerc*(1) *aerc-imap*(5) *aerc-smtp*(5) +*aerc*(1) *aerc-imap*(5) *aerc-smtp*(5) *aerc-maildir*(5) # AUTHORS 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 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. 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: # SEE ALSO -*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) # AUTHORS |