path: root/scoop.1

.Dd May 20, 2020
.Dt SCOOP 1
.Os
.
.Sh NAME
.Nm scoop
.Nd query IRC logs
.
.Sh SYNOPSIS
.Nm
.Op Fl Lgpqv
.Op Fl D Ar date
.Op Fl F Ar format
.Op Fl N Ar network
.Op Fl T Ar target
.Op Fl a Ar time
.Op Fl b Ar time
.Op Fl c Ar context
.Op Fl d Ar path
.Op Fl f Ar format
.Op Fl h Ar host
.Op Fl l Ar limit
.Op Fl m Ar regexp
.Op Fl n Ar nick
.Op Fl t Ar type
.Op Fl u Ar user
.Op Fl w Ar expr
.Op Ar search
.Nm
.Fl s
.
.Sh DESCRIPTION
The
.Nm
utility queries the
.Xr litterbox 1
IRC log database,
matching events on the intersection
of the criteria specified in arguments.
With no arguments,
all events in the database are matched.
Events are output in order
from oldest to newest.
.
.Pp
If standard output is a terminal,
colored output is piped to
.Ev PAGER
with
.Ev LESS=FRX
if it is not already set.
.
.Pp
The arguments are as follows:
.Bl -tag -width Ds
.It Fl D Ar date
Match events which occurred on
.Ar date ,
of the format
.Ar YYYY-MM-DD
or the keyword
.Cm now .
.
.It Fl F Ar format
Format timestamps using the
.Ar format
string,
similar to
.Xr strftime 3 ,
see
.Aq Lk https://www.sqlite.org/lang_datefunc.html .
The default format is ISO 8601.
.
.It Fl L
Output timestamps in local time.
.
.It Fl N Ar network
Match events from
.Ar network .
.
.It Fl T Ar target
Match events
.Po
of type
.Cm kick
or
.Cm nick
.Pc
with the target nickname
.Ar target .
.
.It Fl a Ar time
Match events which occurred after
.Ar time ,
of the format
.Ar YYYY-MM-DD HH:MM:SS .
.
.It Fl b Ar time
Match events which occurred before
.Ar time ,
of the format
.Ar YYYY-MM-DD HH:MM:SS .
.
.It Fl c Ar context
Match events from
.Ar context ,
either a channel or query name.
.
.It Fl d Ar path
Set the database path.
The default path is as in
.Xr litterbox 1 .
.
.It Fl f Ar format
Set the output format to one of
.Cm plain ,
.Cm color ,
.Cm irc .
The
.Cm irc
format outputs events
as IRC protocol with
.Sy server-time
tags.
The default format is
.Cm color
if standard output is a terminal,
.Cm plain
otherwise.
.
.It Fl g
Group events by network and channel or query name.
.
.It Fl h Ar host
Match events from users with the hostname
.Ar host .
.
.It Fl l Ar limit
Limit the number of events matched,
ordered by most recent.
.
.It Fl m Ar regexp
Match events with messages
matching the modern regular expression
.Ar regexp .
See
.Xr re_format 7 .
.
.It Fl n Ar nick
Match events from users with the nickname
.Ar nick .
.
.It Fl p
Match only events from channels.
.
.It Fl q
Match only events from queries.
.
.It Fl s
Instead of performing a query,
launch the
.Xr sqlite3 1
shell for the database.
.
.It Fl t Ar type
Match events of
.Ar type .
The types are
.Cm privmsg ,
.Cm notice ,
.Cm action ,
.Cm join ,
.Cm part ,
.Cm quit ,
.Cm kick ,
.Cm nick ,
.Cm topic .
.
.It Fl u Ar user
Match events from users with the username
.Ar user .
.
.It Fl v
Print the expanded SQL query being used to standard error.
.
.It Fl w Ar expr
Add the SQL expression
.Ar expr
to the
.Sy WHERE
clause of the query.
This option can only be used once.
.
.It Ar search
Match events using full-text search.
The searchable columns are
.Li network ,
.Li channel ,
.Li query ,
.Li nick ,
.Li user ,
.Li target ,
.Li message .
For search query syntax, see
.Aq Lk https://www.sqlite.org/fts5.html#full_text_query_syntax .
.El
.
.Sh ENVIRONMENT
.Bl -tag -width Ds
.It Ev PAGER
The command to pipe terminal output to.
The default is
.Ev PAGER=less .
.El
.
.Sh SEE ALSO
.Xr litterbox 1
.
.Sh AUTHORS
.An June Bug Aq Mt june@causal.agency
.
.Sh BUGS
Send mail to
.Aq Mt list+litterbox@causal.agency
or join
.Li #ascii.town
on
.Li chat.freenode.net .