Mon Aug 29 20:50:59 2022 UTC
tweak the readme the subtitle was meant to be more of a joke, but as it can be misinterpreted let's change it.
GOTMARC -- A web archive for the Game of Trees mailing list===========================================================A collection of scripts to generate a static mail archive from aMaildir; intended to provide a public web interface for the Game ofTrees mailing list.The only dependency outside base is mblaze.How it works------------The makefile uses mlist(1) to gather all the mail of the mailing list,mthread(1) for threading and mscan(1) for parsing.Then, three custom scripts are called:- mexp: creates a separate HTML page for each mail, as well as theraw message/body parts and the attachments. It's the heaviest partof the pipeline. If a message appears to have already been exported,it will be skipped to save some time.- pe: (parallelized export) since mexp is slow, attemps to run N mexpprocesses in parallel and dispatch threads to them.- mkindex: generates the index and threads page.Usage-----$ make MDIR=/path/to/got/maildirwill create and populate a `/var/www/marc' directory with the HTMLfiles. Pass OUTDIR to override the destination directory. MDIRdefaults to ~/Mail/gameoftrees.There's some basic support for parallelizing the export, although it'sdisabled by default. Tweak MAKE_JOBS for `pe' to use multiple jobs.Every once in a while, the maildir should be synced (with mbsync forexample) and `make' re-run to update the archive. gotmarc doesincremental updates to some extent so except for the first run, whichwill take a while, updating the archive should be fast.For use with httpd' `gzip-static' (or similar)$ make gzipwill recursively compress every file in OUTDIR, leaving the originalfile intact.License-------As far as I'm concerned, gotmarc (i.e. all the code in thisrepository) is in the public domain.