Limnoria/plugins/Ctcp
Valentin Lorentz db7ef3f025 all: Add generic 'The Limnoria Contributors' to copyright notices.
No need to bother with details (that are all outdated / out of sync
anyway), just look up the git history.
2021-08-01 21:54:49 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
config.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
messages.pot PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00

Documentation for the Ctcp plugin for Supybot

Purpose

Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO, and FINGER.

Usage

Provides replies to common CTCPs (version, time, etc.), and a command to fetch version responses from channels.

Please note that the command ctcp version cannot receive any responses if the channel is mode +C or similar which prevents CTCP requests to channel.

Commands

version [<channel>] [--nicks]

Sends a CTCP VERSION to <channel>, returning the various version strings returned. It waits for 10 seconds before returning the versions received at that point. If --nicks is given, nicks are associated with the version strings; otherwise, only the version strings are given.

Configuration

supybot.plugins.Ctcp.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.

supybot.plugins.Ctcp.userinfo

This config variable defaults to "", is not network-specific, and is not channel-specific.

Determines what will be sent when a USERINFO query is received.

supybot.plugins.Ctcp.versionWait

This config variable defaults to "10", is not network-specific, and is not channel-specific.

Determines how many seconds the bot will wait after getting a version command (not a CTCP VERSION, but an actual call of the command in this plugin named "version") before replying with the results it has collected.