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