NAME¶

willie - A highly customizable Internet Relay Chat bot

SYNOPSIS¶

willie [-q|--quit] [-k|--kill] [-d|--fork] [--quiet] [-c filename |--config= filename]
willie [-h|--help]
willie [-m|--migrate]
willie [-w|--configure-all] [--configure-modules] [--configure-database]

DESCRIPTION¶

willie runs a bot that provides some useful (and some useless) commands in one or more Internet Relay Chat channels. It reads configuration options, such as the network to connect to, channels to join, and more from a config file specified by the -c option. If no config file is specified, ~/.willie/default.cfg is used. If the configuration file being used does not exist, a brief configuration wizard will be run to set up the basic options, and optionally set up a database for user data and any modules that may need configuration.

In most cases, simply running willie will be sufficient; the bot will start after initial configuration, and will run until it is told to quit through IRC.

OPTIONS¶

-h or --help

Show a brief summary of these options.

-c

filename or --config= filename
Run Willie with the configuration options from the specified file. An absolute pathname can be given, or the name of a file within the configuration directory may also be given. ~/.willie is the preferred location, but this and -c will also look in ~/.jenni and ~/.phenny for legacy reasons. When the suffix of the file is .cfg , it may be omitted.

-d or --fork

Run Willie in the background. The bot will safely run in the background, and can later be killed with -q or -d

-q or --quit

Gracefully quit a daemonized instance of Willie. This option determines the instance to quit by the name of the config file given by the -c option, if used, so the same argument must be given with -c when using -q.

-k or --kill

Terminates a daemonized instance of Willie. This option determines the instance to kill by the name of the config file given by the -c option, if used, so the same argument must be given with -c when using -k.

-l or --list

List all config files found in the usual configuration file directories: ~/.willie ~/.jenni and ~/.phenny

-m or --migrate

Attempt to migrate a configuration file for an older version of the bot to the new format. Versions prior to 3.1 used a configuration file written in Python, which can be converted with this tool.

--quiet

Suppress all output from the bot to the terminal.

-w or --configure-all

Run the initial configuration wizard. This can be run with -c to configure a specified file, or without it to work on the default file.

--configure-modules

Check for modules with configuration options, and allow the user to modify those options. Changes will be added to the default file, or the file given to -c if used.

--configure-database

Run a wizard for configuring the user information database options. Changes will be added to the default file, or the file given to -c if used.