Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

supybot-plugin-doc: Add missing newlines + regenerate all READMEs.

This commit is contained in:
Valentin Lorentz 2021-12-04 02:50:28 +01:00
parent ef0cd48bd1
commit 828fff9cc0
70 changed files with 216 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
plugins/Admin/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Admin plugin for Supybot
Purpose Purpose
------- -------
These are commands useful for administrating the bot; they all require their These are commands useful for administrating the bot; they all require their
caller to have the 'admin' capability. This plugin is loaded by default. caller to have the 'admin' capability. This plugin is loaded by default.
Usage Usage
----- -----
This plugin provides access to administrative commands, such as This plugin provides access to administrative commands, such as
adding capabilities, managing ignore lists, and joining channels. adding capabilities, managing ignore lists, and joining channels.
This is a core Supybot plugin that should not be removed! This is a core Supybot plugin that should not be removed!
@ -18,6 +20,7 @@ This is a core Supybot plugin that should not be removed!
Commands Commands
-------- --------
.. _command-admin-acmd: .. _command-admin-acmd:
acmd <command> [<arg> ...] acmd <command> [<arg> ...]

3
plugins/Aka/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Aka plugin for Supybot
Purpose Purpose
------- -------
This plugin allows the user to create various aliases (known as "Akas", since This plugin allows the user to create various aliases (known as "Akas", since
Alias is the name of another plugin Aka is based on) to other commands or Alias is the name of another plugin Aka is based on) to other commands or
combinations of other commands (via nested commands). combinations of other commands (via nested commands).
Usage Usage
----- -----
This plugin allows users to define aliases to commands and combinations This plugin allows users to define aliases to commands and combinations
of commands (via nesting). of commands (via nesting).
@ -76,6 +78,7 @@ reply with the same information, the result of those commands.
Commands Commands
-------- --------
.. _command-aka-add: .. _command-aka-add:
add [--channel <#channel>] <name> <command> add [--channel <#channel>] <name> <command>

3
plugins/Alias/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Alias plugin for Supybot
Purpose Purpose
------- -------
Allows aliases for other commands. NOTE THAT IT'S RECOMMENDED TO USE Aka Allows aliases for other commands. NOTE THAT IT'S RECOMMENDED TO USE Aka
PLUGIN INSTEAD! PLUGIN INSTEAD!
Usage Usage
----- -----
This plugin allows users to define aliases to commands and combinations This plugin allows users to define aliases to commands and combinations
of commands (via nesting). of commands (via nesting).
This plugin is only kept for backward compatibility, you should use the This plugin is only kept for backward compatibility, you should use the
@ -36,6 +38,7 @@ reply with the same information, the result of those commands.
Commands Commands
-------- --------
.. _command-alias-add: .. _command-alias-add:
add <name> <command> add <name> <command>

3
plugins/Anonymous/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Anonymous plugin for Supybot
Purpose Purpose
------- -------
Allows folks to talk through the bot anonymously. Allows folks to talk through the bot anonymously.
Usage Usage
----- -----
This plugin allows users to act through the bot anonymously. The 'do' This plugin allows users to act through the bot anonymously. The 'do'
command has the bot perform an anonymous action in a given channel, and command has the bot perform an anonymous action in a given channel, and
the 'say' command allows other people to speak through the bot. Since the 'say' command allows other people to speak through the bot. Since
@ -48,6 +50,7 @@ This
Commands Commands
-------- --------
.. _command-anonymous-do: .. _command-anonymous-do:
do <channel> <action> do <channel> <action>

2
plugins/AutoMode/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the AutoMode plugin for Supybot
Purpose Purpose
------- -------
Automatically ops, voices, or halfops, or bans people when they join a channel, Automatically ops, voices, or halfops, or bans people when they join a channel,
according to their capabilities. If you want your bot automatically op users according to their capabilities. If you want your bot automatically op users
when they join your channel, this is the plugin to load. when they join your channel, this is the plugin to load.
Usage Usage
----- -----
This plugin, when configured, allows the bot to automatically set modes This plugin, when configured, allows the bot to automatically set modes
on users when they join. on users when they join.

2
plugins/Autocomplete/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Autocomplete plugin for Supybot
Purpose Purpose
------- -------
Autocomplete: Provides command autocompletion for IRC clients that support it. Autocomplete: Provides command autocompletion for IRC clients that support it.
This plugin implements an early draft of the IRCv3 autocompletion client tags. This plugin implements an early draft of the IRCv3 autocompletion client tags.
@ -17,6 +18,7 @@ If you are interested in this feature, please contribute to
Usage Usage
----- -----
Provides command completion for IRC clients that support it. Provides command completion for IRC clients that support it.
.. _conf-Autocomplete: .. _conf-Autocomplete:

3
plugins/BadWords/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the BadWords plugin for Supybot
Purpose Purpose
------- -------
Filters bad words on outgoing messages from the bot, so the bot can't be made Filters bad words on outgoing messages from the bot, so the bot can't be made
to say bad words. to say bad words.
As an additional capability, it can (optionally) kick users who As an additional capability, it can (optionally) kick users who
@ -12,6 +13,7 @@ use such words from channels that have that capability enabled.
Usage Usage
----- -----
Maintains a list of words that the bot is not allowed to say. Maintains a list of words that the bot is not allowed to say.
Can also be used to kick people that say these words, if the bot Can also be used to kick people that say these words, if the bot
has op. has op.
@ -20,6 +22,7 @@ has op.
Commands Commands
-------- --------
.. _command-badwords-add: .. _command-badwords-add:
add <word> [<word> ...] add <word> [<word> ...]

3
plugins/Channel/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Channel plugin for Supybot
Purpose Purpose
------- -------
Basic channel management commands. Many of these commands require their caller Basic channel management commands. Many of these commands require their caller
to have the #channel,op capability. This plugin is loaded by default. to have the #channel,op capability. This plugin is loaded by default.
Usage Usage
----- -----
This plugin provides various commands for channel management, such This plugin provides various commands for channel management, such
as setting modes and channel-wide bans/ignores/capabilities. This is as setting modes and channel-wide bans/ignores/capabilities. This is
a core Supybot plugin that should not be removed! a core Supybot plugin that should not be removed!
@ -18,6 +20,7 @@ a core Supybot plugin that should not be removed!
Commands Commands
-------- --------
.. _command-channel-alert: .. _command-channel-alert:
alert [<channel>] <text> alert [<channel>] <text>

12
plugins/ChannelLogger/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the ChannelLogger plugin for Supybot
Purpose Purpose
------- -------
Logs each channel to its own individual logfile. Logs each channel to its own individual logfile.
Usage Usage
----- -----
This plugin allows the bot to log channel conversations to disk. This plugin allows the bot to log channel conversations to disk.
.. _conf-ChannelLogger: .. _conf-ChannelLogger:
@ -112,13 +114,21 @@ supybot.plugins.ChannelLogger.rotateLogs
Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the 'filenameTimestamp' configuration variable. Determines whether the bot will automatically rotate the logs for this channel. The bot will rotate logs when the timestamp for the log changes. The timestamp is set according to the 'filenameTimestamp' configuration variable.
.. _conf-supybot.plugins.ChannelLogger.showAway:
supybot.plugins.ChannelLogger.showAway
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether users going away and coming back should be logged. This is only supported on networks implementing the 'away-notify' IRCv3 capability.
.. _conf-supybot.plugins.ChannelLogger.showJoinParts: .. _conf-supybot.plugins.ChannelLogger.showJoinParts:
supybot.plugins.ChannelLogger.showJoinParts supybot.plugins.ChannelLogger.showJoinParts
This config variable defaults to "True", is network-specific, and is channel-specific. This config variable defaults to "True", is network-specific, and is channel-specific.
Determines wether joins and parts are logged Determines whether joins and parts are logged
.. _conf-supybot.plugins.ChannelLogger.stripFormatting: .. _conf-supybot.plugins.ChannelLogger.stripFormatting:

3
plugins/ChannelStats/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the ChannelStats plugin for Supybot
Purpose Purpose
------- -------
Silently listens to every message received on a channel and keeps statistics Silently listens to every message received on a channel and keeps statistics
concerning joins, parts, and various other commands in addition to tracking concerning joins, parts, and various other commands in addition to tracking
statistics about smileys, actions, characters, and words. statistics about smileys, actions, characters, and words.
Usage Usage
----- -----
This plugin keeps stats of the channel and returns them with This plugin keeps stats of the channel and returns them with
the command 'channelstats'. the command 'channelstats'.
@ -18,6 +20,7 @@ the command 'channelstats'.
Commands Commands
-------- --------
.. _command-channelstats-channelstats: .. _command-channelstats-channelstats:
channelstats [<channel>] channelstats [<channel>]

3
plugins/Conditional/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Conditional plugin for Supybot
Purpose Purpose
------- -------
Contains numerous conditional commands (such as 'if', 'and', and 'or'), Contains numerous conditional commands (such as 'if', 'and', and 'or'),
which can be used on their own or with another plugin. which can be used on their own or with another plugin.
Also provides logic operators for writing conditions. Also provides logic operators for writing conditions.
@ -13,6 +14,7 @@ Useful for bot scripting / nested commands.
Usage Usage
----- -----
This plugin provides logic operators and other commands that This plugin provides logic operators and other commands that
enable you to run commands only if a condition is true. Useful for nested enable you to run commands only if a condition is true. Useful for nested
commands and scripting. commands and scripting.
@ -21,6 +23,7 @@ commands and scripting.
Commands Commands
-------- --------
.. _command-conditional-cand: .. _command-conditional-cand:
cand <cond1> [<cond2> ... <condN>] cand <cond1> [<cond2> ... <condN>]

3
plugins/Config/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Config plugin for Supybot
Purpose Purpose
------- -------
Handles configuration of the bot while it is running. Handles configuration of the bot while it is running.
Usage Usage
----- -----
Provides access to the Supybot configuration. This is Provides access to the Supybot configuration. This is
a core Supybot plugin that should not be removed! a core Supybot plugin that should not be removed!
@ -16,6 +18,7 @@ a core Supybot plugin that should not be removed!
Commands Commands
-------- --------
.. _command-config-channel: .. _command-config-channel:
channel [<network>] [<channel>] <name> [<value>] channel [<network>] [<channel>] <name> [<value>]

3
plugins/Ctcp/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Ctcp plugin for Supybot
Purpose Purpose
------- -------
Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO, Handles standard CTCP responses to PING, TIME, SOURCE, VERSION, USERINFO,
and FINGER. and FINGER.
Usage Usage
----- -----
Provides replies to common CTCPs (version, time, etc.), and a command Provides replies to common CTCPs (version, time, etc.), and a command
to fetch version responses from channels. to fetch version responses from channels.
@ -20,6 +22,7 @@ mode +C or similar which prevents CTCP requests to channel.
Commands Commands
-------- --------
.. _command-ctcp-version: .. _command-ctcp-version:
version [<channel>] [--nicks] version [<channel>] [--nicks]

3
plugins/DDG/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the DDG plugin for Supybot
Purpose Purpose
------- -------
Searches for results on DuckDuckGo's web search. Searches for results on DuckDuckGo's web search.
Usage Usage
----- -----
Searches for results on DuckDuckGo. Searches for results on DuckDuckGo.
Example:: Example::
@ -20,6 +22,7 @@ Example::
Commands Commands
-------- --------
.. _command-ddg-search: .. _command-ddg-search:
search <text> search <text>

3
plugins/Debug/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Debug plugin for Supybot
Purpose Purpose
------- -------
This is for developers debugging their plugins; it provides an eval command This is for developers debugging their plugins; it provides an eval command
as well as some other useful commands. as well as some other useful commands.
It should not be loaded with a default installation. It should not be loaded with a default installation.
Usage Usage
----- -----
This plugin provides debugging abilities for Supybot. It This plugin provides debugging abilities for Supybot. It
should not be loaded with a default installation. should not be loaded with a default installation.
@ -18,6 +20,7 @@ should not be loaded with a default installation.
Commands Commands
-------- --------
.. _command-debug-channeldb: .. _command-debug-channeldb:
channeldb [<channel>] channeldb [<channel>]

3
plugins/Dict/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Dict plugin for Supybot
Purpose Purpose
------- -------
Commands that use the dictd protocol to define words. Commands that use the dictd protocol to define words.
In order to use this plugin you must have the following modules In order to use this plugin you must have the following modules
@ -14,6 +15,7 @@ installed:
Usage Usage
----- -----
This plugin provides a function to look up words from different This plugin provides a function to look up words from different
dictionaries. dictionaries.
@ -21,6 +23,7 @@ dictionaries.
Commands Commands
-------- --------
.. _command-dict-dict: .. _command-dict-dict:
dict [<dictionary>] <word> dict [<dictionary>] <word>

3
plugins/Dunno/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Dunno plugin for Supybot
Purpose Purpose
------- -------
The Dunno module is used to spice up the reply when given an invalid command The Dunno module is used to spice up the reply when given an invalid command
with random 'I dunno'-like responses. If you want something spicier than with random 'I dunno'-like responses. If you want something spicier than
'<x> is not a valid command'-like responses, use this plugin. '<x> is not a valid command'-like responses, use this plugin.
@ -12,6 +13,7 @@ Like Success does for the 'The operation succeeded.' reply.
Usage Usage
----- -----
This plugin was written initially to work with MoobotFactoids, the two This plugin was written initially to work with MoobotFactoids, the two
of them to provide a similar-to-moobot-and-blootbot interface for factoids. of them to provide a similar-to-moobot-and-blootbot interface for factoids.
Basically, it replaces the standard 'Error: <x> is not a valid command.' Basically, it replaces the standard 'Error: <x> is not a valid command.'
@ -24,6 +26,7 @@ responses.
Commands Commands
-------- --------
.. _command-dunno-add: .. _command-dunno-add:
add [<channel>] <text> add [<channel>] <text>

3
plugins/Factoids/README.rst
View File

@ -5,17 +5,20 @@ Documentation for the Factoids plugin for Supybot
Purpose Purpose
------- -------
Handles 'factoids,' little tidbits of information held in a database and Handles 'factoids,' little tidbits of information held in a database and
available on demand via several commands. available on demand via several commands.
Usage Usage
----- -----
Provides the ability to show Factoids. Provides the ability to show Factoids.
.. _commands-Factoids: .. _commands-Factoids:
Commands Commands
-------- --------
.. _command-factoids-alias: .. _command-factoids-alias:
alias [<channel>] <oldkey> <newkey> [<number>] alias [<channel>] <oldkey> <newkey> [<number>]

3
plugins/Fediverse/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Fediverse plugin for Supybot
Purpose Purpose
------- -------
Fetches information from ActivityPub servers. Fetches information from ActivityPub servers.
Usage Usage
----- -----
Fetches information from ActivityPub servers. Fetches information from ActivityPub servers.
Enabling Secure Fetch Enabling Secure Fetch
@ -37,6 +39,7 @@ a title like "Supybot web server index").
Commands Commands
-------- --------
.. _command-fediverse-featured: .. _command-fediverse-featured:
featured <@user@instance> featured <@user@instance>

