summary refs log tree commit diff
path: root/README.7
blob: 3778c2bcb0036f6efc572fce0d8b2b81f46a308e (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
.Dd January 11, 2020
.Dt README 7
.Os "Causal Agency"
.
.Sh NAME
.Nm litterbox
.Nd IRC logger
.
.Sh DESCRIPTION
.Nm
is a TLS-only IRC logger.
It logs events from IRC in a SQLite database,
indexing messages for full-text search.
It is intended for use with
the IRC bouncer
.Xr pounce 1 ,
but can also be used independently
as a logging bot.
.
.Pp
.Nm
requires LibreSSL
.Pq Fl ltls
and SQLite
.Pq Fl lsqlite3 ,
and targets
.Fx .
It can also be built on Darwin.
.
.Sh FILES
.Bl -tag -width "litterbox.c" -compact
.It Pa database.h
database functions and schema
.It Pa litterbox.c
IRC logging
.It Pa scoop.c
query building and output formatting
.It Pa unscoop.c
log file processing
.It Pa config.c
.Xr getopt_long 3 Ns -integrated
configuration parsing
.It Pa rc.d/
.Fx
.Xr rc 8
scripts
.El
.
.Sh CONTRIBUTING
The upstream URL of this project is
.Aq Lk https://git.causal.agency/litterbox .
I'm happy to receive contributions in any form at
.Aq Mt june@causal.agency .
For sending patches by email, see
.Aq Lk https://git-send-email.io .
.
.Sh SEE ALSO
.Xr litterbox 1 ,
.Xr scoop 1 ,
.Xr unscoop 1
.
.Pp
.Lk https://git.causal.agency/pounce "pounce"