crabmail/doc/crabmail-config.5

.\" Generated by scdoc 1.11.2
.\" 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 "crabmail-config" "5" "2022-04-03"
.P
.SH NAME
.P
crabmail-config - configuration file formats for \fBcrabmail\fR(1)
.P
.SH CONFIGURATION
.P
Each file uses an \fIini\fR format defined as follows: key=valuen.\& Keys cannot
contain =.\& Values cannot contain n.\& There are no other restrictions.\&
.P
Section headers are defined by [brackets].\& These are optional, and can define
archive-specific configuration
.P
This variables are often not escaped, so treat this file as trusted input (ie,
don'\&t fill in values from user input somehow).\&
.P
.SH CRABMAIL.CONF
.P
.SS GLOBAL
.P
\fBbase_url\fR
.RS 4
The base URL where your archive is hosted, used to generate atom feeds
.P
.RE
\fBemail_fmt\fR
.RS 4
The structure of how emails are mapped to mail folders, for example
lists+%s@flounder.\&online will replace %s with the archive name.\& You can
override this in archive-specific configuration
.P
.RE
\fBtitle_fmt\fR
.RS 4
The structure of how names of each mail archive are structured, for example
%s public inbox_ or %s mailing list.\& Will be overwritten if title is set for
individual archives.\&
.P
.RE
\fBdescription\fR
.RS 4
A description for your homepage, will be displayed as a single line.\& HTML is
allowed if you want.\&
.P
.RE
.SS Archives
.P
Each mail archive is specified with a [subsection] header.\&
.P
\fBtitle\fR
.RS 4
Title of the archive.\& Default tile for archives is set by \fBtitle_fmt\fR
.P
.RE
\fBemail\fR
.RS 4
Email of this archive.\& Overrides \fBemail_fmt\fR.\&
.P
.RE
\fBdescription\fR
.RS 4
A description for your archive.\& HTML is allowed, but be judicious.\&
.P
.RE
.SH SEE ALSO
.P
\fBcrabmail\fR(1) 
.P
.SH AUTHORS
Alex Wennerberg <alex@alexwennerberg.\&com>