crabmail-config.5 (1892B) - raw
1 .\" Generated by scdoc 1.11.2 2 .\" Complete documentation for this program is not available as a GNU info page 3 .ie \n(.g .ds Aq \(aq 4 .el .ds Aq ' 5 .nh 6 .ad l 7 .\" Begin generated content: 8 .TH "crabmail-config" "5" "2022-04-03" 9 .P 10 .SH NAME 11 .P 12 crabmail-config - configuration file formats for \fBcrabmail\fR(1) 13 .P 14 .SH CONFIGURATION 15 .P 16 Each file uses an \fIini\fR format defined as follows: key=valuen.\& Keys cannot 17 contain =.\& Values cannot contain n.\& There are no other restrictions.\& 18 .P 19 Section headers are defined by [brackets].\& These are optional, and can define 20 archive-specific configuration 21 .P 22 This variables are often not escaped, so treat this file as trusted input (ie, 23 don'\&t fill in values from user input somehow).\& 24 .P 25 .SH CRABMAIL.CONF 26 .P 27 .SS GLOBAL 28 .P 29 \fBbase_url\fR 30 .RS 4 31 The base URL where your archive is hosted, used to generate atom feeds 32 .P 33 .RE 34 \fBemail_fmt\fR 35 .RS 4 36 The structure of how emails are mapped to mail folders, for example 37 lists+%s@flounder.\&online will replace %s with the archive name.\& You can 38 override this in archive-specific configuration 39 .P 40 .RE 41 \fBtitle_fmt\fR 42 .RS 4 43 The structure of how names of each mail archive are structured, for example 44 %s public inbox_ or %s mailing list.\& Will be overwritten if title is set for 45 individual archives.\& 46 .P 47 .RE 48 \fBdescription\fR 49 .RS 4 50 A description for your homepage, will be displayed as a single line.\& HTML is 51 allowed if you want.\& 52 .P 53 .RE 54 .SS Archives 55 .P 56 Each mail archive is specified with a [subsection] header.\& 57 .P 58 \fBtitle\fR 59 .RS 4 60 Title of the archive.\& Default tile for archives is set by \fBtitle_fmt\fR 61 .P 62 .RE 63 \fBemail\fR 64 .RS 4 65 Email of this archive.\& Overrides \fBemail_fmt\fR.\& 66 .P 67 .RE 68 \fBdescription\fR 69 .RS 4 70 A description for your archive.\& HTML is allowed, but be judicious.\& 71 .P 72 .RE 73 .SH SEE ALSO 74 .P 75 \fBcrabmail\fR(1) 76 .P 77 .SH AUTHORS 78 Alex Wennerberg <alex@alexwennerberg.\&com>