From 828fff9cc004cb532a7a9543aa8c29ab153ab679 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Sat, 4 Dec 2021 02:50:28 +0100 Subject: [PATCH] supybot-plugin-doc: Add missing newlines + regenerate all READMEs. --- plugins/Admin/README.rst | 3 +++ plugins/Aka/README.rst | 3 +++ plugins/Alias/README.rst | 3 +++ plugins/Anonymous/README.rst | 3 +++ plugins/AutoMode/README.rst | 2 ++ plugins/Autocomplete/README.rst | 2 ++ plugins/BadWords/README.rst | 3 +++ plugins/Channel/README.rst | 3 +++ plugins/ChannelLogger/README.rst | 12 +++++++++++- plugins/ChannelStats/README.rst | 3 +++ plugins/Conditional/README.rst | 3 +++ plugins/Config/README.rst | 3 +++ plugins/Ctcp/README.rst | 3 +++ plugins/DDG/README.rst | 3 +++ plugins/Debug/README.rst | 3 +++ plugins/Dict/README.rst | 3 +++ plugins/Dunno/README.rst | 3 +++ plugins/Factoids/README.rst | 3 +++ plugins/Fediverse/README.rst | 3 +++ plugins/Filter/README.rst | 3 +++ plugins/Format/README.rst | 3 +++ plugins/GPG/README.rst | 3 +++ plugins/Games/README.rst | 3 +++ plugins/Google/README.rst | 3 +++ plugins/Hashes/README.rst | 3 +++ plugins/Herald/README.rst | 3 +++ plugins/Internet/README.rst | 3 +++ plugins/Karma/README.rst | 3 +++ plugins/Lart/README.rst | 3 +++ plugins/Later/README.rst | 3 +++ plugins/Limiter/README.rst | 2 ++ plugins/LogToIrc/README.rst | 1 + plugins/Math/README.rst | 3 +++ plugins/MessageParser/README.rst | 3 +++ plugins/Misc/README.rst | 3 +++ plugins/MoobotFactoids/README.rst | 3 +++ plugins/Network/README.rst | 3 +++ plugins/News/README.rst | 3 +++ plugins/NickAuth/README.rst | 3 +++ plugins/NickCapture/README.rst | 2 ++ plugins/Nickometer/README.rst | 3 +++ plugins/Note/README.rst | 3 +++ plugins/Owner/README.rst | 3 +++ plugins/Plugin/README.rst | 3 +++ plugins/PluginDownloader/README.rst | 11 +++++++---- plugins/Poll/README.rst | 3 +++ plugins/Praise/README.rst | 3 +++ plugins/Protector/README.rst | 2 ++ plugins/Quote/README.rst | 3 +++ plugins/QuoteGrabs/README.rst | 3 +++ plugins/RSS/README.rst | 5 ++++- plugins/Relay/README.rst | 3 +++ plugins/Reply/README.rst | 3 +++ plugins/Scheduler/README.rst | 3 +++ plugins/SedRegex/README.rst | 2 ++ plugins/Seen/README.rst | 3 +++ plugins/Services/README.rst | 3 +++ plugins/ShrinkUrl/README.rst | 3 +++ plugins/Status/README.rst | 3 +++ plugins/String/README.rst | 3 +++ plugins/Success/README.rst | 3 +++ plugins/Time/README.rst | 5 ++++- plugins/Todo/README.rst | 3 +++ plugins/Topic/README.rst | 3 +++ plugins/URL/README.rst | 3 +++ plugins/Unix/README.rst | 3 +++ plugins/User/README.rst | 3 +++ plugins/Utilities/README.rst | 3 +++ plugins/Web/README.rst | 3 +++ scripts/supybot-plugin-doc | 3 +++ 70 files changed, 216 insertions(+), 7 deletions(-) diff --git a/plugins/Admin/README.rst b/plugins/Admin/README.rst index f7d70ecf1..6a851d539 100644 --- a/plugins/Admin/README.rst +++ b/plugins/Admin/README.rst @@ -5,11 +5,13 @@ Documentation for the Admin plugin for Supybot Purpose ------- + These are commands useful for administrating the bot; they all require their caller to have the 'admin' capability. This plugin is loaded by default. Usage ----- + This plugin provides access to administrative commands, such as adding capabilities, managing ignore lists, and joining channels. 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 -------- + .. _command-admin-acmd: acmd [ ...] diff --git a/plugins/Aka/README.rst b/plugins/Aka/README.rst index 1b1487fdf..1d3516fa2 100644 --- a/plugins/Aka/README.rst +++ b/plugins/Aka/README.rst @@ -5,12 +5,14 @@ Documentation for the Aka plugin for Supybot Purpose ------- + 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 combinations of other commands (via nested commands). Usage ----- + This plugin allows users to define aliases to commands and combinations of commands (via nesting). @@ -76,6 +78,7 @@ reply with the same information, the result of those commands. Commands -------- + .. _command-aka-add: add [--channel <#channel>] diff --git a/plugins/Alias/README.rst b/plugins/Alias/README.rst index 31ec2fbae..140ef204a 100644 --- a/plugins/Alias/README.rst +++ b/plugins/Alias/README.rst @@ -5,11 +5,13 @@ Documentation for the Alias plugin for Supybot Purpose ------- + Allows aliases for other commands. NOTE THAT IT'S RECOMMENDED TO USE Aka PLUGIN INSTEAD! Usage ----- + This plugin allows users to define aliases to commands and combinations of commands (via nesting). 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 -------- + .. _command-alias-add: add diff --git a/plugins/Anonymous/README.rst b/plugins/Anonymous/README.rst index 01a3ccef6..e641994b8 100644 --- a/plugins/Anonymous/README.rst +++ b/plugins/Anonymous/README.rst @@ -5,10 +5,12 @@ Documentation for the Anonymous plugin for Supybot Purpose ------- + Allows folks to talk through the bot anonymously. Usage ----- + 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 the 'say' command allows other people to speak through the bot. Since @@ -48,6 +50,7 @@ This Commands -------- + .. _command-anonymous-do: do diff --git a/plugins/AutoMode/README.rst b/plugins/AutoMode/README.rst index fe99b3959..afca82409 100644 --- a/plugins/AutoMode/README.rst +++ b/plugins/AutoMode/README.rst @@ -5,12 +5,14 @@ Documentation for the AutoMode plugin for Supybot Purpose ------- + 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 when they join your channel, this is the plugin to load. Usage ----- + This plugin, when configured, allows the bot to automatically set modes on users when they join. diff --git a/plugins/Autocomplete/README.rst b/plugins/Autocomplete/README.rst index 1c5fdef30..7f45455b5 100644 --- a/plugins/Autocomplete/README.rst +++ b/plugins/Autocomplete/README.rst @@ -5,6 +5,7 @@ Documentation for the Autocomplete plugin for Supybot Purpose ------- + Autocomplete: Provides command autocompletion for IRC clients that support it. 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 ----- + Provides command completion for IRC clients that support it. .. _conf-Autocomplete: diff --git a/plugins/BadWords/README.rst b/plugins/BadWords/README.rst index a6809cfff..8eec4f805 100644 --- a/plugins/BadWords/README.rst +++ b/plugins/BadWords/README.rst @@ -5,6 +5,7 @@ Documentation for the BadWords plugin for Supybot Purpose ------- + Filters bad words on outgoing messages from the bot, so the bot can't be made to say bad words. 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 ----- + 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 has op. @@ -20,6 +22,7 @@ has op. Commands -------- + .. _command-badwords-add: add [ ...] diff --git a/plugins/Channel/README.rst b/plugins/Channel/README.rst index 964e8ad60..c71724463 100644 --- a/plugins/Channel/README.rst +++ b/plugins/Channel/README.rst @@ -5,11 +5,13 @@ Documentation for the Channel plugin for Supybot Purpose ------- + Basic channel management commands. Many of these commands require their caller to have the #channel,op capability. This plugin is loaded by default. Usage ----- + This plugin provides various commands for channel management, such as setting modes and channel-wide bans/ignores/capabilities. This is a core Supybot plugin that should not be removed! @@ -18,6 +20,7 @@ a core Supybot plugin that should not be removed! Commands -------- + .. _command-channel-alert: alert [] diff --git a/plugins/ChannelLogger/README.rst b/plugins/ChannelLogger/README.rst index 52d3c86f7..4e329f962 100644 --- a/plugins/ChannelLogger/README.rst +++ b/plugins/ChannelLogger/README.rst @@ -5,10 +5,12 @@ Documentation for the ChannelLogger plugin for Supybot Purpose ------- + Logs each channel to its own individual logfile. Usage ----- + This plugin allows the bot to log channel conversations to disk. .. _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. +.. _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: supybot.plugins.ChannelLogger.showJoinParts 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: diff --git a/plugins/ChannelStats/README.rst b/plugins/ChannelStats/README.rst index eaae40b39..fc95d73a1 100644 --- a/plugins/ChannelStats/README.rst +++ b/plugins/ChannelStats/README.rst @@ -5,12 +5,14 @@ Documentation for the ChannelStats plugin for Supybot Purpose ------- + Silently listens to every message received on a channel and keeps statistics concerning joins, parts, and various other commands in addition to tracking statistics about smileys, actions, characters, and words. Usage ----- + This plugin keeps stats of the channel and returns them with the command 'channelstats'. @@ -18,6 +20,7 @@ the command 'channelstats'. Commands -------- + .. _command-channelstats-channelstats: channelstats [] diff --git a/plugins/Conditional/README.rst b/plugins/Conditional/README.rst index aa1c3561b..819aa1fe5 100644 --- a/plugins/Conditional/README.rst +++ b/plugins/Conditional/README.rst @@ -5,6 +5,7 @@ Documentation for the Conditional plugin for Supybot Purpose ------- + Contains numerous conditional commands (such as 'if', 'and', and 'or'), which can be used on their own or with another plugin. Also provides logic operators for writing conditions. @@ -13,6 +14,7 @@ Useful for bot scripting / nested commands. Usage ----- + This plugin provides logic operators and other commands that enable you to run commands only if a condition is true. Useful for nested commands and scripting. @@ -21,6 +23,7 @@ commands and scripting. Commands -------- + .. _command-conditional-cand: cand [ ... ] diff --git a/plugins/Config/README.rst b/plugins/Config/README.rst index 8b4274a90..19e19f4de 100644 --- a/plugins/Config/README.rst +++ b/plugins/Config/README.rst @@ -5,10 +5,12 @@ Documentation for the Config plugin for Supybot Purpose ------- + Handles configuration of the bot while it is running. Usage ----- + Provides access to the Supybot configuration. This is a core Supybot plugin that should not be removed! @@ -16,6 +18,7 @@ a core Supybot plugin that should not be removed! Commands -------- + .. _command-config-channel: channel [] [] [] diff --git a/plugins/Ctcp/README.rst b/plugins/Ctcp/README.rst index ea4f3889c..7db2be9d1 100644 --- a/plugins/Ctcp/README.rst +++ b/plugins/Ctcp/README.rst @@ -5,11 +5,13 @@ 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. @@ -20,6 +22,7 @@ mode +C or similar which prevents CTCP requests to channel. Commands -------- + .. _command-ctcp-version: version [] [--nicks] diff --git a/plugins/DDG/README.rst b/plugins/DDG/README.rst index d3d31d7cf..84cf100be 100644 --- a/plugins/DDG/README.rst +++ b/plugins/DDG/README.rst @@ -5,10 +5,12 @@ Documentation for the DDG plugin for Supybot Purpose ------- + Searches for results on DuckDuckGo's web search. Usage ----- + Searches for results on DuckDuckGo. Example:: @@ -20,6 +22,7 @@ Example:: Commands -------- + .. _command-ddg-search: search diff --git a/plugins/Debug/README.rst b/plugins/Debug/README.rst index 0cb69d5ae..561973ed2 100644 --- a/plugins/Debug/README.rst +++ b/plugins/Debug/README.rst @@ -5,12 +5,14 @@ Documentation for the Debug plugin for Supybot Purpose ------- + This is for developers debugging their plugins; it provides an eval command as well as some other useful commands. It should not be loaded with a default installation. Usage ----- + This plugin provides debugging abilities for Supybot. It should not be loaded with a default installation. @@ -18,6 +20,7 @@ should not be loaded with a default installation. Commands -------- + .. _command-debug-channeldb: channeldb [] diff --git a/plugins/Dict/README.rst b/plugins/Dict/README.rst index 67d04403e..0db5f822c 100644 --- a/plugins/Dict/README.rst +++ b/plugins/Dict/README.rst @@ -5,6 +5,7 @@ Documentation for the Dict plugin for Supybot Purpose ------- + Commands that use the dictd protocol to define words. In order to use this plugin you must have the following modules @@ -14,6 +15,7 @@ installed: Usage ----- + This plugin provides a function to look up words from different dictionaries. @@ -21,6 +23,7 @@ dictionaries. Commands -------- + .. _command-dict-dict: dict [] diff --git a/plugins/Dunno/README.rst b/plugins/Dunno/README.rst index d4cf8e3a5..49b596bfc 100644 --- a/plugins/Dunno/README.rst +++ b/plugins/Dunno/README.rst @@ -5,6 +5,7 @@ Documentation for the Dunno plugin for Supybot Purpose ------- + 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 ' is not a valid command'-like responses, use this plugin. @@ -12,6 +13,7 @@ Like Success does for the 'The operation succeeded.' reply. Usage ----- + This plugin was written initially to work with MoobotFactoids, the two of them to provide a similar-to-moobot-and-blootbot interface for factoids. Basically, it replaces the standard 'Error: is not a valid command.' @@ -24,6 +26,7 @@ responses. Commands -------- + .. _command-dunno-add: add [] diff --git a/plugins/Factoids/README.rst b/plugins/Factoids/README.rst index 28038fc08..5368607a1 100644 --- a/plugins/Factoids/README.rst +++ b/plugins/Factoids/README.rst @@ -5,17 +5,20 @@ Documentation for the Factoids plugin for Supybot Purpose ------- + Handles 'factoids,' little tidbits of information held in a database and available on demand via several commands. Usage ----- + Provides the ability to show Factoids. .. _commands-Factoids: Commands -------- + .. _command-factoids-alias: alias [] [] diff --git a/plugins/Fediverse/README.rst b/plugins/Fediverse/README.rst index eb77a6bcd..9f6bc8986 100644 --- a/plugins/Fediverse/README.rst +++ b/plugins/Fediverse/README.rst @@ -5,10 +5,12 @@ Documentation for the Fediverse plugin for Supybot Purpose ------- + Fetches information from ActivityPub servers. Usage ----- + Fetches information from ActivityPub servers. Enabling Secure Fetch @@ -37,6 +39,7 @@ a title like "Supybot web server index"). Commands -------- + .. _command-fediverse-featured: featured <@user@instance> diff --git a/plugins/Filter/README.rst b/plugins/Filter/README.rst index 23421b031..700840cc0 100644 --- a/plugins/Filter/README.rst +++ b/plugins/Filter/README.rst @@ -5,6 +5,7 @@ Documentation for the Filter plugin for Supybot Purpose ------- + Provides numerous filters, and a command (outfilter) to set them as filters on the output of the bot. For instance, you could make everything the bot says be @@ -16,6 +17,7 @@ commands. Usage ----- + This plugin offers several commands which transform text in some way. 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 @@ -26,6 +28,7 @@ Not very useful, but definitely quite fun :) Commands -------- + .. _command-filter-aol: aol diff --git a/plugins/Format/README.rst b/plugins/Format/README.rst index ec045d744..5d2e1c575 100644 --- a/plugins/Format/README.rst +++ b/plugins/Format/README.rst @@ -5,6 +5,7 @@ Documentation for the Format plugin for Supybot Purpose ------- + Provides simple commands for formatting text on IRC (like bold), and to change the output of the bot for a particular command. See also the :ref:`Filter plugin ` to configure @@ -12,6 +13,7 @@ the output format for all commands. Usage ----- + Provides some commands for formatting text, such as making text bold or capitalized. @@ -19,6 +21,7 @@ capitalized. Commands -------- + .. _command-format-bold: bold diff --git a/plugins/GPG/README.rst b/plugins/GPG/README.rst index 68a67bf88..dee0deee8 100644 --- a/plugins/GPG/README.rst +++ b/plugins/GPG/README.rst @@ -5,16 +5,19 @@ Documentation for the GPG plugin for Supybot Purpose ------- + GPG: Provides authentication based on GPG keys. Usage ----- + Provides authentication based on GPG keys. .. _commands-GPG: Commands -------- + .. _command-gpg-key.add: key add diff --git a/plugins/Games/README.rst b/plugins/Games/README.rst index 09f85ab66..ca3559b6d 100644 --- a/plugins/Games/README.rst +++ b/plugins/Games/README.rst @@ -5,12 +5,14 @@ Documentation for the Games plugin for Supybot Purpose ------- + This plugin provides some fun games like (Russian) roulette, 8ball, monologue which tells you how many lines you have spoken without anyone interrupting you, coin and dice. Usage ----- + This plugin provides some small games like (Russian) roulette, eightball, monologue, coin and dice. @@ -18,6 +20,7 @@ eightball, monologue, coin and dice. Commands -------- + .. _command-games-coin: coin takes no arguments diff --git a/plugins/Google/README.rst b/plugins/Google/README.rst index 9d718eca2..d58bb7618 100644 --- a/plugins/Google/README.rst +++ b/plugins/Google/README.rst @@ -5,10 +5,12 @@ Documentation for the Google plugin for Supybot Purpose ------- + Accesses Google for various things. Usage ----- + This is a simple plugin to provide access to the Google services we all know and love from our favorite IRC bot. @@ -40,6 +42,7 @@ Check: `Supported language codes`_ Commands -------- + .. _command-google-cache: cache diff --git a/plugins/Hashes/README.rst b/plugins/Hashes/README.rst index ba4befca6..0464f355e 100644 --- a/plugins/Hashes/README.rst +++ b/plugins/Hashes/README.rst @@ -5,16 +5,19 @@ Documentation for the Hashes plugin for Supybot Purpose ------- + Provides various hash- and encryption-related commands. Usage ----- + Provides hash or encryption related commands .. _commands-Hashes: Commands -------- + .. _command-hashes-algorithms: algorithms diff --git a/plugins/Herald/README.rst b/plugins/Herald/README.rst index c0181eb5b..337c33211 100644 --- a/plugins/Herald/README.rst +++ b/plugins/Herald/README.rst @@ -5,11 +5,13 @@ Documentation for the Herald plugin for Supybot Purpose ------- + Greets users who join the channel with a recognized hostmask with a nice little greeting. Usage ----- + This plugin allows you to set welcome messages (heralds) to people who 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 -------- + .. _command-herald-add: add [] diff --git a/plugins/Internet/README.rst b/plugins/Internet/README.rst index c4a43cc2d..76e18b649 100644 --- a/plugins/Internet/README.rst +++ b/plugins/Internet/README.rst @@ -5,11 +5,13 @@ Documentation for the Internet plugin for Supybot Purpose ------- + This plugin provides commands to transform domains into IP addresses and IP addresses to domains. It can also search WHOIS information and return hexips. Usage ----- + Provides commands to query DNS, search WHOIS databases, and convert IPs to hex. @@ -17,6 +19,7 @@ and convert IPs to hex. Commands -------- + .. _command-internet-dns: dns diff --git a/plugins/Karma/README.rst b/plugins/Karma/README.rst index 52b122d18..3e3e379a0 100644 --- a/plugins/Karma/README.rst +++ b/plugins/Karma/README.rst @@ -5,10 +5,12 @@ Documentation for the Karma plugin for Supybot Purpose ------- + Plugin for keeping track of Karma for users and things in a channel. Usage ----- + Provides a simple tracker for setting Karma (thing++, thing--). If ``config plugins.karma.allowUnaddressedKarma`` is set to ``True`` (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 -------- + .. _command-karma-clear: clear [] [] diff --git a/plugins/Lart/README.rst b/plugins/Lart/README.rst index fc6fd4165..b794cbd09 100644 --- a/plugins/Lart/README.rst +++ b/plugins/Lart/README.rst @@ -5,11 +5,13 @@ Documentation for the Lart plugin for Supybot Purpose ------- + This plugin keeps a database of larts (Luser Attitude Readjustment Tool), and larts with it. Usage ----- + Provides an implementation of the Luser Attitude Readjustment Tool for users. @@ -23,6 +25,7 @@ Example: Commands -------- + .. _command-lart-add: add [] diff --git a/plugins/Later/README.rst b/plugins/Later/README.rst index 09a9b5400..a49f34963 100644 --- a/plugins/Later/README.rst +++ b/plugins/Later/README.rst @@ -5,12 +5,14 @@ Documentation for the Later plugin for Supybot Purpose ------- + 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 arrive later. Usage ----- + Used to do things later; currently, it only allows the sending of 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 @@ -43,6 +45,7 @@ and the owner. Commands -------- + .. _command-later-notes: notes [] diff --git a/plugins/Limiter/README.rst b/plugins/Limiter/README.rst index 153ac39a1..029265504 100644 --- a/plugins/Limiter/README.rst +++ b/plugins/Limiter/README.rst @@ -5,12 +5,14 @@ Documentation for the Limiter plugin for Supybot Purpose ------- + This plugin sets channel limits (MODE +l) based on ``plugins.Limiter.MaximumExcess`` plus the current number of users in the channel. This is useful to prevent flood attacks. Usage ----- + 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 supybot.plugins.Limiter.{maximumExcess,minimumExcess} should be set to diff --git a/plugins/LogToIrc/README.rst b/plugins/LogToIrc/README.rst index 3a975d977..d6e5eb6a6 100644 --- a/plugins/LogToIrc/README.rst +++ b/plugins/LogToIrc/README.rst @@ -5,6 +5,7 @@ Documentation for the LogToIrc plugin for Supybot Purpose ------- + Allows for sending the bot's logging output to channels or users. .. _conf-LogToIrc: diff --git a/plugins/Math/README.rst b/plugins/Math/README.rst index 19e9f75d4..0f7827584 100644 --- a/plugins/Math/README.rst +++ b/plugins/Math/README.rst @@ -5,11 +5,13 @@ Documentation for the Math plugin for Supybot Purpose ------- + This plugin provides a calculator, converter, a list of units and other useful math functions. Usage ----- + Provides commands to work with math, such as a calculator and a unit converter. @@ -17,6 +19,7 @@ a unit converter. Commands -------- + .. _command-math-base: base [] diff --git a/plugins/MessageParser/README.rst b/plugins/MessageParser/README.rst index 6c2a24e30..34524e2d3 100644 --- a/plugins/MessageParser/README.rst +++ b/plugins/MessageParser/README.rst @@ -5,6 +5,7 @@ Documentation for the MessageParser plugin for Supybot Purpose ------- + The MessageParser plugin allows you to set custom regexp triggers, 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 @@ -15,6 +16,7 @@ https://sourceforge.net/p/gribble/wiki/MessageParser_Plugin/ Usage ----- + This plugin can set regexp triggers to activate the bot. 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 -------- + .. _command-messageparser-add: add [|global] diff --git a/plugins/Misc/README.rst b/plugins/Misc/README.rst index c4a7532d7..1d6f2d9a8 100644 --- a/plugins/Misc/README.rst +++ b/plugins/Misc/README.rst @@ -5,10 +5,12 @@ Documentation for the Misc plugin for Supybot Purpose ------- + Miscellaneous commands. Usage ----- + Miscellaneous commands to access Supybot core. This is a core Supybot plugin that should not be removed! @@ -16,6 +18,7 @@ Supybot plugin that should not be removed! Commands -------- + .. _command-misc-apropos: apropos diff --git a/plugins/MoobotFactoids/README.rst b/plugins/MoobotFactoids/README.rst index 6edf9bffa..ca5af4ed7 100644 --- a/plugins/MoobotFactoids/README.rst +++ b/plugins/MoobotFactoids/README.rst @@ -5,12 +5,14 @@ Documentation for the MoobotFactoids plugin for Supybot Purpose ------- + Moobot factoid compatibility module. Moobot's factoids were originally designed to emulate Blootbot's factoids, so in either case, you should find this plugin comfortable. Usage ----- + An alternative to the Factoids plugin, this plugin keeps factoids in your bot. @@ -29,6 +31,7 @@ If you want the bot to use /mes with Factoids, that is possible too. Commands -------- + .. _command-moobotfactoids-factinfo: factinfo [] diff --git a/plugins/Network/README.rst b/plugins/Network/README.rst index 33d61d8f6..78bf51993 100644 --- a/plugins/Network/README.rst +++ b/plugins/Network/README.rst @@ -5,12 +5,14 @@ Documentation for the Network plugin for Supybot Purpose ------- + Includes commands for connecting, disconnecting, and reconnecting to multiple networks, as well as several other utility functions related to IRC networks like showing the latency. Usage ----- + Provides network-related commands, such as connecting to multiple networks and checking latency to the server. @@ -18,6 +20,7 @@ and checking latency to the server. Commands -------- + .. _command-network-capabilities: capabilities [] diff --git a/plugins/News/README.rst b/plugins/News/README.rst index 4c35d160c..eac4e7066 100644 --- a/plugins/News/README.rst +++ b/plugins/News/README.rst @@ -5,18 +5,21 @@ Documentation for the News plugin for Supybot Purpose ------- + A module to allow each channel to have "news". News items may have expiration dates. It was partially inspired by the news system used on #debian's bot. Usage ----- + This plugin provides a means of maintaining News for a channel. .. _commands-News: Commands -------- + .. _command-news-add: add [] : diff --git a/plugins/NickAuth/README.rst b/plugins/NickAuth/README.rst index 382095712..7c2a48572 100644 --- a/plugins/NickAuth/README.rst +++ b/plugins/NickAuth/README.rst @@ -5,10 +5,12 @@ Documentation for the NickAuth plugin for Supybot Purpose ------- + Support authentication based on nicks and network services. Usage ----- + This plugin allows users to use their network services account to authenticate to the bot. @@ -20,6 +22,7 @@ identify to the bot. Commands -------- + .. _command-nickauth-auth: auth takes no argument diff --git a/plugins/NickCapture/README.rst b/plugins/NickCapture/README.rst index f926e2952..586c9ad99 100644 --- a/plugins/NickCapture/README.rst +++ b/plugins/NickCapture/README.rst @@ -5,11 +5,13 @@ Documentation for the NickCapture plugin for Supybot Purpose ------- + This module attempts to capture the bot's nick, watching for an opportunity to switch to that nick. Usage ----- + This plugin constantly tries to take whatever nick is configured as supybot.nick. Just make sure that's set appropriately, and thus plugin will do the rest. diff --git a/plugins/Nickometer/README.rst b/plugins/Nickometer/README.rst index ed92ace5e..f0ed19731 100644 --- a/plugins/Nickometer/README.rst +++ b/plugins/Nickometer/README.rst @@ -5,18 +5,21 @@ Documentation for the Nickometer plugin for Supybot Purpose ------- + A port of Infobot's nickometer command from Perl. This plugin provides one command (called nickometer) which will tell you how 'lame' an IRC nick is. It's an elitist hacker thing, but quite fun. Usage ----- + Will tell you how lame a nick is by the command 'nickometer [nick]'. .. _commands-Nickometer: Commands -------- + .. _command-nickometer-nickometer: nickometer [] diff --git a/plugins/Note/README.rst b/plugins/Note/README.rst index a101e9c3f..8f1434510 100644 --- a/plugins/Note/README.rst +++ b/plugins/Note/README.rst @@ -5,17 +5,20 @@ Documentation for the Note plugin for Supybot Purpose ------- + A complete messaging system that allows users to leave 'notes' for other users that can be retrieved later. Usage ----- + Allows you to send notes to other users. .. _commands-Note: Commands -------- + .. _command-note-list: list [--{old,sent}] [--{from,to} ] diff --git a/plugins/Owner/README.rst b/plugins/Owner/README.rst index 48f3c50d2..dd3b5f25e 100644 --- a/plugins/Owner/README.rst +++ b/plugins/Owner/README.rst @@ -5,11 +5,13 @@ Documentation for the Owner plugin for Supybot Purpose ------- + 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. Usage ----- + Owner-only commands for core Supybot. This is a core Supybot module that should not be removed! @@ -17,6 +19,7 @@ that should not be removed! Commands -------- + .. _command-owner-announce: announce diff --git a/plugins/Plugin/README.rst b/plugins/Plugin/README.rst index a125ad325..5c6ae81e2 100644 --- a/plugins/Plugin/README.rst +++ b/plugins/Plugin/README.rst @@ -5,11 +5,13 @@ 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 @@ -19,6 +21,7 @@ command exists in. Commands -------- + .. _command-plugin-author: author diff --git a/plugins/PluginDownloader/README.rst b/plugins/PluginDownloader/README.rst index 75af39740..82f04f9b5 100644 --- a/plugins/PluginDownloader/README.rst +++ b/plugins/PluginDownloader/README.rst @@ -5,11 +5,13 @@ Documentation for the PluginDownloader plugin for Supybot Purpose ------- + This plugin allows you to quickly download and install a plugin from other repositories. Usage ----- + This plugin allows you to install unofficial plugins from multiple repositories easily. Use the "repolist" command to see list of available repositories and "repolist " to list plugins, @@ -37,14 +39,14 @@ Examples < Mikaela> @load PluginDownloader < Limnoria> Ok. < 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 - < Mikaela> @plugindownloader repolist ProgVal + < 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 < 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 < 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. - < Mikaela> @plugindownloader install ProgVal Wikipedia + < Mikaela> @plugindownloader install progval Wikipedia < Limnoria> Ok. < Mikaela> @load Wikipedia < Limnoria> Ok. @@ -53,6 +55,7 @@ Examples Commands -------- + .. _command-plugindownloader-info: info diff --git a/plugins/Poll/README.rst b/plugins/Poll/README.rst index 238ef71a6..798769ff0 100644 --- a/plugins/Poll/README.rst +++ b/plugins/Poll/README.rst @@ -5,10 +5,12 @@ Documentation for the Poll plugin for Supybot Purpose ------- + Poll: Provides a simple way to vote on answers to a question Usage ----- + Provides a simple way to vote on answers to a question For example, this creates a poll:: @@ -48,6 +50,7 @@ make it easier:: Commands -------- + .. _command-poll-add: add [] [ [ [...]]] diff --git a/plugins/Praise/README.rst b/plugins/Praise/README.rst index b70598a4c..c861450b7 100644 --- a/plugins/Praise/README.rst +++ b/plugins/Praise/README.rst @@ -5,10 +5,12 @@ Documentation for the Praise plugin for Supybot Purpose ------- + Hand out praise to IRC denizens with this plugin. Usage ----- + 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 add " to add new ones, making sure to include "$who" in where @@ -24,6 +26,7 @@ Example: Commands -------- + .. _command-praise-add: add [] diff --git a/plugins/Protector/README.rst b/plugins/Protector/README.rst index 78b7070b5..650aa29de 100644 --- a/plugins/Protector/README.rst +++ b/plugins/Protector/README.rst @@ -5,11 +5,13 @@ 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. diff --git a/plugins/Quote/README.rst b/plugins/Quote/README.rst index 95a4d8919..1ce8b34b3 100644 --- a/plugins/Quote/README.rst +++ b/plugins/Quote/README.rst @@ -5,16 +5,19 @@ Documentation for the Quote plugin for Supybot Purpose ------- + Maintains a Quotes database for each channel. Usage ----- + This plugin allows you to add quotes to the database for a channel. .. _commands-Quote: Commands -------- + .. _command-quote-add: add [] diff --git a/plugins/QuoteGrabs/README.rst b/plugins/QuoteGrabs/README.rst index d2592e7e5..6a230abb4 100644 --- a/plugins/QuoteGrabs/README.rst +++ b/plugins/QuoteGrabs/README.rst @@ -5,6 +5,7 @@ Documentation for the QuoteGrabs plugin for Supybot Purpose ------- + Quotegrabs are like IRC sound bites. When someone says something funny, incriminating, stupid, outrageous, ... anything that might be worth 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 ----- + Stores and displays quotes from channels. Quotes are stored randomly and/or on user request. @@ -20,6 +22,7 @@ and/or on user request. Commands -------- + .. _command-quotegrabs-get: get [] diff --git a/plugins/RSS/README.rst b/plugins/RSS/README.rst index 4f8c6e3ea..9059de4a6 100644 --- a/plugins/RSS/README.rst +++ b/plugins/RSS/README.rst @@ -5,6 +5,7 @@ Documentation for the RSS plugin for Supybot Purpose ------- + Provides basic functionality for handling RSS/RDF feeds, and allows announcing them periodically to channels. In order to use this plugin you must have the following modules @@ -13,6 +14,7 @@ installed: Usage ----- + 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 the "add" command to add feeds to this plugin, and use the "announce" @@ -22,7 +24,7 @@ Basic usage ^^^^^^^^^^^ 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. * 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 -------- + .. _command-rss-add: add diff --git a/plugins/Relay/README.rst b/plugins/Relay/README.rst index 983af8070..394aa7223 100644 --- a/plugins/Relay/README.rst +++ b/plugins/Relay/README.rst @@ -5,10 +5,12 @@ Documentation for the Relay plugin for Supybot Purpose ------- + Handles relaying between networks. Usage ----- + 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 @@ -24,6 +26,7 @@ https://limnoria.net/plugins.xhtml#messaging Commands -------- + .. _command-relay-join: join [] diff --git a/plugins/Reply/README.rst b/plugins/Reply/README.rst index ad8028793..d724a3104 100644 --- a/plugins/Reply/README.rst +++ b/plugins/Reply/README.rst @@ -5,11 +5,13 @@ Documentation for the Reply plugin for Supybot Purpose ------- + This plugin contains various commands which elicit certain types of responses from the bot. Usage ----- + 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 can be easily abused. @@ -18,6 +20,7 @@ can be easily abused. Commands -------- + .. _command-reply-action: action diff --git a/plugins/Scheduler/README.rst b/plugins/Scheduler/README.rst index f6eb07908..cfbb16dc6 100644 --- a/plugins/Scheduler/README.rst +++ b/plugins/Scheduler/README.rst @@ -5,6 +5,7 @@ Documentation for the Scheduler plugin for Supybot Purpose ------- + Gives the user the ability to schedule commands to run at a particular time, or repeatedly run at a particular interval. For example, ``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 ----- + This plugin allows you to schedule commands to execute at a later time. .. _commands-Scheduler: Commands -------- + .. _command-scheduler-add: add diff --git a/plugins/SedRegex/README.rst b/plugins/SedRegex/README.rst index 1aa8d5853..e74cf8f30 100644 --- a/plugins/SedRegex/README.rst +++ b/plugins/SedRegex/README.rst @@ -5,10 +5,12 @@ Documentation for the SedRegex plugin for Supybot Purpose ------- + History replacer using sed-style expressions. Usage ----- + Enable SedRegex on the desired channels: ``config channel #yourchannel plugins.sedregex.enable True`` After enabling SedRegex, typing a regex in the form diff --git a/plugins/Seen/README.rst b/plugins/Seen/README.rst index 892fc5d10..ddefe42f2 100644 --- a/plugins/Seen/README.rst +++ b/plugins/Seen/README.rst @@ -5,12 +5,14 @@ Documentation for the Seen plugin for Supybot Purpose ------- + Keeps track of the last time a user was seen on a channel and what they last said. It also allows you to see what you missed since you parted the channel. Usage ----- + This plugin allows you to see when and what someone last said and what you missed since you left a channel. @@ -18,6 +20,7 @@ what you missed since you left a channel. Commands -------- + .. _command-seen-any: any [] [--user ] [] diff --git a/plugins/Services/README.rst b/plugins/Services/README.rst index 64f4f9573..340078e14 100644 --- a/plugins/Services/README.rst +++ b/plugins/Services/README.rst @@ -5,11 +5,13 @@ Documentation for the Services plugin for Supybot Purpose ------- + Services: Handles management of nicks with NickServ, and ops with ChanServ; to (re)gain access to its own nick and channels. Usage ----- + 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 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 -------- + .. _command-services-chanserv: chanserv diff --git a/plugins/ShrinkUrl/README.rst b/plugins/ShrinkUrl/README.rst index 1cd01efa9..057a15763 100644 --- a/plugins/ShrinkUrl/README.rst +++ b/plugins/ShrinkUrl/README.rst @@ -5,10 +5,12 @@ Documentation for the ShrinkUrl plugin for Supybot Purpose ------- + Shrinks URLs using various URL shortening services, like tinyurl. Usage ----- + This plugin features commands to shorten URLs through different services, like tinyurl. @@ -16,6 +18,7 @@ like tinyurl. Commands -------- + .. _command-shrinkurl-tiny: tiny diff --git a/plugins/Status/README.rst b/plugins/Status/README.rst index 277a10a85..dd69a032d 100644 --- a/plugins/Status/README.rst +++ b/plugins/Status/README.rst @@ -5,11 +5,13 @@ Documentation for the Status plugin for Supybot Purpose ------- + A simple module to handle various informational commands querying the bot's current status and statistics, like its uptime. Usage ----- + This plugin allows you to view different bot statistics, for example, uptime. @@ -17,6 +19,7 @@ uptime. Commands -------- + .. _command-status-cmd: cmd takes no arguments diff --git a/plugins/String/README.rst b/plugins/String/README.rst index c4f2352ed..3ddbaa778 100644 --- a/plugins/String/README.rst +++ b/plugins/String/README.rst @@ -5,16 +5,19 @@ Documentation for the String plugin for Supybot Purpose ------- + Provides various commands to manipulate characters and strings. Usage ----- + Provides useful commands for manipulating characters and strings. .. _commands-String: Commands -------- + .. _command-string-chr: chr diff --git a/plugins/Success/README.rst b/plugins/Success/README.rst index 3d8792f2e..4827ea7b4 100644 --- a/plugins/Success/README.rst +++ b/plugins/Success/README.rst @@ -5,12 +5,14 @@ Documentation for the Success plugin for Supybot Purpose ------- + The Success plugin spices up success replies by allowing custom messages instead of the default 'The operation succeeded.' message; like Dunno does for "no such command" replies. Usage ----- + This plugin was written initially to work with MoobotFactoids, the two of them to provide a similar-to-moobot-and-blootbot interface for factoids. Basically, it replaces the standard 'The operation succeeded.' messages @@ -21,6 +23,7 @@ responses. Commands -------- + .. _command-success-add: add [] diff --git a/plugins/Time/README.rst b/plugins/Time/README.rst index f5924bfed..b052ddccb 100644 --- a/plugins/Time/README.rst +++ b/plugins/Time/README.rst @@ -5,16 +5,19 @@ Documentation for the Time plugin for Supybot Purpose ------- + A plugin for time-related functions. Usage ----- + This plugin allows you to use different time-related functions. .. _commands-Time: Commands -------- + .. _command-time-at: at [