1 .\" gotmarc.1 was written by Omar Polo <op@openbsd.org> and is placed in
2 .\" the public domain.  The author hereby disclaims copyright to this
3 .\" source code.
4 .Dd May 5, 2023
5 .Dt GOTMARC 1
6 .Os
7 .Sh NAME
8 .Nm gotmarc
9 .Nd mailing list static site generator
10 .Sh SYNOPSIS
11 .Nm
12 .Op Fl c Ar cachedir
13 .Op Fl j Ar n
14 .Op Fl m Ar maildir
15 .Op Fl o Ar outdir
16 .Op Fl t Ar tmpldir
17 .Sh DESCRIPTION
18 .Nm
19 generates a static web archive from a maildir incrementally.
20 .Pp
21 The arguments are as follows:
22 .Bl -tag -width Ds
23 .It Fl c Ar cachedir
24 Cache directory used for keeping track of threads during incremental
25 updates.
26 Defaults to
27 .Pa ~/.cache/gotmarc
28 .It Fl j Ar n
29 Use
30 .Ar n
31 jobs to export threads.
32 With big mailing lists and on a multiprocessor machine this can save
33 quite some time.
34 .It Fl m Ar maildir
35 Source
36 .Ar maildir .
37 Defaults to
38 .Pa ~/Mail/gotmarc .
39 .It Fl o Ar outdir
40 The destination directory where the HTML files will be written to, it's
41 .Pa /var/www/gotmarc
42 by default.
43 .It Fl t Ar tmpldir
44 Path to a directory containing the template files.
45 .Pa /etc/gotmarc
46 by default.
47 .El
48 .Sh FILES
49 .Bl -tag -width Ds
50 .It Pa /etc/gotmarc/foot.html
51 Template with the trailing part of the page.
52 .It Pa /etc/gotmarc/head.html
53 Template with the first part of the page.
54 .Dv TITLE
55 is substituted with the title.
56 .It Pa /etc/gotmarc/index-header.html
57 Template with the title for index pages.
58 .Dv PAGE
59 is replaced with the page number and
60 .Dv SUBTITLE
61 with the date range.
62 .It Pa /etc/gotmarc/logo-small.html
63 Small version of the logo, included in the thread header.
64 .It Pa /etc/gotmarc/search.html
65 Template for the search form.
66 .Ev QUERY
67 is replaced with the search query.
68 .It Pa /var/www/gotmarc
69 Default output directory.
70 .It Pa ~/.cache/gotmarc
71 Default cache directory.
72 .It Pa ~/Mail/gotmarc
73 Default maildir.
74 .El
75 .Sh SEE ALSO
76 .Xr gotmarc 7
77 .Sh HISTORY
78 .Nm
79 started as a hacky collection of perl scripts to generate a web archive
80 for the Game of Trees mailing list.
81 Only later it was converted to be a usable generic web mailing list
82 archive tool.
83 .Sh AUTHORS
84 .An -nosplit
85 The
86 .Nm
87 utility was written by
88 .An Omar Polo Aq Mt op@openbsd.org .