3
plugins/Filter/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Filter plugin for Supybot
Purpose Purpose
------- -------
Provides numerous filters, and a command (outfilter) to set them as filters on Provides numerous filters, and a command (outfilter) to set them as filters on
the output of the bot. the output of the bot.
For instance, you could make everything the bot says be For instance, you could make everything the bot says be
@ -16,6 +17,7 @@ commands.
Usage Usage
----- -----
This plugin offers several commands which transform text in some way. This plugin offers several commands which transform text in some way.
It also provides the capability of using such commands to 'filter' the It also provides the capability of using such commands to 'filter' the
output of the bot -- for instance, you could make everything the bot says output of the bot -- for instance, you could make everything the bot says
@ -26,6 +28,7 @@ Not very useful, but definitely quite fun :)
Commands Commands
-------- --------
.. _command-filter-aol: .. _command-filter-aol:
aol <text> aol <text>

3
plugins/Format/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Format plugin for Supybot
Purpose Purpose
------- -------
Provides simple commands for formatting text on IRC (like bold), Provides simple commands for formatting text on IRC (like bold),
and to change the output of the bot for a particular command. and to change the output of the bot for a particular command.
See also the :ref:`Filter plugin <plugin-Filter>` to configure See also the :ref:`Filter plugin <plugin-Filter>` to configure
@ -12,6 +13,7 @@ the output format for all commands.
Usage Usage
----- -----
Provides some commands for formatting text, such as making text bold or Provides some commands for formatting text, such as making text bold or
capitalized. capitalized.
@ -19,6 +21,7 @@ capitalized.
Commands Commands
-------- --------
.. _command-format-bold: .. _command-format-bold:
bold <text> bold <text>

