about summary refs log tree commit diff
diff options
context:
space:
mode:
-rw-r--r--scooper.169
1 files changed, 69 insertions, 0 deletions
diff --git a/scooper.1 b/scooper.1
new file mode 100644
index 0000000..1e72631
--- /dev/null
+++ b/scooper.1
@@ -0,0 +1,69 @@
+.Dd July  9, 2020
+.Dt SCOOPER 1
+.Os
+.
+.Sh NAME
+.Nm scooper
+.Nd web interface for litterbox
+.
+.Sh SYNOPSIS
+.Nm
+.Op Fl fp
+.Op Fl s Ar url
+.Ar database
+.
+.Sh DESCRIPTION
+.Nm
+is a CGI and FastCGI
+web interface to the
+.Xr litterbox 1
+IRC log database.
+.
+.Pp
+The arguments are as follows:
+.Bl -tag -width Ds
+.It Fl f
+Become a FastCGI worker,
+which can be managed by
+.Xr kfcgi 8 .
+.It Fl p
+Only show public contexts,
+i.e. channels.
+.It Fl s Ar url
+Use the stylesheet
+.Ar url .
+.It Ar database
+The path to the
+.Xr litterbox 1
+database.
+.El
+.
+.Ss Pages
+.Bl -tag -width Ds
+.It Pa /networks
+Lists the networks in the database.
+.It Pa /contexts?network=network
+Lists the contexts in the given network.
+.It Pa /events?network=network&context=context&after=time
+Shows events from the given context
+starting from
+.Ar time .
+.It Pa /search?network=network&context=context&query=query
+Shows events from the optional context which match
+.Ar query .
+.El
+.
+.Sh SEE ALSO
+.Xr litterbox 1 ,
+.Xr scoop 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 chat.freenode.net .