README.7


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

.Dd March  2, 2021
.Dt README 7
.Os "Causal Agency"
.
.Sh NAME
.Nm bubger kirg
.Nd have it in a way
.
.Sh DESCRIPTION
.Xr bubger 1
is a mailing list archive generator
for mail stored in IMAP.
It produces static files of
HTML, Atom and mboxrd,
making its output easy to serve
from a host without IMAP access.
It requires the IMAP SORT and THREAD extensions.
.
.Pp
An example of its output
can be seen at
.Lk https://causal.agency/list/ .
.
.Sh INSTALLING
.Nm bubger
requires
.Sy libtls ,
provided by either
.Lk https://git.causal.agency/libretls/about LibreTLS
(for OpenSSL)
or by LibreSSL.
It targets
.Fx .
.
.Bd -literal -offset indent
\&./configure
make all
sudo make install
.Ed
.
.Sh DEPLOYMENT
.Xr bubger 1
can be run either by
.Xr cron 8
or under a process supervisor
such as
.Lk https://git.causal.agency/catsit/about catsit .
The files required to serve the archive are
.Pa index.* message/ thread/ attachment/ .
.
.Pp
Under
.Xr cron 8 ,
the exit status of
.Xr bubger 1
with the
.Fl q
flag can be used
to determine if
the archive was updated.
Under a process supervisor
with the
.Fl i
flag,
writes to
.Pa UIDNEXT
indicate when the archive is updated.
.
.Sh FILES
.Bl -tag -width "getservinfo.c" -compact
.It Pa archive.h
data structures and inline functions
.It Pa archive.c
main control flow
.It Pa imap.h
IMAP data structures
.It Pa imap.c
IMAP parsing
.It Pa parse.c
message structure parsing
.It Pa decode.c
content transfer decoding
.It Pa template.c
string templating and escaping
.It Pa atom.c
Atom feed generation
.It Pa html.c
HTML generation
.It Pa mbox.c
mbox generation
.It Pa export.c
message export
.It Pa concat.c
thread concatenation
.It Pa getservinfo.c
SRV record lookup
.It Pa stylesheet.c
default stylesheet
.El
.
.Sh CONTRIBUTING
The upstream URL of this project is
.Aq Lk https://git.causal.agency/bubger .
Contributions in any form can be sent to
.Aq Mt list+bubger@causal.agency .
For sending patches by email, see
.Aq Lk https://git-send-email.io .
.
.Pp
Monetary contributions can be
.Lk https://liberapay.com/june/donate "donated via Liberapay" .
.
.Sh SEE ALSO
.Xr bubger 1