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 uses mlist(1) to gather all the mail of the mailing list,
18 mthread(1) for threading and mscan(1) for parsing.
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.  If a message appears to have already been exported,
25    it will be skipped to save some time.
26 
27  - mkindex: generates the index and threads page.
28 
29 
30 Usage
31 -----
32 
33 	$ make MDIR=/path/to/got/maildir
34 
35 will create and populate a `www' directory with the HTML files.  Pass
36 OUTDIR to override the destination directory.
37 
38 Every once in a while, the maildir should be synced (with mbsync for
39 example) and `make' re-run to update the archive.  gotmarc does
40 incremental updates to some extent so except for the first run, which
41 will take a while, updating the archive should be fast.
42 
43 For use with httpd' `gzip-static' (or similar)
44 
45 	$ make gzip
46 
47 will recursively compress every file in OUTDIR, leaving the original
48 file intact.
49 
50 
51 License
52 -------
53 
54 As far as I'm concerned, gotmarc (i.e. all the code in this
55 repository) is in the public domain.