about summary refs log tree commit diff
path: root/scooper.1
blob: acd8507f932e02aaae22b2cb01d6e3e2486f49f8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
.Dd July 12, 2020
.Dt SCOOPER 1
.Os
.
.Sh NAME
.Nm scooper
.Nd litterbox web interface
.
.Sh SYNOPSIS
.Nm
.Op Fl p
.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 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_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 chat.freenode.net .