3
plugins/GPG/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the GPG plugin for Supybot
Purpose Purpose
------- -------
GPG: Provides authentication based on GPG keys. GPG: Provides authentication based on GPG keys.
Usage Usage
----- -----
Provides authentication based on GPG keys. Provides authentication based on GPG keys.
.. _commands-GPG: .. _commands-GPG:
Commands Commands
-------- --------
.. _command-gpg-key.add: .. _command-gpg-key.add:
key add <key id> <key server> key add <key id> <key server>

3
plugins/Games/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Games plugin for Supybot
Purpose Purpose
------- -------
This plugin provides some fun games like (Russian) roulette, 8ball, monologue This plugin provides some fun games like (Russian) roulette, 8ball, monologue
which tells you how many lines you have spoken without anyone interrupting which tells you how many lines you have spoken without anyone interrupting
you, coin and dice. you, coin and dice.
Usage Usage
----- -----
This plugin provides some small games like (Russian) roulette, This plugin provides some small games like (Russian) roulette,
eightball, monologue, coin and dice. eightball, monologue, coin and dice.
@ -18,6 +20,7 @@ eightball, monologue, coin and dice.
Commands Commands
-------- --------
.. _command-games-coin: .. _command-games-coin:
coin takes no arguments coin takes no arguments

3
plugins/Google/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Google plugin for Supybot
Purpose Purpose
------- -------
Accesses Google for various things. Accesses Google for various things.
Usage Usage
----- -----
This is a simple plugin to provide access to the Google services we This is a simple plugin to provide access to the Google services we
all know and love from our favorite IRC bot. all know and love from our favorite IRC bot.
@ -40,6 +42,7 @@ Check: `Supported language codes`_
Commands Commands
-------- --------
.. _command-google-cache: .. _command-google-cache:
cache <url> cache <url>

3
plugins/Hashes/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Hashes plugin for Supybot
Purpose Purpose
------- -------
Provides various hash- and encryption-related commands. Provides various hash- and encryption-related commands.
Usage Usage
----- -----
Provides hash or encryption related commands Provides hash or encryption related commands
.. _commands-Hashes: .. _commands-Hashes:
Commands Commands
-------- --------
.. _command-hashes-algorithms: .. _command-hashes-algorithms:
algorithms <takes no arguments> algorithms <takes no arguments>

3
plugins/Herald/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Herald plugin for Supybot
Purpose Purpose
------- -------
Greets users who join the channel with a recognized hostmask with a nice Greets users who join the channel with a recognized hostmask with a nice
little greeting. little greeting.
Usage Usage
----- -----
This plugin allows you to set welcome messages (heralds) to people who This plugin allows you to set welcome messages (heralds) to people who
are recognized by the bot when they join a channel. are recognized by the bot when they join a channel.
@ -17,6 +19,7 @@ are recognized by the bot when they join a channel.
Commands Commands
-------- --------
.. _command-herald-add: .. _command-herald-add:
add [<channel>] <user|nick> <msg> add [<channel>] <user|nick> <msg>

3
plugins/Internet/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Internet plugin for Supybot
Purpose Purpose
------- -------
This plugin provides commands to transform domains into IP addresses and IP addresses to domains. This plugin provides commands to transform domains into IP addresses and IP addresses to domains.
It can also search WHOIS information and return hexips. It can also search WHOIS information and return hexips.
Usage Usage
----- -----
Provides commands to query DNS, search WHOIS databases, Provides commands to query DNS, search WHOIS databases,
and convert IPs to hex. and convert IPs to hex.
@ -17,6 +19,7 @@ and convert IPs to hex.
Commands Commands
-------- --------
.. _command-internet-dns: .. _command-internet-dns:
dns <host|ip> dns <host|ip>

