Limnoria-doc/use/plugins/ctcp.rst


.. _plugin-ctcp:

The Ctcp plugin
===============

Command
-------

.. _command-ctcp-version:

ctcp 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.


.. _plugin-ctcp-config:

Configuration
-------------

.. _supybot.plugins.Ctcp.public:

supybot.plugins.Ctcp.public
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: True

Determines whether this plugin is publicly visible.

.. _supybot.plugins.Ctcp.versionWait:

supybot.plugins.Ctcp.versionWait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Default value: 10

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.
Generate all plugin docs. 2011-06-28 08:11:32 +02:00
			`.. _plugin-ctcp:`

			`The Ctcp plugin`
			`===============`

Fix hierarchy (and compilation warnings) for many plugins. 2011-10-29 13:19:46 +02:00			`Command`
			`-------`

Review and update the layout. 2011-06-28 17:29:38 +02:00			`.. _command-ctcp-version:`
Generate all plugin docs. 2011-06-28 08:11:32 +02:00
Review and update the layout. 2011-06-28 17:29:38 +02:00			`ctcp version [<channel>] [--nicks]`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
Generate all plugin docs. 2011-06-28 08:11:32 +02:00
			`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.`

Massive import of all generated configuration doc. 2011-10-28 22:49:04 +02:00

			`.. _plugin-ctcp-config:`

			`Configuration`
			`-------------`

			`.. _supybot.plugins.Ctcp.public:`

			`supybot.plugins.Ctcp.public`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^`

			`Default value: True`

			`Determines whether this plugin is publicly visible.`

			`.. _supybot.plugins.Ctcp.versionWait:`

			`supybot.plugins.Ctcp.versionWait`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`

			`Default value: 10`

			`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.`