1 38232a0a 2023-05-07 op SMARC -- static web mail archive generator
2 38232a0a 2023-05-07 op ==========================================
4 b2508be5 2022-08-24 op A collection of scripts to generate a static mail archive from a
5 f7276967 2023-05-06 op Maildir; originally intended to provide a public web interface for the
6 f7276967 2023-05-06 op Game of Trees mailing list, now flexible enough to be used for other
9 f7276967 2023-05-06 op The static site generator depends on perl and mblaze, the web search
10 f7276967 2023-05-06 op component on libevent and sqlite3.
16 38232a0a 2023-05-07 op smarc(1) incrementally generate a set of static files from a maildir,
17 38232a0a 2023-05-07 op smingest(1) and msearchd(8) are used to populate an sqlite3 database to
18 f7276967 2023-05-06 op provide a web-based full text search on all the mails.
20 95cbc4cd 2023-05-07 op smarc(7) documents the step needed for a first setup, how to operate it
21 95cbc4cd 2023-05-07 op and tips for generating multiple archives.
27 95cbc4cd 2023-05-07 op To compile it, run
31 95cbc4cd 2023-05-07 op # make install
33 95cbc4cd 2023-05-07 op Several parameters can be passed to the `configure' script to customize
36 95cbc4cd 2023-05-07 op --mandir or MANDIR Where to install man pages
37 95cbc4cd 2023-05-07 op --perllib or PERLLIB Where to install the perl module
38 95cbc4cd 2023-05-07 op --prefix or PREFIX Where to install, /usr/local
39 95cbc4cd 2023-05-07 op --realsysconfdir or REALSYSCONFDIR "Real" sysconfdir
40 95cbc4cd 2023-05-07 op --sharedir or SHAREDIR $PREFIX/share by default
41 95cbc4cd 2023-05-07 op --sysconfdir or SYSCONFDIR /etc
42 95cbc4cd 2023-05-07 op --wwwuser or WWWUSER Name of the user used by msearchd
46 95cbc4cd 2023-05-07 op CC The C compiler
47 95cbc4cd 2023-05-07 op CFLAGS Flags for the C compiler
48 95cbc4cd 2023-05-07 op LDFLAGS Flags for the linker
49 95cbc4cd 2023-05-07 op PKG_CONFIG pkg-config program, use `no' or empty to disable usage
51 95cbc4cd 2023-05-07 op The variables can also be set in the environment for the configure
52 95cbc4cd 2023-05-07 op script to pick them up.
54 95cbc4cd 2023-05-07 op The difference between REALSYSCONFDIR and SYSCONFDIR is to accomodate
55 95cbc4cd 2023-05-07 op the packaging on some systems. For example, on OpenBSD SYSCONFDIR is
56 95cbc4cd 2023-05-07 op pointed at /usr/local/share/examples and the port then copies the files
57 95cbc4cd 2023-05-07 op in /etc, to allow the user to freely change some files and keep edits
58 95cbc4cd 2023-05-07 op across package updates.
60 95cbc4cd 2023-05-07 op smarc always installs in SYSCONFDIR but at runtime looks into
61 95cbc4cd 2023-05-07 op REALSYSCONFDIR.
67 38232a0a 2023-05-07 op smarc, smingest and msearchd are released in the public domain. The
68 f7276967 2023-05-06 op configure script loosely based on oconfigure and is released under the
69 f7276967 2023-05-06 op terms of ISC license. Some OpenBSD-compats are included to build on
70 f7276967 2023-05-06 op multiple platforms, these are released under a BSD-style license.
71 f7276967 2023-05-06 op See the first lines of each file for the copyright owners.
