.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "AERC-MAILDIR" "5" "2024-07-30"
.PP
.SH NAME
.PP
aerc-maildir - maildir configuration for \fBaerc\fR(1)
.PP
.SH SYNOPSIS
.PP
aerc implements the maildir format.\&
.PP
.SH CONFIGURATION
.PP
Basic Maildir configuration may be done interactively with the \fB:new-account\fR
command.\&
.PP
The following maildir-specific options are available:
.PP
\fBcheck-mail-cmd\fR = \fI<command>\fR
.RS 4
Command to run in conjunction with \fBcheck-mail\fR option.\&
.PP
Example:
.RS 4
check-mail-cmd = mbsync -a
.PP
.RE
.RE
\fBcheck-mail-timeout\fR = \fI<duration>\fR
.RS 4
Timeout for the \fBcheck-mail-cmd\fR.\& The command will be stopped if it does
not complete in this interval and an error will be displayed.\& Increase from
the default if repeated errors occur
.PP
Default: 10s
.PP
.RE
\fBsource\fR = \fImaildir\fR|\fImaildirpp\fR://\fI<path>\fR
.RS 4
The \fBsource\fR indicates the path to the directory containing your maildirs
rather than one maildir specifically.\&
.PP
The path portion of the URL following \fImaildir://\fR must be either an absolute
path prefixed by \fI/\fR or a path relative to your home directory prefixed with
\fB~\fR.\& For example:
.PP
.RS 4
source = maildir:///home/me/mail
.PP
source = maildir://~/mail
.PP
.RE
If your maildir is using the Maildir++ directory layout, you can use the
\fImaildirpp://\fR scheme instead:
.PP
.RS 4
source = maildirpp:///home/me/mail
.PP
source = maildirpp://~/mail
.PP
.RE
.RE
.SH SEE ALSO
.PP
\fBaerc\fR(1) \fBaerc-accounts\fR(5) \fBaerc-smtp\fR(5) \fBaerc-notmuch\fR(5)
.PP
.SH AUTHORS
.PP
Originally created by Drew DeVault and maintained by Robin Jarry who is assisted
by other open source contributors.\& For more information about aerc development,
see \fIhttps://sr.\&ht/~rjarry/aerc/\fR.\&