3
plugins/Karma/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Karma plugin for Supybot
Purpose Purpose
------- -------
Plugin for keeping track of Karma for users and things in a channel. Plugin for keeping track of Karma for users and things in a channel.
Usage Usage
----- -----
Provides a simple tracker for setting Karma (thing++, thing--). Provides a simple tracker for setting Karma (thing++, thing--).
If ``config plugins.karma.allowUnaddressedKarma`` is set to ``True`` If ``config plugins.karma.allowUnaddressedKarma`` is set to ``True``
(default since 2014.05.07), saying `boats++` will give 1 karma (default since 2014.05.07), saying `boats++` will give 1 karma
@ -28,6 +30,7 @@ you must address the bot with nick or prefix to add or subtract karma.
Commands Commands
-------- --------
.. _command-karma-clear: .. _command-karma-clear:
clear [<channel>] [<name>] clear [<channel>] [<name>]

3
plugins/Lart/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Lart plugin for Supybot
Purpose Purpose
------- -------
This plugin keeps a database of larts (Luser Attitude Readjustment Tool), This plugin keeps a database of larts (Luser Attitude Readjustment Tool),
and larts with it. and larts with it.
Usage Usage
----- -----
Provides an implementation of the Luser Attitude Readjustment Tool Provides an implementation of the Luser Attitude Readjustment Tool
for users. for users.
@ -23,6 +25,7 @@ Example:
Commands Commands
-------- --------
.. _command-lart-add: .. _command-lart-add:
add [<channel>] <text> add [<channel>] <text>

3
plugins/Later/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Later plugin for Supybot
Purpose Purpose
------- -------
Informal notes, mostly for compatibility with other bots. Based entirely on Informal notes, mostly for compatibility with other bots. Based entirely on
nicks, it's an easy way to tell users who refuse to register notes when they nicks, it's an easy way to tell users who refuse to register notes when they
arrive later. arrive later.
Usage Usage
----- -----
Used to do things later; currently, it only allows the sending of Used to do things later; currently, it only allows the sending of
nick-based notes. Do note (haha!) that these notes are *not* private nick-based notes. Do note (haha!) that these notes are *not* private
and don't even pretend to be; if you want such features, consider using the and don't even pretend to be; if you want such features, consider using the
@ -43,6 +45,7 @@ and the owner.
Commands Commands
-------- --------
.. _command-later-notes: .. _command-later-notes:
notes [<nick>] notes [<nick>]

2
plugins/Limiter/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Limiter plugin for Supybot
Purpose Purpose
------- -------
This plugin sets channel limits (MODE +l) based on This plugin sets channel limits (MODE +l) based on
``plugins.Limiter.MaximumExcess`` plus the current number of users ``plugins.Limiter.MaximumExcess`` plus the current number of users
in the channel. This is useful to prevent flood attacks. in the channel. This is useful to prevent flood attacks.
Usage Usage
----- -----
In order to use this plugin, its config values need to be properly In order to use this plugin, its config values need to be properly
setup. supybot.plugins.Limiter.enable needs to be set to True and setup. supybot.plugins.Limiter.enable needs to be set to True and
supybot.plugins.Limiter.{maximumExcess,minimumExcess} should be set to supybot.plugins.Limiter.{maximumExcess,minimumExcess} should be set to

1
plugins/LogToIrc/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the LogToIrc plugin for Supybot
Purpose Purpose
------- -------
Allows for sending the bot's logging output to channels or users. Allows for sending the bot's logging output to channels or users.
.. _conf-LogToIrc: .. _conf-LogToIrc:

3
plugins/Math/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Math plugin for Supybot
Purpose Purpose
------- -------
This plugin provides a calculator, converter, a list of units This plugin provides a calculator, converter, a list of units
and other useful math functions. and other useful math functions.
Usage Usage
----- -----
Provides commands to work with math, such as a calculator and Provides commands to work with math, such as a calculator and
a unit converter. a unit converter.
@ -17,6 +19,7 @@ a unit converter.
Commands Commands
-------- --------
.. _command-math-base: .. _command-math-base:
base <fromBase> [<toBase>] <number> base <fromBase> [<toBase>] <number>

3
plugins/MessageParser/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the MessageParser plugin for Supybot
Purpose Purpose
------- -------
The MessageParser plugin allows you to set custom regexp triggers, The MessageParser plugin allows you to set custom regexp triggers,
which will trigger the bot to respond if they match anywhere in the message. which will trigger the bot to respond if they match anywhere in the message.
This is useful for those cases when you want a bot response even when the bot This is useful for those cases when you want a bot response even when the bot
@ -15,6 +16,7 @@ https://sourceforge.net/p/gribble/wiki/MessageParser_Plugin/
Usage Usage
----- -----
This plugin can set regexp triggers to activate the bot. This plugin can set regexp triggers to activate the bot.
Use 'add' command to add regexp trigger, 'remove' to remove. Use 'add' command to add regexp trigger, 'remove' to remove.
@ -22,6 +24,7 @@ Use 'add' command to add regexp trigger, 'remove' to remove.
Commands Commands
-------- --------
.. _command-messageparser-add: .. _command-messageparser-add:
add [<channel>|global] <regexp> <action> add [<channel>|global] <regexp> <action>

3
plugins/Misc/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Misc plugin for Supybot
Purpose Purpose
------- -------
Miscellaneous commands. Miscellaneous commands.
Usage Usage
----- -----
Miscellaneous commands to access Supybot core. This is a core Miscellaneous commands to access Supybot core. This is a core
Supybot plugin that should not be removed! Supybot plugin that should not be removed!
@ -16,6 +18,7 @@ Supybot plugin that should not be removed!
Commands Commands
-------- --------
.. _command-misc-apropos: .. _command-misc-apropos:
apropos <string> apropos <string>

3
plugins/MoobotFactoids/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the MoobotFactoids plugin for Supybot
Purpose Purpose
------- -------
Moobot factoid compatibility module. Moobot's factoids were originally Moobot factoid compatibility module. Moobot's factoids were originally
designed to emulate Blootbot's factoids, so in either case, you should find designed to emulate Blootbot's factoids, so in either case, you should find
this plugin comfortable. this plugin comfortable.
Usage Usage
----- -----
An alternative to the Factoids plugin, this plugin keeps factoids in An alternative to the Factoids plugin, this plugin keeps factoids in
your bot. your bot.
@ -29,6 +31,7 @@ If you want the bot to use /mes with Factoids, that is possible too.
Commands Commands
-------- --------
.. _command-moobotfactoids-factinfo: .. _command-moobotfactoids-factinfo:
factinfo [<channel>] <factoid key> factinfo [<channel>] <factoid key>

3
plugins/Network/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Network plugin for Supybot
Purpose Purpose
------- -------
Includes commands for connecting, disconnecting, and reconnecting to multiple Includes commands for connecting, disconnecting, and reconnecting to multiple
networks, as well as several other utility functions related to IRC networks networks, as well as several other utility functions related to IRC networks
like showing the latency. like showing the latency.
Usage Usage
----- -----
Provides network-related commands, such as connecting to multiple networks Provides network-related commands, such as connecting to multiple networks
and checking latency to the server. and checking latency to the server.
@ -18,6 +20,7 @@ and checking latency to the server.
Commands Commands
-------- --------
.. _command-network-capabilities: .. _command-network-capabilities:
capabilities [<network>] capabilities [<network>]

