.Dd December 30, 2019
.Dt LITTERBOX 1
.Os
.
.Sh NAME
.Nm litterbox
.Nd IRC logger
.
.Sh SYNOPSIS
.Nm
.Op Fl Qqv
.Op Fl d Ar path
.Op Fl h Ar host
.Op Fl j Ar join
.Op Fl l Ar limit
.Op Fl n Ar nick
.Op Fl p Ar port
.Op Fl u Ar user
.Op Fl w Ar pass
.
.Nm
.Fl i | m
.Op Fl d Ar path
.
.Sh DESCRIPTION
The
.Nm
daemon logs IRC activity to a database
which may be queried with
.Xr scoop 1 .
.
.Pp
The arguments are as follows:
.
.Bl -tag -width "-h host"
.It Fl Q
Enable public search query interface.
This allows anyone to perform searches
in private messages to
.Nm .
Search results are limited
to channels on the current network.
.
.Pp
The searchable columns are
.Li channel ,
.Li nick ,
.Li user ,
.Li target ,
.Li message .
For search query syntax, see
.Lk https://www.sqlite.org/fts5.html#full_text_query_syntax
.
.It Fl d Ar path
Set the path to the database file.
The database must be initialized with
.Fl i .
See
.Sx FILES
for the default path.
.
.It Fl h Ar host
Connect to
.Ar host .
.
.It Fl i
Initialize the database.
.
.It Fl j Ar join
Join the comma-separated list of channels
.Ar join .
.
.It Fl l Ar limit
Limit the number of results sent by the
.Fl Q
or
.Fl q
search query interface.
The default limit is 10.
.
.It Fl m
Migrate the database to the latest version.
.
.It Fl n Ar nick
Set the nickname to
.Ar nick .
The default nickname is
.Dq litterbox .
.
.It Fl p Ar port
Connect to
.Ar port .
The default port is 6697.
.
.It Fl q
Enable private search query interface.
This allows search queries in private messages to
.Nm
from itself,
which is likely only useful when connected to
.Xr pounce 1 .
Search results are limited to the current network.
.
.Pp
The searchable columns are
.Li channel ,
.Li query ,
.Li nick ,
.Li user ,
.Li target ,
.Li message .
For search query syntax, see
.Lk https://www.sqlite.org/fts5.html#full_text_query_syntax
.
.It Fl u Ar user
Set the username to
.Ar user .
The default username is the same as the nickname.
.
.It Fl v
Write sent and received IRC messages
as well as SQL INSERT statements
to standard error.
.
.It Fl w Ar pass
Log in with the server password
.Ar pass .
.El
.
.Sh FILES
.Bl -tag -width Ds
.It Pa $XDG_DATA_DIRS/litterbox/litterbox.sqlite
The database file is searched for first in
.Ev $XDG_DATA_HOME ,
usually
.Pa ~/.local/share ,
followed by the colon-separated list of paths
.Ev $XDG_DATA_DIRS ,
usually
.Pa /usr/local/share:/usr/share .
.It Pa ~/.local/share/litterbox/litterbox.sqlite
The most likely path to the database file.
.El
.
.Sh SEE ALSO
.Xr scoop 1 ,
.Xr unscoop 1
.
.Sh STANDARDS
The
.Nm
daemon implements the following:
.
.Bl -item
.It
.Rs
.%A Waldo Bastian
.%A Ryan Lortie
.%A Lennart Poettering
.%T XDG Base Directory Specification
.%D November 24, 2010
.%U https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
.Re
.
.It
.Rs
.%A Kyle Fuller
.%A St\('ephan Kochen
.%A Alexey Sokolov
.%A James Wheare
.%T IRCv3.2 server-time Extension
.%I IRCv3 Working Group
.%U https://ircv3.net/specs/extensions/server-time-3.2
.Re
.
.It
.Rs
.%A C. Kalt
.%T Internet Relay Chat: Client Protocol
.%I IETF
.%N RFC 2812
.%D April 2000
.%U https://tools.ietf.org/html/rfc2812
.Re
.El
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt june@causal.agency
or join
.Li #ascii.town
on
.Li chat.freenode.net .