1 1276a9dc 2023-05-05 op .\" gotmarc.1 was written by Omar Polo <op@openbsd.org> and is placed in
2 1276a9dc 2023-05-05 op .\" the public domain. The author hereby disclaims copyright to this
3 1276a9dc 2023-05-05 op .\" source code.
4 1276a9dc 2023-05-05 op .Dd May 5, 2023
9 1276a9dc 2023-05-05 op .Nd mailing list static site generator
12 1276a9dc 2023-05-05 op .Op Fl c Ar cachedir
14 1276a9dc 2023-05-05 op .Op Fl m Ar maildir
15 1276a9dc 2023-05-05 op .Op Fl o Ar outdir
16 469be48e 2023-05-05 op .Op Fl t Ar tmpldir
17 1276a9dc 2023-05-05 op .Sh DESCRIPTION
19 1276a9dc 2023-05-05 op generates a static web archive from a maildir incrementally.
21 1276a9dc 2023-05-05 op The arguments are as follows:
22 1276a9dc 2023-05-05 op .Bl -tag -width Ds
23 1276a9dc 2023-05-05 op .It Fl c Ar cachedir
24 1276a9dc 2023-05-05 op Cache directory used for keeping track of threads during incremental
27 1276a9dc 2023-05-05 op .Pa ~/.cache/gotmarc
31 1276a9dc 2023-05-05 op jobs to export threads.
32 1276a9dc 2023-05-05 op With big mailing lists and on a multiprocessor machine this can save
33 1276a9dc 2023-05-05 op quite some time.
34 1276a9dc 2023-05-05 op .It Fl m Ar maildir
38 1276a9dc 2023-05-05 op .Pa ~/Mail/gotmarc .
39 1276a9dc 2023-05-05 op .It Fl o Ar outdir
40 1276a9dc 2023-05-05 op The destination directory where the HTML files will be written to, it's
41 1276a9dc 2023-05-05 op .Pa /var/www/gotmarc
43 469be48e 2023-05-05 op .It Fl t Ar tmpldir
44 469be48e 2023-05-05 op Path to a directory containing the template files.
45 469be48e 2023-05-05 op .Pa /etc/gotmarc
49 469be48e 2023-05-05 op .Bl -tag -width Ds
50 469be48e 2023-05-05 op .It Pa /etc/gotmarc/foot.html
51 469be48e 2023-05-05 op Template with the trailing part of the page.
52 469be48e 2023-05-05 op .It Pa /etc/gotmarc/head.html
53 469be48e 2023-05-05 op Template with the first part of the page.
55 469be48e 2023-05-05 op is substituted with the title.
56 469be48e 2023-05-05 op .It Pa /etc/gotmarc/index-header.html
57 469be48e 2023-05-05 op Template with the title for index pages.
59 469be48e 2023-05-05 op is replaced with the page number and
61 469be48e 2023-05-05 op with the date range.
62 469be48e 2023-05-05 op .It Pa /etc/gotmarc/logo-small.html
63 469be48e 2023-05-05 op Small version of the logo, included in the thread header.
64 789a106a 2023-05-05 op .It Pa /etc/gotmarc/search.html
65 789a106a 2023-05-05 op Template for the search form.
67 789a106a 2023-05-05 op is replaced with the search query.
68 1276a9dc 2023-05-05 op .It Pa /var/www/gotmarc
69 1276a9dc 2023-05-05 op Default output directory.
70 1276a9dc 2023-05-05 op .It Pa ~/.cache/gotmarc
71 1276a9dc 2023-05-05 op Default cache directory.
72 1276a9dc 2023-05-05 op .It Pa ~/Mail/gotmarc
73 1276a9dc 2023-05-05 op Default maildir.
79 1276a9dc 2023-05-05 op started as a hacky collection of perl scripts to generate a web archive
80 1276a9dc 2023-05-05 op for the Game of Trees mailing list.
81 1276a9dc 2023-05-05 op Only later it was converted to be a usable generic web mailing list
87 1276a9dc 2023-05-05 op utility was written by
88 1276a9dc 2023-05-05 op .An Omar Polo Aq Mt op@openbsd.org .