3
plugins/News/README.rst
View File

@ -5,18 +5,21 @@ Documentation for the News plugin for Supybot
Purpose Purpose
------- -------
A module to allow each channel to have "news". News items may have expiration A module to allow each channel to have "news". News items may have expiration
dates. dates.
It was partially inspired by the news system used on #debian's bot. It was partially inspired by the news system used on #debian's bot.
Usage Usage
----- -----
This plugin provides a means of maintaining News for a channel. This plugin provides a means of maintaining News for a channel.
.. _commands-News: .. _commands-News:
Commands Commands
-------- --------
.. _command-news-add: .. _command-news-add:
add [<channel>] <expires> <subject>: <text> add [<channel>] <expires> <subject>: <text>

3
plugins/NickAuth/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the NickAuth plugin for Supybot
Purpose Purpose
------- -------
Support authentication based on nicks and network services. Support authentication based on nicks and network services.
Usage Usage
----- -----
This plugin allows users to use their network services account to This plugin allows users to use their network services account to
authenticate to the bot. authenticate to the bot.
@ -20,6 +22,7 @@ identify to the bot.
Commands Commands
-------- --------
.. _command-nickauth-auth: .. _command-nickauth-auth:
auth takes no argument auth takes no argument

2
plugins/NickCapture/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the NickCapture plugin for Supybot
Purpose Purpose
------- -------
This module attempts to capture the bot's nick, watching for an opportunity to This module attempts to capture the bot's nick, watching for an opportunity to
switch to that nick. switch to that nick.
Usage Usage
----- -----
This plugin constantly tries to take whatever nick is configured as This plugin constantly tries to take whatever nick is configured as
supybot.nick. Just make sure that's set appropriately, and thus plugin supybot.nick. Just make sure that's set appropriately, and thus plugin
will do the rest. will do the rest.

3
plugins/Nickometer/README.rst
View File

@ -5,18 +5,21 @@ Documentation for the Nickometer plugin for Supybot
Purpose Purpose
------- -------
A port of Infobot's nickometer command from Perl. This plugin A port of Infobot's nickometer command from Perl. This plugin
provides one command (called nickometer) which will tell you how 'lame' provides one command (called nickometer) which will tell you how 'lame'
an IRC nick is. It's an elitist hacker thing, but quite fun. an IRC nick is. It's an elitist hacker thing, but quite fun.
Usage Usage
----- -----
Will tell you how lame a nick is by the command 'nickometer [nick]'. Will tell you how lame a nick is by the command 'nickometer [nick]'.
.. _commands-Nickometer: .. _commands-Nickometer:
Commands Commands
-------- --------
.. _command-nickometer-nickometer: .. _command-nickometer-nickometer:
nickometer [<nick>] nickometer [<nick>]

3
plugins/Note/README.rst
View File

@ -5,17 +5,20 @@ Documentation for the Note plugin for Supybot
Purpose Purpose
------- -------
A complete messaging system that allows users to leave 'notes' for other A complete messaging system that allows users to leave 'notes' for other
users that can be retrieved later. users that can be retrieved later.
Usage Usage
----- -----
Allows you to send notes to other users. Allows you to send notes to other users.
.. _commands-Note: .. _commands-Note:
Commands Commands
-------- --------
.. _command-note-list: .. _command-note-list:
list [--{old,sent}] [--{from,to} <user>] list [--{old,sent}] [--{from,to} <user>]

3
plugins/Owner/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Owner plugin for Supybot
Purpose Purpose
------- -------
Provides commands useful to the owner of the bot; the commands here require Provides commands useful to the owner of the bot; the commands here require
their caller to have the 'owner' capability. This plugin is loaded by default. their caller to have the 'owner' capability. This plugin is loaded by default.
Usage Usage
----- -----
Owner-only commands for core Supybot. This is a core Supybot module Owner-only commands for core Supybot. This is a core Supybot module
that should not be removed! that should not be removed!
@ -17,6 +19,7 @@ that should not be removed!
Commands Commands
-------- --------
.. _command-owner-announce: .. _command-owner-announce:
announce <text> announce <text>

3
plugins/Plugin/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Plugin plugin for Supybot
Purpose Purpose
------- -------
This plugin handles various plugin-related things, such as getting help for This plugin handles various plugin-related things, such as getting help for
a plugin or retrieving author info. a plugin or retrieving author info.
Usage Usage
----- -----
This plugin exists to help users manage their plugins. Use 'plugin This plugin exists to help users manage their plugins. Use 'plugin
list' to list the loaded plugins; use 'plugin help' to get the description 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 of a plugin; use the 'plugin' command itself to determine what plugin a
@ -19,6 +21,7 @@ command exists in.
Commands Commands
-------- --------
.. _command-plugin-author: .. _command-plugin-author:
author <plugin> author <plugin>

