Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices
This commit reverts db7ef3f02517f9f2a3c56829a22b9fad3c36e374
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f02517f9f2a3c56829a22b9fad3c36e374 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
2021-10-17 09:57:55 +02:00
..
2020-03-26 22:10:28 +01:00
2014-03-22 16:38:16 +02:00
2021-04-22 00:29:15 +02:00

.. _plugin-Ctcp:

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-Ctcp:

Commands
--------
.. _command-ctcp-version:

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.

.. _conf-Ctcp:

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

.. _conf-supybot.plugins.Ctcp.public:


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.

.. _conf-supybot.plugins.Ctcp.userinfo:


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.

.. _conf-supybot.plugins.Ctcp.versionWait:


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.