summary refs log tree commit diff
path: root/README.7
blob: 95d9715325e14cabc807fd4f8e3827e5da71681c (plain) (blame)
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
.Dd December  9, 2020
.Dt README 7
.Os "Causal Agency"
.
.Sh NAME
.Nm bubger kirg
.Nd have it in a way
.
.Sh DESCRIPTION
.Xr bubger 1
is a static file HTML/Atom/mboxrd
archive generator
for IMAP mailboxes.
.
.Pp
An example of its output can be seen at
.Aq Lk https://causal.agency/list/ .
.
.Sh INSTALLING
.Nm bubger
targets
.Fx
and requires LibreSSL
.Pq Fl ltls .
.
.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 .
.
.Sh SEE ALSO
.Xr bubger 1