aboutsummaryrefslogtreecommitdiff
README(7) FreeBSD Miscellaneous Information Manual README(7)

litterbox
IRC logger

litterbox(1) 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 pounce, but can also be used independently as a logging bot.

litterbox provides the scoop(1) command-line query utility. A web interface for litterbox is provided by scooper.

litterbox requires SQLite3 and libtls, provided by either LibreTLS (for OpenSSL) or by LibreSSL. It targets FreeBSD, OpenBSD and Linux.
./configure
make all
sudo make install

If installing libtls manually to /usr/local, for example, make sure /usr/local/lib appears in /etc/ld.so.conf or /etc/ld.so.conf.d/* and be sure to run ldconfig(8) once the library is installed. Set PKG_CONFIG_PATH for ./configure to find it.

PKG_CONFIG_PATH=/usr/local/lib/pkgconfig ./configure

On FreeBSD and OpenBSD the recommended way to run litterbox is with the process supervisor catsit.

database.h
database functions and schema
litterbox.c
IRC logging
scoop.c
query building and output formatting
unscoop.c
log file processing
config.c
getopt_long(3)-integrated configuration parsing
xdg.c
XDG base directories

The upstream URL of this project is ⟨https://git.causal.agency/litterbox⟩. Contributions in any form can be sent to <list+litterbox@causal.agency>. For sending patches by email, see ⟨https://git-send-email.io⟩.

litterbox(1), scoop(1), unscoop(1)
August 27, 2020 Causal Agency