11
plugins/PluginDownloader/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the PluginDownloader plugin for Supybot
Purpose Purpose
------- -------
This plugin allows you to quickly download and install a plugin from other This plugin allows you to quickly download and install a plugin from other
repositories. repositories.
Usage Usage
----- -----
This plugin allows you to install unofficial plugins from This plugin allows you to install unofficial plugins from
multiple repositories easily. Use the "repolist" command to see list of multiple repositories easily. Use the "repolist" command to see list of
available repositories and "repolist <repository>" to list plugins, available repositories and "repolist <repository>" to list plugins,
@ -37,14 +39,14 @@ Examples
< Mikaela> @load PluginDownloader < Mikaela> @load PluginDownloader
< Limnoria> Ok. < Limnoria> Ok.
< Mikaela> @plugindownloader repolist < Mikaela> @plugindownloader repolist
< Limnoria> Antibody, jlu5, Hoaas, Iota, ProgVal, SpiderDave, boombot, code4lib, code4lib-edsu, code4lib-snapshot, doorbot, frumious, jonimoose, mailed-notifier, mtughan-weather, nanotube-bitcoin, nyuszika7h, nyuszika7h-old, pingdom, quantumlemur, resistivecorpse, scrum, skgsergio, stepnem < Limnoria> Antibody, jlu5, Hoaas, Iota, progval, SpiderDave, boombot, code4lib, code4lib-edsu, code4lib-snapshot, doorbot, frumious, jonimoose, mailed-notifier, mtughan-weather, nanotube-bitcoin, nyuszika7h, nyuszika7h-old, pingdom, quantumlemur, resistivecorpse, scrum, skgsergio, stepnem
< Mikaela> @plugindownloader repolist ProgVal < Mikaela> @plugindownloader repolist progval
< Limnoria> AttackProtector, AutoTrans, Biography, Brainfuck, ChannelStatus, Cleverbot, Coffee, Coinpan, Debian, ERepublik, Eureka, Fortune, GUI, GitHub, Glob2Chan, GoodFrench, I18nPlaceholder, IMDb, IgnoreNonVoice, Iwant, Kickme, LimnoriaChan, LinkRelay, ListEmpty, Listener, Markovgen, MegaHAL, MilleBornes, NoLatin1, NoisyKarma, OEIS, PPP, PingTime, Pinglist, RateLimit, Rbls, Redmine, Scheme, Seeks, (1 more message) < Limnoria> AttackProtector, AutoTrans, Biography, Brainfuck, ChannelStatus, Cleverbot, Coffee, Coinpan, Debian, ERepublik, Eureka, Fortune, GUI, GitHub, Glob2Chan, GoodFrench, I18nPlaceholder, IMDb, IgnoreNonVoice, Iwant, Kickme, LimnoriaChan, LinkRelay, ListEmpty, Listener, Markovgen, MegaHAL, MilleBornes, NoLatin1, NoisyKarma, OEIS, PPP, PingTime, Pinglist, RateLimit, Rbls, Redmine, Scheme, Seeks, (1 more message)
< Mikaela> more < Mikaela> more
< Limnoria> SilencePlugin, StdoutCapture, Sudo, SupyML, SupySandbox, TWSS, Trigger, Trivia, Twitter, TwitterStream, Untiny, Variables, WebDoc, WebLogs, WebStats, Website, WikiTrans, Wikipedia, WunderWeather < Limnoria> SilencePlugin, StdoutCapture, Sudo, SupyML, SupySandbox, TWSS, Trigger, Trivia, Twitter, TwitterStream, Untiny, Variables, WebDoc, WebLogs, WebStats, Website, WikiTrans, Wikipedia, WunderWeather
< Mikaela> @plugindownloader info ProgVal Wikipedia < Mikaela> @plugindownloader info progval Wikipedia
< Limnoria> Grabs data from Wikipedia. < Limnoria> Grabs data from Wikipedia.
< Mikaela> @plugindownloader install ProgVal Wikipedia < Mikaela> @plugindownloader install progval Wikipedia
< Limnoria> Ok. < Limnoria> Ok.
< Mikaela> @load Wikipedia < Mikaela> @load Wikipedia
< Limnoria> Ok. < Limnoria> Ok.
@ -53,6 +55,7 @@ Examples
Commands Commands
-------- --------
.. _command-plugindownloader-info: .. _command-plugindownloader-info:
info <repository> <plugin> info <repository> <plugin>

3
plugins/Poll/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Poll plugin for Supybot
Purpose Purpose
------- -------
Poll: Provides a simple way to vote on answers to a question Poll: Provides a simple way to vote on answers to a question
Usage Usage
----- -----
Provides a simple way to vote on answers to a question Provides a simple way to vote on answers to a question
For example, this creates a poll:: For example, this creates a poll::
@ -48,6 +50,7 @@ make it easier::
Commands Commands
-------- --------
.. _command-poll-add: .. _command-poll-add:
add [<channel>] <question> <answer1> [<answer2> [<answer3> [...]]] add [<channel>] <question> <answer1> [<answer2> [<answer3> [...]]]

3
plugins/Praise/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Praise plugin for Supybot
Purpose Purpose
------- -------
Hand out praise to IRC denizens with this plugin. Hand out praise to IRC denizens with this plugin.
Usage Usage
----- -----
Praise is a plugin for ... well, praising things. Feel free to add Praise is a plugin for ... well, praising things. Feel free to add
your own flavor to it by customizing what praises it gives. Use "praise your own flavor to it by customizing what praises it gives. Use "praise
add <text>" to add new ones, making sure to include "$who" in <text> where add <text>" to add new ones, making sure to include "$who" in <text> where
@ -24,6 +26,7 @@ Example:
Commands Commands
-------- --------
.. _command-praise-add: .. _command-praise-add:
add [<channel>] <text> add [<channel>] <text>

2
plugins/Protector/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Protector plugin for Supybot
Purpose Purpose
------- -------
Defends a channel against actions by people who don't have the proper Defends a channel against actions by people who don't have the proper
capabilities, even if they have +o or +h. capabilities, even if they have +o or +h.
Usage Usage
----- -----
Prevents users from doing things they are not supposed to do on a channel, Prevents users from doing things they are not supposed to do on a channel,
even if they have +o or +h. even if they have +o or +h.

3
plugins/Quote/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Quote plugin for Supybot
Purpose Purpose
------- -------
Maintains a Quotes database for each channel. Maintains a Quotes database for each channel.
Usage Usage
----- -----
This plugin allows you to add quotes to the database for a channel. This plugin allows you to add quotes to the database for a channel.
.. _commands-Quote: .. _commands-Quote:
Commands Commands
-------- --------
.. _command-quote-add: .. _command-quote-add:
add [<channel>] <text> add [<channel>] <text>

3
plugins/QuoteGrabs/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the QuoteGrabs plugin for Supybot
Purpose Purpose
------- -------
Quotegrabs are like IRC sound bites. When someone says something funny, Quotegrabs are like IRC sound bites. When someone says something funny,
incriminating, stupid, outrageous, ... anything that might be worth incriminating, stupid, outrageous, ... anything that might be worth
remembering, you can grab that quote for that person. With this plugin, you remembering, you can grab that quote for that person. With this plugin, you
@ -13,6 +14,7 @@ as see who "grabbed" the quote in the first place.
Usage Usage
----- -----
Stores and displays quotes from channels. Quotes are stored randomly Stores and displays quotes from channels. Quotes are stored randomly
and/or on user request. and/or on user request.
@ -20,6 +22,7 @@ and/or on user request.
Commands Commands
-------- --------
.. _command-quotegrabs-get: .. _command-quotegrabs-get:
get [<channel>] <id> get [<channel>] <id>

5
plugins/RSS/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the RSS plugin for Supybot
Purpose Purpose
------- -------
Provides basic functionality for handling RSS/RDF feeds, and allows announcing Provides basic functionality for handling RSS/RDF feeds, and allows announcing
them periodically to channels. them periodically to channels.
In order to use this plugin you must have the following modules In order to use this plugin you must have the following modules
@ -13,6 +14,7 @@ installed:
Usage Usage
----- -----
This plugin is useful both for announcing updates to RSS feeds in a This plugin is useful both for announcing updates to RSS feeds in a
channel, and for retrieving the headlines of RSS feeds via command. Use channel, and for retrieving the headlines of RSS feeds via command. Use
the "add" command to add feeds to this plugin, and use the "announce" the "add" command to add feeds to this plugin, and use the "announce"
@ -22,7 +24,7 @@ Basic usage
^^^^^^^^^^^ ^^^^^^^^^^^
1. Add a feed using 1. Add a feed using
``@rss add limnoria https://github.com/ProgVal/Limnoria/tags.atom``. ``@rss add limnoria https://github.com/progval/Limnoria/tags.atom``.
* This is RSS feed of Limnoria's stable releases. * This is RSS feed of Limnoria's stable releases.
* You can now check the latest news from the feed with ``@limnoria``. * You can now check the latest news from the feed with ``@limnoria``.
@ -54,6 +56,7 @@ and understand what it says and then you can do
Commands Commands
-------- --------
.. _command-rss-add: .. _command-rss-add:
add <name> <url> add <name> <url>

