.Dd May 19, 2021
.Dt SCOOPER 1
.Os
.
.Sh NAME
.Nm scooper
.Nd litterbox web interface
.
.Sh SYNOPSIS
.Nm
.Op Fl hp
.Op Fl g Ar gap
.Op Fl l Ar limit
.Op Fl o Ar overlap
.Op Fl r Ar recent
.Op Fl s Ar url
.Ar database
.
.Nm
.Fl c
.Ar database
.
.Sh DESCRIPTION
The
.Nm
daemon
provides a CGI or FastCGI
web interface for the
.Xr litterbox 1
IRC log database.
To use FastCGI,
run
.Nm
under
.Xr kfcgi 8 .
.
.Pp
Adding the
.Cm export
query parameter
to any page
produces a standalone HTML document.
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl c
Check SQL statements against the given
.Ar database
and exit.
.
.It Fl g Ar gap
Set the time in seconds between events
after which to indicate a gap.
The default is 3600 (one hour).
.
.It Fl h
Hide user hostnames.
.
.It Fl l Ar limit
Limit the number of events
to be displayed on one page.
The default limit is 50.
.
.It Fl o Ar overlap
Set the overlap in seconds
between pages of events.
The default is 30.
.
.It Fl p
Show only public contexts,
i.e. channels.
.
.It Fl r Ar recent
Limit the number of recent events
used to determine active networks and contexts.
The default limit is 500.
.
.It Fl s Ar url
Include the stylesheet
.Ar url
rather than the default.
.
.It Ar database
The path to the
.Xr litterbox 1
database.
.El
.
.Sh ENVIRONMENT
In addition to the standard CGI environment variables,
.Nm
reads the following:
.Pp
.Bl -tag -width "SCOOPER_STYLESHEET" -compact
.It Ev SCOOPER_DATABASE
The path to the
.Xr litterbox 1
database.
.It Ev SCOOPER_GAP
Equivalent to
.Fl g .
.It Ev SCOOPER_HIDE_HOST
Equivalent to
.Fl h .
.It Ev SCOOPER_LIMIT
Equivalent to
.Fl l .
.It Ev SCOOPER_OVERLAP
Equivalent to
.Fl o .
.It Ev SCOOPER_PUBLIC
Equivalent to
.Fl p .
.It Ev SCOOPER_RECENT
Equivalent to
.Fl r .
.It Ev SCOOPER_STYLESHEET
Equivalent to
.Fl s .
.El
.
.Sh SEE ALSO
.Xr kfcgi 8 ,
.Xr litterbox 1
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt list+scooper@causal.agency
or join
.Li #ascii.town
on
.Li irc.tilde.chat .