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
 5 1276a9dc 2023-05-05 op .Dt GOTMARC 1
 6 1276a9dc 2023-05-05 op .Os
 7 1276a9dc 2023-05-05 op .Sh NAME
 8 1276a9dc 2023-05-05 op .Nm gotmarc
 9 1276a9dc 2023-05-05 op .Nd mailing list static site generator
10 1276a9dc 2023-05-05 op .Sh SYNOPSIS
11 1276a9dc 2023-05-05 op .Nm
12 1276a9dc 2023-05-05 op .Op Fl c Ar cachedir
13 1276a9dc 2023-05-05 op .Op Fl j Ar n
14 1276a9dc 2023-05-05 op .Op Fl m Ar maildir
15 1276a9dc 2023-05-05 op .Op Fl o Ar outdir
16 1276a9dc 2023-05-05 op .Sh DESCRIPTION
17 1276a9dc 2023-05-05 op .Nm
18 1276a9dc 2023-05-05 op generates a static web archive from a maildir incrementally.
19 1276a9dc 2023-05-05 op .Pp
20 1276a9dc 2023-05-05 op The arguments are as follows:
21 1276a9dc 2023-05-05 op .Bl -tag -width Ds
22 1276a9dc 2023-05-05 op .It Fl c Ar cachedir
23 1276a9dc 2023-05-05 op Cache directory used for keeping track of threads during incremental
24 1276a9dc 2023-05-05 op updates.
25 1276a9dc 2023-05-05 op Defaults to
26 1276a9dc 2023-05-05 op .Pa ~/.cache/gotmarc
27 1276a9dc 2023-05-05 op .It Fl j Ar n
28 1276a9dc 2023-05-05 op Use
29 1276a9dc 2023-05-05 op .Ar n
30 1276a9dc 2023-05-05 op jobs to export threads.
31 1276a9dc 2023-05-05 op With big mailing lists and on a multiprocessor machine this can save
32 1276a9dc 2023-05-05 op quite some time.
33 1276a9dc 2023-05-05 op .It Fl m Ar maildir
34 1276a9dc 2023-05-05 op Source
35 1276a9dc 2023-05-05 op .Ar maildir .
36 1276a9dc 2023-05-05 op Defaults to
37 1276a9dc 2023-05-05 op .Pa ~/Mail/gotmarc .
38 1276a9dc 2023-05-05 op .It Fl o Ar outdir
39 1276a9dc 2023-05-05 op The destination directory where the HTML files will be written to, it's
40 1276a9dc 2023-05-05 op .Pa /var/www/gotmarc
41 1276a9dc 2023-05-05 op by default.
42 1276a9dc 2023-05-05 op .El
43 1276a9dc 2023-05-05 op .Sh FILES
44 1276a9dc 2023-05-05 op .Bl -tag -compact -width ~/.cache/gotmarc
45 1276a9dc 2023-05-05 op .It Pa /var/www/gotmarc
46 1276a9dc 2023-05-05 op Default output directory.
47 1276a9dc 2023-05-05 op .It Pa ~/.cache/gotmarc
48 1276a9dc 2023-05-05 op Default cache directory.
49 1276a9dc 2023-05-05 op .It Pa ~/Mail/gotmarc
50 1276a9dc 2023-05-05 op Default maildir.
51 1276a9dc 2023-05-05 op .El
52 1276a9dc 2023-05-05 op .Sh SEE ALSO
53 1276a9dc 2023-05-05 op .Xr gotmarc 7
54 1276a9dc 2023-05-05 op .Sh HISTORY
55 1276a9dc 2023-05-05 op .Nm
56 1276a9dc 2023-05-05 op started as a hacky collection of perl scripts to generate a web archive
57 1276a9dc 2023-05-05 op for the Game of Trees mailing list.
58 1276a9dc 2023-05-05 op Only later it was converted to be a usable generic web mailing list
59 1276a9dc 2023-05-05 op archive tool.
60 1276a9dc 2023-05-05 op .Sh AUTHORS
61 1276a9dc 2023-05-05 op .An -nosplit
62 1276a9dc 2023-05-05 op The
63 1276a9dc 2023-05-05 op .Nm
64 1276a9dc 2023-05-05 op utility was written by
65 1276a9dc 2023-05-05 op .An Omar Polo Aq Mt op@openbsd.org .