3
plugins/Relay/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Relay plugin for Supybot
Purpose Purpose
------- -------
Handles relaying between networks. Handles relaying between networks.
Usage Usage
----- -----
This plugin allows you to setup a relay between networks. This plugin allows you to setup a relay between networks.
Note that you must tell the bot to join the channel you wish to relay on Note that you must tell the bot to join the channel you wish to relay on
@ -24,6 +26,7 @@ https://limnoria.net/plugins.xhtml#messaging
Commands Commands
-------- --------
.. _command-relay-join: .. _command-relay-join:
join [<channel>] join [<channel>]

3
plugins/Reply/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Reply plugin for Supybot
Purpose Purpose
------- -------
This plugin contains various commands which elicit certain types of responses This plugin contains various commands which elicit certain types of responses
from the bot. from the bot.
Usage Usage
----- -----
This plugin contains a few commands that construct various types of This plugin contains a few commands that construct various types of
replies. Some bot owners would be wise to not load this plugin because it replies. Some bot owners would be wise to not load this plugin because it
can be easily abused. can be easily abused.
@ -18,6 +20,7 @@ can be easily abused.
Commands Commands
-------- --------
.. _command-reply-action: .. _command-reply-action:
action <text> action <text>

3
plugins/Scheduler/README.rst
View File

@ -5,6 +5,7 @@ Documentation for the Scheduler plugin for Supybot
Purpose Purpose
------- -------
Gives the user the ability to schedule commands to run at a particular time, Gives the user the ability to schedule commands to run at a particular time,
or repeatedly run at a particular interval. For example, or repeatedly run at a particular interval. For example,
``scheduler add [time seconds 30m] "utilities echo [status cpu]"`` ``scheduler add [time seconds 30m] "utilities echo [status cpu]"``
@ -12,12 +13,14 @@ will schedule the command `cpu` to be sent to the channel in 30 minutes.
Usage Usage
----- -----
This plugin allows you to schedule commands to execute at a later time. This plugin allows you to schedule commands to execute at a later time.
.. _commands-Scheduler: .. _commands-Scheduler:
Commands Commands
-------- --------
.. _command-scheduler-add: .. _command-scheduler-add:
add <seconds> <command> add <seconds> <command>

2
plugins/SedRegex/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the SedRegex plugin for Supybot
Purpose Purpose
------- -------
History replacer using sed-style expressions. History replacer using sed-style expressions.
Usage Usage
----- -----
Enable SedRegex on the desired channels: Enable SedRegex on the desired channels:
``config channel #yourchannel plugins.sedregex.enable True`` ``config channel #yourchannel plugins.sedregex.enable True``
After enabling SedRegex, typing a regex in the form After enabling SedRegex, typing a regex in the form

3
plugins/Seen/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Seen plugin for Supybot
Purpose Purpose
------- -------
Keeps track of the last time a user was seen on a channel Keeps track of the last time a user was seen on a channel
and what they last said. and what they last said.
It also allows you to see what you missed since you parted the channel. It also allows you to see what you missed since you parted the channel.
Usage Usage
----- -----
This plugin allows you to see when and what someone last said and This plugin allows you to see when and what someone last said and
what you missed since you left a channel. what you missed since you left a channel.
@ -18,6 +20,7 @@ what you missed since you left a channel.
Commands Commands
-------- --------
.. _command-seen-any: .. _command-seen-any:
any [<channel>] [--user <name>] [<nick>] any [<channel>] [--user <name>] [<nick>]

3
plugins/Services/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Services plugin for Supybot
Purpose Purpose
------- -------
Services: Handles management of nicks with NickServ, and ops with ChanServ; Services: Handles management of nicks with NickServ, and ops with ChanServ;
to (re)gain access to its own nick and channels. to (re)gain access to its own nick and channels.
Usage Usage
----- -----
This plugin handles dealing with Services on networks that provide them. This plugin handles dealing with Services on networks that provide them.
Basically, you should use the "password" command to tell the bot a nick to Basically, you should use the "password" command to tell the bot a nick to
identify with and what password to use to identify with that nick. You can identify with and what password to use to identify with that nick. You can
@ -23,6 +25,7 @@ necessary if the bot is properly configured.
Commands Commands
-------- --------
.. _command-services-chanserv: .. _command-services-chanserv:
chanserv <text> chanserv <text>

3
plugins/ShrinkUrl/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the ShrinkUrl plugin for Supybot
Purpose Purpose
------- -------
Shrinks URLs using various URL shortening services, like tinyurl. Shrinks URLs using various URL shortening services, like tinyurl.
Usage Usage
----- -----
This plugin features commands to shorten URLs through different services, This plugin features commands to shorten URLs through different services,
like tinyurl. like tinyurl.
@ -16,6 +18,7 @@ like tinyurl.
Commands Commands
-------- --------
.. _command-shrinkurl-tiny: .. _command-shrinkurl-tiny:
tiny <url> tiny <url>

3
plugins/Status/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Status plugin for Supybot
Purpose Purpose
------- -------
A simple module to handle various informational commands querying the bot's A simple module to handle various informational commands querying the bot's
current status and statistics, like its uptime. current status and statistics, like its uptime.
Usage Usage
----- -----
This plugin allows you to view different bot statistics, for example, This plugin allows you to view different bot statistics, for example,
uptime. uptime.
@ -17,6 +19,7 @@ uptime.
Commands Commands
-------- --------
.. _command-status-cmd: .. _command-status-cmd:
cmd takes no arguments cmd takes no arguments

3
plugins/String/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the String plugin for Supybot
Purpose Purpose
------- -------
Provides various commands to manipulate characters and strings. Provides various commands to manipulate characters and strings.
Usage Usage
----- -----
Provides useful commands for manipulating characters and strings. Provides useful commands for manipulating characters and strings.
.. _commands-String: .. _commands-String:
Commands Commands
-------- --------
.. _command-string-chr: .. _command-string-chr:
chr <number> chr <number>

3
plugins/Success/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the Success plugin for Supybot
Purpose Purpose
------- -------
The Success plugin spices up success replies by allowing custom messages The Success plugin spices up success replies by allowing custom messages
instead of the default 'The operation succeeded.' message; instead of the default 'The operation succeeded.' message;
like Dunno does for "no such command" replies. like Dunno does for "no such command" replies.
Usage Usage
----- -----
This plugin was written initially to work with MoobotFactoids, the two This plugin was written initially to work with MoobotFactoids, the two
of them to provide a similar-to-moobot-and-blootbot interface for factoids. of them to provide a similar-to-moobot-and-blootbot interface for factoids.
Basically, it replaces the standard 'The operation succeeded.' messages Basically, it replaces the standard 'The operation succeeded.' messages
@ -21,6 +23,7 @@ responses.
Commands Commands
-------- --------
.. _command-success-add: .. _command-success-add:
add [<channel>] <text> add [<channel>] <text>

