History

Valentin Lorentz fec6959acb all plugins: regenerate READMEs		2021-04-22 00:29:15 +02:00
..
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
README.rst	all plugins: regenerate READMEs	2021-04-22 00:29:15 +02:00
__init__.py	Use importlib instead of imp.	2020-01-26 12:00:08 +01:00
config.py	Fix neutral pronouns.	2014-04-11 21:56:42 +00:00
messages.pot	PluginDownloader: update l10n-fi.	2014-03-22 16:38:16 +02:00
plugin.py	Plugin: Only show the first paragraph; as the whole help can be very long.	2021-04-05 17:42:40 +02:00
test.py	All plugins: set Limnoria contributors as maintainer	2019-11-16 11:41:13 -08:00

README.rst

Documentation for the Plugin plugin for Supybot

Purpose

This plugin handles various plugin-related things, such as getting help for a plugin or retrieving author info.

Usage

This plugin exists to help users manage their plugins. Use 'plugin list' to list the loaded plugins; use 'plugin help' to get the description of a plugin; use the 'plugin' command itself to determine what plugin a command exists in.

Commands

author <plugin>: Returns the author of <plugin>. This is the person you should talk to if you have ideas, suggestions, or other comments about a given plugin.

contributors <plugin> [<name>]: Replies with a list of people who made contributions to a given plugin. If <name> is specified, that person's specific contributions will be listed. You can specify a person's name by their full name or their nick, which is shown inside brackets if available.

help <plugin>: Returns a useful description of how to use <plugin>, if the plugin has one.

plugin <command>: Returns the name of the plugin that would be used to call <command>. If it is not uniquely determined, returns list of all plugins that contain <command>.

plugins <command>: Returns the names of all plugins that contain <command>.

Configuration

supybot.plugins.Plugin.public

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

Determines whether this plugin is publicly visible.