UNSCOOP(1)                  General Commands Manual                 UNSCOOP(1)

NAME
     unscoop – import IRC logs

SYNOPSIS
     unscoop [-v] [-N network] [-c context] [-d path] [-f format] file ...
     unscoop -D [-d path]

DESCRIPTION
     The unscoop utility imports plain text IRC logs into the litterbox(1)
     database.  Network and channel or query names can be inferred from file
     paths, so unscoop should be run from the log directory root.

     The current path being imported is printed to standard output.  Progress
     based on total file size is printed to standard error.

     The arguments are as follows:

     -D      Delete duplicate events from overlapping imports and exit.  This
             operation requires SQLite version 3.25.0 or newer.

     -N network
             Override the network name of the imported logs.

     -c context
             Override the channel or query name of the imported logs.  Names
             beginning with ‘#’ or ‘&’ are assumed to be channels.

     -d path
             Set the database path, which must have been initialized by
             litterbox(1).  The default path is as in litterbox(1).

     -f format
             Set the input log format.  The default is generic.

     -v      Print SQL INSERT statements on standard error.

     The formats are as follows:

     catgirl
             Import logs from the catgirl(1) IRC client.

                   find ~/.local/share/catgirl/log \
                           -type f -name '*.log' -print0 |
                   xargs -0 unscoop -f catgirl

     generic
             Import logs using generic matchers.  Network and context names
             are inferred from paths of the form network/context/*.  Events of
             the following formats are matched:

                   [timestamp] <nick> privmsg
                   [timestamp] -nick- notice
                   [timestamp] * nick action

     irc     Import logs formatted as IRC protocol messages tagged with
             server-time.  The network and context must be set with -N and -c.

     textual
             Import logs from the Textual IRC client.

                   find Textual -type f -name '*.txt' \
                           -not -path '*/Console/*' -print0 |
                   xargs -0 unscoop -f textual

     weechat
             Import logs from the WeeChat IRC client.

                   find ~/.weechat/logs -type f -name 'irc.*.weechatlog' \
                           -not -name 'irc.server.*.weechatlog' -print0 |
                   xargs -0 unscoop -f weechat

             unscoop is not able to correctly infer network and context names
             for channel names containing dots.  Import these logs explicitly
             with -N and -c.

     znc     Import logs from the znc(1) log module.

                   find ~/.znc/moddata/log \
                           ~/.znc/users/*/moddata/log \
                           ~/.znc/users/*/networks/*/moddata/log \
                           -type f -name '*.log' \
                           -not -path '*/status/*' -print0 |
                   xargs -0 unscoop -f znc

SEE ALSO
     litterbox(1)

AUTHORS
     June McEnroe <june@causal.agency>

BUGS
     Send mail to <list+litterbox@causal.agency> or join #ascii.town on
     irc.tilde.chat.

Linux 6.10.6-artix1-1            May 18, 2021            Linux 6.10.6-artix1-1