5
plugins/Time/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Time plugin for Supybot
Purpose Purpose
------- -------
A plugin for time-related functions. A plugin for time-related functions.
Usage Usage
----- -----
This plugin allows you to use different time-related functions. This plugin allows you to use different time-related functions.
.. _commands-Time: .. _commands-Time:
Commands Commands
-------- --------
.. _command-time-at: .. _command-time-at:
at [<time string>] at [<time string>]
@ -47,7 +50,7 @@ time [<channel>] [<format>] [<seconds since epoch>]
.. _command-time-tztime: .. _command-time-tztime:
tztime <region>/<city> tztime <region>/<city> (or <region>/<state>/<city>
Takes a city and its region, and returns its local time. This command uses the IANA Time Zone Database. Takes a city and its region, and returns its local time. This command uses the IANA Time Zone Database.
.. _command-time-until: .. _command-time-until:

3
plugins/Todo/README.rst
View File

@ -5,11 +5,13 @@ Documentation for the Todo plugin for Supybot
Purpose Purpose
------- -------
The Todo plugin allows registered users to keep their own personal list of The Todo plugin allows registered users to keep their own personal list of
tasks to do, with an optional priority for each. tasks to do, with an optional priority for each.
Usage Usage
----- -----
This plugin allows you to create your own personal to-do list on This plugin allows you to create your own personal to-do list on
the bot. the bot.
@ -17,6 +19,7 @@ the bot.
Commands Commands
-------- --------
.. _command-todo-add: .. _command-todo-add:
add [--priority=<num>] <text> add [--priority=<num>] <text>

3
plugins/Topic/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the Topic plugin for Supybot
Purpose Purpose
------- -------
Provides commands for manipulating channel topics. Provides commands for manipulating channel topics.
Usage Usage
----- -----
This plugin allows you to use many topic-related functions, This plugin allows you to use many topic-related functions,
such as Add, Undo, and Remove. such as Add, Undo, and Remove.
@ -16,6 +18,7 @@ such as Add, Undo, and Remove.
Commands Commands
-------- --------
.. _command-topic-add: .. _command-topic-add:
add [<channel>] <topic> add [<channel>] <topic>

3
plugins/URL/README.rst
View File

@ -5,12 +5,14 @@ Documentation for the URL plugin for Supybot
Purpose Purpose
------- -------
Keeps track of URLs posted to a channel, along with relevant context. Allows Keeps track of URLs posted to a channel, along with relevant context. Allows
searching for URLs and returning random URLs. Also provides statistics on the searching for URLs and returning random URLs. Also provides statistics on the
URLs in the database. URLs in the database.
Usage Usage
----- -----
This plugin records how many URLs have been mentioned in This plugin records how many URLs have been mentioned in
a channel and what the last URL was. a channel and what the last URL was.
@ -18,6 +20,7 @@ a channel and what the last URL was.
Commands Commands
-------- --------
.. _command-url-last: .. _command-url-last:
last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit] last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]

3
plugins/Unix/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Unix plugin for Supybot
Purpose Purpose
------- -------
Provides commands available only on Unix. Provides commands available only on Unix.
Usage Usage
----- -----
Provides Utilities for Unix-like systems. Provides Utilities for Unix-like systems.
.. _commands-Unix: .. _commands-Unix:
Commands Commands
-------- --------
.. _command-unix-call: .. _command-unix-call:
call <command to call with any arguments> call <command to call with any arguments>

3
plugins/User/README.rst
View File

@ -5,10 +5,12 @@ Documentation for the User plugin for Supybot
Purpose Purpose
------- -------
Provides commands useful to users in general. This plugin is loaded by default. Provides commands useful to users in general. This plugin is loaded by default.
Usage Usage
----- -----
Provides commands for dealing with users, such as registration and Provides commands for dealing with users, such as registration and
authentication to the bot. This is a core Supybot plugin that should authentication to the bot. This is a core Supybot plugin that should
not be removed! not be removed!
@ -17,6 +19,7 @@ not be removed!
Commands Commands
-------- --------
.. _command-user-capabilities: .. _command-user-capabilities:
capabilities [<name>] capabilities [<name>]

3
plugins/Utilities/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Utilities plugin for Supybot
Purpose Purpose
------- -------
Various utility commands, mostly useful for manipulating nested commands. Various utility commands, mostly useful for manipulating nested commands.
Usage Usage
----- -----
Provides useful commands for bot scripting / command nesting. Provides useful commands for bot scripting / command nesting.
.. _commands-Utilities: .. _commands-Utilities:
Commands Commands
-------- --------
.. _command-utilities-apply: .. _command-utilities-apply:
apply <command> <text> apply <command> <text>

3
plugins/Web/README.rst
View File

@ -5,16 +5,19 @@ Documentation for the Web plugin for Supybot
Purpose Purpose
------- -------
This plugin allows you to view website information, like the title of a page. Also provides a Snarfer for URLs. This plugin allows you to view website information, like the title of a page. Also provides a Snarfer for URLs.
Usage Usage
----- -----
Add the help for 'help Web' here. Add the help for 'help Web' here.
.. _commands-Web: .. _commands-Web:
Commands Commands
-------- --------
.. _command-web-doctype: .. _command-web-doctype:
doctype <url> doctype <url>

3
scripts/supybot-plugin-doc
View File

@ -113,6 +113,7 @@ class PluginDoc(object):
self.lines.append('') self.lines.append('')
self.appendLine('Purpose') self.appendLine('Purpose')
self.appendLine('-------') self.appendLine('-------')
self.lines.append('')
pdoc = getattr(self.mod, '__doc__', pdoc = getattr(self.mod, '__doc__',
'My author didn\'t give me a purpose.') 'My author didn\'t give me a purpose.')
self.appendLine(pdoc) self.appendLine(pdoc)
@ -121,6 +122,7 @@ class PluginDoc(object):
if cdoc is not None: if cdoc is not None:
self.appendLine('Usage') self.appendLine('Usage')
self.appendLine('-----') self.appendLine('-----')
self.lines.append('')
# We add spaces at the beginning in case the docstring does not # We add spaces at the beginning in case the docstring does not
# start with a newline (the default, unfortunately) # start with a newline (the default, unfortunately)
self.appendLine(textwrap.dedent(" "* 1000 + cdoc).lstrip()) self.appendLine(textwrap.dedent(" "* 1000 + cdoc).lstrip())
@ -130,6 +132,7 @@ class PluginDoc(object):
self.lines.append('.. _commands-%s:\n' % self.name) self.lines.append('.. _commands-%s:\n' % self.name)
self.appendLine('Commands') self.appendLine('Commands')
self.appendLine('--------') self.appendLine('--------')
self.lines.append('')
for command in commands: for command in commands:
log.debug('command: %s', command) log.debug('command: %s', command)
self.lines.append('.. _command-%s-%s:\n' % self.lines.append('.. _command-%s-%s:\n' %