SMARC(1) General Commands Manual SMARC(1)

smarc — mailing list static site generator

smarc [-c cachedir] [-j n] [-m maildir] [-o outdir] [-t tmpldir]

smarc generates a static web archive from a maildir incrementally.

The arguments are as follows:

cachedir
Cache directory used for keeping track of threads during incremental updates. Defaults to ~/.cache/smarc
n
Use n jobs to export threads. With big mailing lists and on a multiprocessor machine this can save quite some time.
maildir
Source maildir. Defaults to ~/Mail/smarc.
outdir
The destination directory where the HTML files will be written to, it's /var/www/smarc by default.
tmpldir
Path to a directory containing the template files. /etc/smarc by default.

/etc/smarc/foot.html
Template with the trailing part of the page.
/etc/smarc/head.html
Template with the first part of the page. TITLE is substituted with the title.
/etc/smarc/index-header.html
Template with the title for index pages. PAGE is replaced with the page number and SUBTITLE with the date range.
/etc/smarc/logo-small.html
Small version of the logo, included in the thread header.
/etc/smarc/search-link.html
Template for the search link used in the mail and thread page.
/etc/smarc/search.html
Template for the search form. QUERY is replaced with the search query.
/var/www/smarc
Default output directory.
~/.cache/smarc
Default cache directory.
~/Mail/smarc
Default maildir.

smarc(7)

smarc started as a hacky collection of perl scripts under the name of ‘gotmarc’ to generate a web archive for the Game of Trees mailing list. Only later, while still being a hacky collection of perl and shell scripts, was converted to be a generic web mailing list archive tool and the project renamed.

The smarc utility was written by Omar Polo <op@openbsd.org>.

January 10, 2023 OpenBSD 7.4