1 GOTMARC -- because $POPULAR_ARCHIVE hates us!
2 =============================================
3 
4 A collection of scripts to generate a static mail archive from a
5 Maildir; intended to provide a public web interface for the Game of
6 Trees mailing list.
7 
8 The dependencies are:
9 
10  - mblaze
11  - imagemagick (to resize the got logo)
12 
13 
14 How it works
15 ------------
16 
17 The makefile use mlist(1) to gather all the mail of the mailing list,
18 mthread(1) to arrange them in threads and mscan(1) to parse them.
19 
20 Then, two custom scripts are called in the same pipeline:
21 
22  - mexp: creates a separate HTML page for each mail, as well as the
23    raw message/body parts and the attachments.  it's the heaviest part
24    of the pipeline.
25 
26  - mkindex: generates the index and threads page.
27 
28 
29 Usage
30 -----
31 
32 	$ make MDIR=/path/to/got/maildir
33 
34 will create and populate a `www' directory with the HTML files.  Pass
35 OUTDIR to override the destination directory.
36 
37 For use with httpd' `gzip-static' (or similar)
38 
39 	$ make gzip
40 
41 will recursively compress every file in OUTDIR, leaving the original
42 file intact.