DESCRIPTION

The litterbox daemon may be connected to the pounce(1) IRC bouncer alongside regular clients to provide central logging and a simple search query interface with -q.

The database must be initialized with -i. If the database format has changed, it will be migrated automatically when litterbox starts, or can be migrated explicitly with -m. Live backups of the database can be made with -b. Instances of litterbox connected to different IRC networks will share the same database.

Options can be loaded from files listed on the command line. Files are searched for in $XDG_CONFIG_DIRS/litterbox unless the path starts with ‘/’, ‘./’ or ‘../’. Each option is placed on a line, and lines beginning with ‘#’ are ignored. The options are listed below following their corresponding flags.

The arguments are as follows:

-N name | network = name

Set the network name to be used if the server does not send RPL_ISUPPORT NETWORK. The default is the server hostname.

-Q | public-query

Enable the public search query interface. This allows anyone to perform searches in private messages to litterbox. Search results are limited to channels on the current network.

Searches use the full-text search index. The searchable columns are channel, nick, user, target, message.

-U url | scooper-url = url

Set the base URL of a scooper(1) instance used to construct links to full search results in response to the search query interface enabled by -Q or -q.

-b path

Perform a live database backup to path and exit. This operation requires SQLite version 3.27.0 or newer.

-c path | cert = path

Load the TLS client certificate from path and authenticate with SASL EXTERNAL, also known as CertFP. The path is searched for in the same manner as configuration files. If the private key is in a separate file, it is loaded with -k.

-d path | database = path

Set the path to the database file. See FILES for the default paths.

-h host | host = host

Connect to host.

-i

Initialize the database and exit.

-j chan | join = chan

Join the comma-separated list of channels chan.

-k path | priv = path

Load the TLS client private key from path. The path is searched for in the same manner as configuration files.

-l limit | limit = limit

Limit the number of results in the search query interface enabled by -Q or -q. The default limit is 10.

-m

Migrate the database to the latest format and exit.

-n nick | nick = nick

Set the nickname to nick. The default nickname is “litterbox”.

-p port | port = port

Connect to port. The default port is 6697.

-q | private-query

Enable the private search query interface. When connected to pounce(1), this allows the user to private message their own nickname with search queries. Search results are limited to the current network.

Searches use the full-text search index. The searchable columns are channel, query, nick, user, target, message.

-t path | trust = path

Trust the self-signed certificate loaded from path and disable server name verification. The path is searched for in the same manner as configuration files.

-u user | user = user

Set the username to user. The default username is the same as the nickname.

-v | verbose

Write sent and received IRC messages as well as SQL INSERT statements to standard error.

-w pass | pass = pass

Log in with the server password pass.

litterbox -Q -h irc.example.org -j '#example'

host = irc.example.org
join = #example
public-query