IRCCD(1) - General Commands Manual
irccd - IRC Client Daemon
irccd [-c file] [-v]
The irccd program is an IRC bot which connects to one or more severs and dispatches events to plugins and connected clients.
The following options are available:
specify the configuration file.
When ran without arguments, irccd will read your configuration file and dispatch IRC events to the plugins and connected clients indefinitely.
Otherwise, the following commands are available:
Show in a scriptable manner the options that were selected during irccd’s build.
Get the irccd version. if Mercurial was available when building irccd then the current revision is bundled in the output.
The following IRC events are supported:
This is a special event that does not exist in IRC context. It calls the plugin special invocation command using !name arguments… syntax. The exclamation mark is configured by default to be the command character prefix, then if the adjacent name is known to be a loaded plugin it is invoked with the additional arguments.
Example: to call the hangman plugin, one may use !hangman to start a game.
See also irccd.conf(5) on how to change the command character prefix under a [server] section.
When a server successfully connects to an IRC server.
When a server disconnected from an IRC server both in case of failures or explicit user disconnection.
Event called when the bot itself has been invited to a channel.
When someone joins a channel.
When someone has been kicked from a channel, irccd may be included.
This is a special event that does not exist in IRC context. It is invoked when the plugin is initialized.
Upon private message.
On action emote, also most known as /me command.
When a user or channel mode change.
When a list of nicknames has been received.
On nick change, irccd may be included.
On private notice.
When someone leaves a channel.
This is a special event that does not exist in IRC context. It is invoked when the user asks to reload a plugin.
When a channel topic has been changed.
This is a special event that does not exist in IRC context. It is invoked when the user asks to unload a plugin and before exiting.
When a whois information has been received.
The following plugins are provided with irccd:
See additional documentation in their own manual page in the form irccd-plugin-name(7) where name is the actual plugin name.
Hooks are a different and more lightweight approach to plugins, they are executed upon incoming events and spawned each time a new event arrives.
In contrast to plugins, differences are:
Each hook will receive as positional argument the event name (similar to plugin events) and the event arguments.
An example of hook in shell script is available as @CMAKE_INSTALL_FULL_DOCDIR@/examples/sample-hook.sh file.
See also the section [hooks] in irccd.conf(5) manual page to enable hooks.
The daemon can be controlled at runtime using the dedicated irccdctl tool or using sockets.
Both TCP/IP and UNIX sockets are supported and SSL layer may be enabled over it for a secure connection. If authentication is desired, it can be enabled too.
See also the [transport] section in the irccd.conf(5) manual page.
irccd supports a feature called rules which allows you to define a fine-grained set of rules allowed for specific plugins. For instance, you may want to disable some IRC events for some plugins depending on your set of parameters. This is useful for plugins that generates huge traffic.
Rule events are matched using the same name as plugin events described in the section above. For example, to disable a private message event you must use the onCommand value.
See also the [rule] section in the irccd.conf(5) manual page.
irccd uses different types of paths depending on the context.
Paths prefixed by (W) means they are only used on Windows, others prefixed by (U) means they are used on UNIX systems.
The following directories are searched in the specified order for configuration files. For example, the files irccd.conf and irccdctl.conf will be searched there.
irccd-api(7), irccd-templates(7), irccd-ipc(7), irccd-plugin-ask(7), irccd-plugin-auth(7), irccd-plugin-hangman(7), irccd-plugin-history(7), irccd-plugin-joke(7), irccd-plugin-links(7), irccd-plugin-logger(7), irccd-plugin-plugin(7), irccd-plugin-roulette(7), irccd-plugin-tictactoe(7), irccd-test(1), irccd.conf(5), irccdctl(1), irccdctl.conf(5)
macOS 11.2 - @IRCCD_MAN_DATE@