Add maildir docs
This commit is contained in:
parent
d15ba24a2f
commit
7a26b48c22
4 changed files with 47 additions and 2 deletions
3
Makefile
3
Makefile
|
@ -29,6 +29,7 @@ DOCS := \
|
|||
aerc.1 \
|
||||
aerc-config.5 \
|
||||
aerc-imap.5 \
|
||||
aerc-maildir.5 \
|
||||
aerc-smtp.5 \
|
||||
aerc-tutorial.7
|
||||
|
||||
|
@ -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)
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
40
doc/aerc-maildir.5.scd
Normal file
40
doc/aerc-maildir.5.scd
Normal file
|
@ -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.
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in a new issue