diff options
| -rw-r--r-- | README.7 | 67 |
1 files changed, 57 insertions, 10 deletions
diff --git a/README.7 b/README.7 index 95d9715..cd6ac64 100644 --- a/README.7 +++ b/README.7 @@ -1,4 +1,4 @@ -.Dd December 9, 2020 +.Dd March 2, 2021 .Dt README 7 .Os "Causal Agency" . @@ -8,20 +8,63 @@ . .Sh DESCRIPTION .Xr bubger 1 -is a static file HTML/Atom/mboxrd -archive generator -for IMAP mailboxes. +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 -.Aq Lk https://causal.agency/list/ . +An example of its output +can be seen at +.Lk https://causal.agency/list/ . . .Sh INSTALLING .Nm bubger -targets -.Fx -and requires LibreSSL -.Pq Fl ltls . +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 @@ -63,5 +106,9 @@ Contributions in any form can be sent to 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 |