mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-26 12:43:09 +01:00
833af36b08
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.
33 lines
1.1 KiB
ReStructuredText
33 lines
1.1 KiB
ReStructuredText
.. _plugin-Protector:
|
|
|
|
Documentation for the Protector plugin for Supybot
|
|
==================================================
|
|
|
|
Purpose
|
|
-------
|
|
Defends a channel against actions by people who don't have the proper
|
|
capabilities, even if they have +o or +h.
|
|
|
|
Usage
|
|
-----
|
|
Prevents users from doing things they are not supposed to do on a channel,
|
|
even if they have +o or +h.
|
|
|
|
Configuration
|
|
-------------
|
|
supybot.plugins.Protector.enable
|
|
This config variable defaults to "False", is network-specific, and is channel-specific.
|
|
|
|
Determines whether this plugin is enabled in a given channel.
|
|
|
|
supybot.plugins.Protector.immune
|
|
This config variable defaults to " ", is network-specific, and is channel-specific.
|
|
|
|
Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list.
|
|
|
|
supybot.plugins.Protector.public
|
|
This config variable defaults to "True", is not network-specific, and is not channel-specific.
|
|
|
|
Determines whether this plugin is publicly visible.
|
|
|