Limnoria/plugins/Ctcp/README.rst

.. _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
--------
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.
all plugins: auto-generate READMEs Starting with this commit, there should be no "original" text in READMEs. Instead, the entire text should be in docstrings, and READMEs should be automatically generated from these docstrings. Motivation: * The same help is available both via IRC and in the README (although the README can be more detailed, as only the first paragraph will be shown on IRC) * This will allow auto-generating plugin help on docs.limnoria.net using the same content as the README, as it's sourced from the docstrings Additionally, this converts all READMEs from Markdown to ReST, because the documentation already uses ReST, and other docstrings in the codebase are in ReST for this reason. 2021-04-05 17:29:49 +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`
			`--------`
			`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.`