diff options
Diffstat (limited to 'scooper.1')
| -rw-r--r-- | scooper.1 | 61 |
1 files changed, 35 insertions, 26 deletions
diff --git a/scooper.1 b/scooper.1 index 9350ad1..c05676b 100644 --- a/scooper.1 +++ b/scooper.1 @@ -1,21 +1,29 @@ -.Dd July 9, 2020 +.Dd July 10, 2020 .Dt SCOOPER 1 .Os . .Sh NAME .Nm scooper -.Nd web interface for litterbox +.Nd litterbox web interface . .Sh SYNOPSIS .Nm -.Op Fl cfp +.Op Fl fp +.Op Fl l Ar limit +.Op Fl r Ar recent .Op Fl s Ar url .Ar database . +.Nm +.Fl c +.Ar database +. .Sh DESCRIPTION +The .Nm -is a CGI and FastCGI -web interface to the +daemon +provides a CGI or FastCGI +web interface for the .Xr litterbox 1 IRC log database. . @@ -23,41 +31,42 @@ IRC log database. The arguments are as follows: .Bl -tag -width Ds .It Fl c -Exit after preparing statements. +Prepare all SQL statements against the given +.Ar database +and exit. +. .It Fl f Become a FastCGI worker, which can be managed by .Xr kfcgi 8 . +. +.It Fl l Ar limit +Limit the number of events +to be displayed on one page. +The default limit is 100. +. .It Fl p -Only show public contexts, +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 -Use the stylesheet -.Ar url . +Include the stylesheet +.Ar url +rather than the default. +. .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 +.Xr litterbox 1 . .Sh AUTHORS .An June Bug Aq Mt june@causal.agency |