Massive import of all generated configuration doc.

use/plugins/admin.rst

@@ -91,3 +91,19 @@ nick [<nick>]
 Changes the bot's nick to *<nick>*. If no nick is given, returns the
 bot's current nick.
 
+
+
+.. _plugin-admin-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Admin.public:
+
+supybot.plugins.Admin.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/alias.rst

@@ -43,3 +43,28 @@ remove <name>
 
 Removes the given alias, if unlocked.
 
+
+
+.. _plugin-alias-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Alias.aliases:
+
+supybot.plugins.Alias.aliases
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Alias.public:
+
+supybot.plugins.Alias.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/anonymous.rst

@@ -19,3 +19,55 @@ say <channel|nick> <text>
 Sends *<text>* to *<channel|nick>*. Can only send to *<nick>* if
 :ref:`supybot.plugins.Anonymous.allowPrivateTarget` is True.
 
+
+
+.. _plugin-anonymous-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Anonymous.requirePresenceInChannel:
+
+supybot.plugins.Anonymous.requirePresenceInChannel
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to.
+
+.. _supybot.plugins.Anonymous.allowPrivateTarget:
+
+supybot.plugins.Anonymous.allowPrivateTarget
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will require targets of the "say" command to be public (i.e., channels). If this is True, the bot will allow people to use the "say" command to send private messages to other users.
+
+.. _supybot.plugins.Anonymous.public:
+
+supybot.plugins.Anonymous.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Anonymous.requireCapability:
+
+supybot.plugins.Anonymous.requireCapability
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what capability (if any) the bot should require people trying to use this plugin to have.
+
+.. _supybot.plugins.Anonymous.requireRegistration:
+
+supybot.plugins.Anonymous.requireRegistration
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot should require people trying to use this plugin to be registered.
+

use/plugins/automode.rst

@@ -15,3 +15,91 @@ to False.
 With stock Supybot and Gribble, setting this to False will cause no automode
 at all for owners. In Limnoria, settings this to False will make automode
 work as for normal users (only channel capabilities count).
+
+
+.. _plugin-automode-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.AutoMode.enable:
+
+supybot.plugins.AutoMode.enable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is enabled.
+
+.. _supybot.plugins.AutoMode.fallthrough:
+
+supybot.plugins.AutoMode.fallthrough
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on.
+
+.. _supybot.plugins.AutoMode.halfop:
+
+supybot.plugins.AutoMode.halfop
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will automatically halfop people with the <channel>,halfop capability when they join the channel.
+
+.. _supybot.plugins.AutoMode.op:
+
+supybot.plugins.AutoMode.op
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will automatically op people with the <channel>,op capability when they join the channel.
+
+.. _supybot.plugins.AutoMode.voice:
+
+supybot.plugins.AutoMode.voice
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will automatically voice people with the <channel>,voice capability when they join the channel.
+
+.. _supybot.plugins.AutoMode.ban:
+
+supybot.plugins.AutoMode.ban
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will automatically ban people who join the channel and are on the banlist.
+
+.. _supybot.plugins.AutoMode.ban.period:
+
+supybot.plugins.AutoMode.ban.period
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 86400
+
+Determines how many seconds the bot will automatically ban a person when banning.
+
+.. _supybot.plugins.AutoMode.owner:
+
+supybot.plugins.AutoMode.owner
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability.
+
+.. _supybot.plugins.AutoMode.public:
+
+supybot.plugins.AutoMode.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/badwords.rst

@@ -25,3 +25,91 @@ add <word> [<word> ...]
 
 Adds all *<word>s* to the list of words being censored.
 
+
+
+.. _plugin-badwords-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.BadWords.kick:
+
+supybot.plugins.BadWords.kick
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will kick people with a warning when they use bad words.
+
+.. _supybot.plugins.BadWords.kick.message:
+
+supybot.plugins.BadWords.kick.message
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.
+
+Determines the kick message used by the bot when kicking users for saying bad words.
+
+.. _supybot.plugins.BadWords.nastyChars:
+
+supybot.plugins.BadWords.nastyChars
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: !@#&
+
+Determines what characters will replace bad words; a chunk of these characters matching the size of the replaced bad word will be used to replace the bad words you've configured.
+
+.. _supybot.plugins.BadWords.public:
+
+supybot.plugins.BadWords.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.BadWords.replaceMethod:
+
+supybot.plugins.BadWords.replaceMethod
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: nastyCharacters
+
+Determines the manner in which bad words will be replaced. 'nastyCharacters' (the default) will replace a bad word with the same number of 'nasty characters' (like those used in comic books; configurable by supybot.plugins.BadWords.nastyChars). 'simple' will replace a bad word with a simple strings (regardless of the length of the bad word); this string is configurable via supybot.plugins.BadWords.simpleReplacement.
+
+.. _supybot.plugins.BadWords.requireWordBoundaries:
+
+supybot.plugins.BadWords.requireWordBoundaries
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will require bad words to be independent words, or whether it will censor them within other words. For instance, if 'darn' is a bad word, then if this is true, 'darn' will be censored, but 'darnit' will not. You probably want this to be false. After changing this setting, the BadWords regexp needs to be regenerated by adding/removing a word to the list, or reloading the plugin.
+
+.. _supybot.plugins.BadWords.simpleReplacement:
+
+supybot.plugins.BadWords.simpleReplacement
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: [CENSORED]
+
+Determines what word will replace bad words if the replacement method is 'simple'.
+
+.. _supybot.plugins.BadWords.stripFormatting:
+
+supybot.plugins.BadWords.stripFormatting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will strip formatting characters from messages before it checks them for bad words. If this is False, it will be relatively trivial to circumvent this plugin's filtering. If it's True, however, it will interact poorly with other plugins that do coloring or bolding of text.
+
+.. _supybot.plugins.BadWords.words:
+
+supybot.plugins.BadWords.words
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what words are considered to be 'bad' so the bot won't say them.
+

use/plugins/channel.rst

@@ -363,3 +363,28 @@ in *<channel>* if it has been disabled. If *<plugin>* is provided,
 *<command>* will be enabled only for that plugin. If only *<plugin>* is
 provided, all commands in the given plugin will be enabled. *<channel>*
 is only necessary if the message isn't sent in the channel itself.
+
+
+.. _plugin-channel-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Channel.alwaysRejoin:
+
+supybot.plugins.Channel.alwaysRejoin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel.
+
+.. _supybot.plugins.Channel.public:
+
+supybot.plugins.Channel.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/channellogger.rst

@@ -4,3 +4,127 @@
 The ChannelLogger plugin
 ========================
 
+
+
+.. _plugin-channellogger-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.ChannelLogger.enable:
+
+supybot.plugins.ChannelLogger.enable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether logging is enabled.
+
+.. _supybot.plugins.ChannelLogger.filenameTimestamp:
+
+supybot.plugins.ChannelLogger.filenameTimestamp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: %Y-%m-%d
+
+Determines how to represent the timestamp used for the filename in rotated logs. When this timestamp changes, the old logfiles will be closed and a new one started. The format characters for the timestamp are in the time.strftime docs at python.org. In order for your logs to be rotated, you'll also have to enable supybot.plugins.ChannelLogger.rotateLogs.
+
+.. _supybot.plugins.ChannelLogger.noLogPrefix:
+
+supybot.plugins.ChannelLogger.noLogPrefix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: [nolog]
+
+Determines what string a message should be prefixed with in order not to be logged. If you don't want any such prefix, just set it to the empty string.
+
+.. _supybot.plugins.ChannelLogger.rotateLogs:
+
+supybot.plugins.ChannelLogger.rotateLogs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+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.
+
+.. _supybot.plugins.ChannelLogger.stripFormatting:
+
+supybot.plugins.ChannelLogger.stripFormatting
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk.
+
+.. _supybot.plugins.ChannelLogger.timestamp:
+
+supybot.plugins.ChannelLogger.timestamp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the logs for this channel are timestamped with the timestamp in supybot.log.timestampFormat.
+
+.. _supybot.plugins.ChannelLogger.directories:
+
+supybot.plugins.ChannelLogger.directories
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will partition its channel logs into separate directories based on different criteria.
+
+.. _supybot.plugins.ChannelLogger.directories.timestamp:
+
+supybot.plugins.ChannelLogger.directories.timestamp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories.
+
+.. _supybot.plugins.ChannelLogger.directories.timestamp.format:
+
+supybot.plugins.ChannelLogger.directories.timestamp.format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: %B
+
+Determines what timestamp format will be used in the directory structure for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True.
+
+.. _supybot.plugins.ChannelLogger.directories.channel:
+
+supybot.plugins.ChannelLogger.directories.channel
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will use a channel directory if using directories.
+
+.. _supybot.plugins.ChannelLogger.directories.network:
+
+supybot.plugins.ChannelLogger.directories.network
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will use a network directory if using directories.
+
+.. _supybot.plugins.ChannelLogger.flushImmediately:
+
+supybot.plugins.ChannelLogger.flushImmediately
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system.
+
+.. _supybot.plugins.ChannelLogger.public:
+
+supybot.plugins.ChannelLogger.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/channelstats.rst

@@ -32,3 +32,46 @@ channelstats channelstats [<channel>]
 Returns the statistics for *<channel>*. *<channel>* is only necessary if
 the message isn't sent on the channel itself.
 
+
+
+.. _plugin-channelstats-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.ChannelStats.frowns:
+
+supybot.plugins.ChannelStats.frowns
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: [':|', ':-/', ':-\\', ':\\', ':/', ':(', ':-(', ":'("]
+
+Determines what words (i.e., pieces of text with no spaces in them ) are considered 'frowns' for the purposes of stats-keeping.
+
+.. _supybot.plugins.ChannelStats.selfStats:
+
+supybot.plugins.ChannelStats.selfStats
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will keep channel statistics on itself, possibly skewing the channel stats (especially in cases where the bot is relaying between channels on a network).
+
+.. _supybot.plugins.ChannelStats.smileys:
+
+supybot.plugins.ChannelStats.smileys
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: [':)', ';)', ';]', ':-)', ':-D', ':D', ':P', ':p', '(=', '=)']
+
+Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping.
+
+.. _supybot.plugins.ChannelStats.public:
+
+supybot.plugins.ChannelStats.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/conditional.rst

@@ -149,3 +149,19 @@ if it evaluates to false.
 Use other logical operators defined in this plugin and command nesting
 to your advantage here.
 
+
+
+.. _plugin-conditional-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Conditional.public:
+
+supybot.plugins.Conditional.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/config.rst

@@ -80,3 +80,19 @@ If you want to show someone your configuration file, but you don't
 want that person to be able to see things like passwords, etc., this
 command will export a "sanitized" configuration file suitable for
 showing publicly.
+
+
+.. _plugin-config-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Config.public:
+
+supybot.plugins.Config.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/ctcp.rst

@@ -15,3 +15,28 @@ the versions received at that point. If *--nicks* is given, nicks are
 associated with the version strings; otherwise, only the version
 strings are given.
 
+
+
+.. _plugin-ctcp-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Ctcp.public:
+
+supybot.plugins.Ctcp.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Ctcp.versionWait:
+
+supybot.plugins.Ctcp.versionWait
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 10
+
+Determines how many seconds the bot will wait after getting a version command (not a CTCP VERSION, but an actual call of the command in this plugin named "version") before replying with the results it has collected.
+

use/plugins/dict.rst

@@ -37,3 +37,37 @@ dict dictionaries
 
 Returns the dictionaries valid for the dict command.
 
+
+
+.. _plugin-dict-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Dict.default:
+
+supybot.plugins.Dict.default
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines the default dictionary the bot will ask for definitions in. If this value is '*' (without the quotes) the bot will use all dictionaries to define words.
+
+.. _supybot.plugins.Dict.public:
+
+supybot.plugins.Dict.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Dict.server:
+
+supybot.plugins.Dict.server
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: dict.org
+
+Determines what server the bot will retrieve definitions from.
+

use/plugins/dunno.rst

@@ -4,3 +4,28 @@
 The Dunno plugin
 ================
 
+
+
+.. _plugin-dunno-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Dunno.prefixNick:
+
+supybot.plugins.Dunno.prefixNick
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will prefix the nick of the user giving an invalid command to the "dunno" response.
+
+.. _supybot.plugins.Dunno.public:
+
+supybot.plugins.Dunno.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/factoids.rst

@@ -131,3 +131,82 @@ Locks the factoid(s) associated with *<key>* so that they cannot be
 removed or added to. *<channel>* is only necessary if the message isn't
 sent in the channel itself.
 
+
+
+.. _plugin-factoids-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Factoids.format:
+
+supybot.plugins.Factoids.format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: $key could be $value.
+
+Determines the format of the response given when a factoid's value is requested. All the standard substitutes apply, in addition to "$key" for the factoid's key and "$value" for the factoid's value.
+
+.. _supybot.plugins.Factoids.keepRankInfo:
+
+supybot.plugins.Factoids.keepRankInfo
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether we keep updating the usage count for each factoid, for popularity ranking.
+
+.. _supybot.plugins.Factoids.learnSeparator:
+
+supybot.plugins.Factoids.learnSeparator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: as
+
+Determines what separator must be used in the learn command. Defaults to 'as' -- learn <key> as <value>. Users might feel more comfortable with 'is' or something else, so it's configurable.
+
+.. _supybot.plugins.Factoids.rankListLength:
+
+supybot.plugins.Factoids.rankListLength
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 20
+
+Determines the number of factoid keys returned by the factrank command.
+
+.. _supybot.plugins.Factoids.replyApproximateSearchKeys:
+
+supybot.plugins.Factoids.replyApproximateSearchKeys
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+If you try to look up a nonexistent factoid, this setting make the bot try to find some possible matching keys through several approximate matching algorithms and return a list of matching keys, before giving up.
+
+.. _supybot.plugins.Factoids.replyWhenInvalidCommand:
+
+supybot.plugins.Factoids.replyWhenInvalidCommand
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will reply to invalid commands by searching for a factoid; basically making the whatis unnecessary when you want all factoids for a given key.
+
+.. _supybot.plugins.Factoids.showFactoidIfOnlyOneMatch:
+
+supybot.plugins.Factoids.showFactoidIfOnlyOneMatch
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will reply with the single matching factoid if only one factoid matches when using the search command.
+
+.. _supybot.plugins.Factoids.public:
+
+supybot.plugins.Factoids.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/filter.rst

@@ -199,3 +199,73 @@ filter jeffk <text>
 
 Returns *<text>* as if JeffK had said it himself.
 
+
+
+.. _plugin-filter-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Filter.shrink:
+
+supybot.plugins.Filter.shrink
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Filter.shrink.minimum:
+
+supybot.plugins.Filter.shrink.minimum
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 4
+
+Determines the minimum number of a letters in a word before it will be shrunken by the shrink command/filter.
+
+.. _supybot.plugins.Filter.spellit:
+
+supybot.plugins.Filter.spellit
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Filter.spellit.replaceLetters:
+
+supybot.plugins.Filter.spellit.replaceLetters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether or not to replace letters in the output of spellit.
+
+.. _supybot.plugins.Filter.spellit.replaceNumbers:
+
+supybot.plugins.Filter.spellit.replaceNumbers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether or not to replace numbers in the output of spellit.
+
+.. _supybot.plugins.Filter.spellit.replacePunctuation:
+
+supybot.plugins.Filter.spellit.replacePunctuation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether or not to replace punctuation in the output of spellit.
+
+.. _supybot.plugins.Filter.public:
+
+supybot.plugins.Filter.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/format.rst

@@ -136,3 +136,19 @@ format underline <text>
 
 Returns *<text>* underlined.
 
+
+
+.. _plugin-format-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Format.public:
+
+supybot.plugins.Format.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/games.rst

@@ -50,3 +50,19 @@ Returns the number of consecutive lines you've sent in *<channel>*
 without being interrupted by someone else (i.e. how long your current
 'monologue' is). *<channel>* is only necessary if the message isn't sent
 in the channel itself.
+
+
+.. _plugin-games-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Games.public:
+
+supybot.plugins.Games.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/google.rst

@@ -65,3 +65,82 @@ Returns *<text>* translated from *<from-language>* into *<to-language>*.
 Beware that translating to or from languages that use multi-byte
 characters may result in some very odd results.
 
+
+
+.. _plugin-google-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Google.bold:
+
+supybot.plugins.Google.bold
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether results are bolded.
+
+.. _supybot.plugins.Google.colorfulFilter:
+
+supybot.plugins.Google.colorfulFilter
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the word 'google' in the bot's output will be made colorful (like Google's logo).
+
+.. _supybot.plugins.Google.defaultLanguage:
+
+supybot.plugins.Google.defaultLanguage
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: lang_en
+
+Determines what default language is used in searches. If left empty, no specific language will be requested.
+
+.. _supybot.plugins.Google.maximumResults:
+
+supybot.plugins.Google.maximumResults
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 8
+
+Determines the maximum number of results returned from the google command.
+
+.. _supybot.plugins.Google.searchFilter:
+
+supybot.plugins.Google.searchFilter
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: moderate
+
+Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering
+
+.. _supybot.plugins.Google.searchSnarfer:
+
+supybot.plugins.Google.searchSnarfer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the search snarfer is enabled. If so, messages (even unaddressed ones) beginning with the word 'google' will result in the first URL Google returns being sent to the channel.
+
+.. _supybot.plugins.Google.public:
+
+supybot.plugins.Google.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Google.referer:
+
+supybot.plugins.Google.referer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines the URL that will be sent to Google for the Referer field of the search requests. If this value is empty, a Referer will be generated in the following format: http://$server/$botName
+

use/plugins/herald.rst

@@ -60,3 +60,91 @@ Sets the herald message for *<user>* (or the user *<nick|hostmask>* is
 currently identified or recognized as) to *<msg>*. *<channel>* is only
 necessary if the message isn't sent in the channel itself.
 
+
+
+.. _plugin-herald-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Herald.heralding:
+
+supybot.plugins.Herald.heralding
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether messages will be sent to the channel when a recognized user joins; basically enables or disables the plugin.
+
+.. _supybot.plugins.Herald.default:
+
+supybot.plugins.Herald.default
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Sets the default herald to use. If a user has a personal herald specified, that will be used instead. If set to the empty string, the default herald will be disabled.
+
+.. _supybot.plugins.Herald.default.notice:
+
+supybot.plugins.Herald.default.notice
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the default herald will be sent as a NOTICE instead of a PRIVMSG.
+
+.. _supybot.plugins.Herald.default.public:
+
+supybot.plugins.Herald.default.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the default herald will be sent publicly.
+
+.. _supybot.plugins.Herald.throttle:
+
+supybot.plugins.Herald.throttle
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 600
+
+Determines the minimum number of seconds between heralds.
+
+.. _supybot.plugins.Herald.throttle.afterPart:
+
+supybot.plugins.Herald.throttle.afterPart
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 0
+
+Determines the minimum number of seconds after parting that the bot will not herald the person when he or she rejoins.
+
+.. _supybot.plugins.Herald.throttle.afterSplit:
+
+supybot.plugins.Herald.throttle.afterSplit
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 60
+
+Determines the minimum number of seconds after a netsplit that the bot will not herald the users that split.
+
+.. _supybot.plugins.Herald.public:
+
+supybot.plugins.Herald.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Herald.requireCapability:
+
+supybot.plugins.Herald.requireCapability
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what capability (if any) is required to add/change/remove the herald of another user.
+

use/plugins/internet.rst

@@ -25,3 +25,19 @@ internet hexip <ip>
 
 Returns the hexadecimal IP for that IP.
 
+
+
+.. _plugin-internet-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Internet.public:
+
+supybot.plugins.Internet.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/karma.rst

@@ -56,3 +56,73 @@ karma dump [<channel>] <filename>
 Dumps the Karma database for *<channel>* to *<filename>* in the bot's
 data directory. *<channel>* is only necessary if the message isn't sent
 in the channel itself.
+
+
+.. _plugin-karma-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Karma.allowSelfRating:
+
+supybot.plugins.Karma.allowSelfRating
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether users can adjust the karma of their nick.
+
+.. _supybot.plugins.Karma.allowUnaddressedKarma:
+
+supybot.plugins.Karma.allowUnaddressedKarma
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will increase/decrease karma without being addressed.
+
+.. _supybot.plugins.Karma.mostDisplay:
+
+supybot.plugins.Karma.mostDisplay
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 25
+
+Determines how many karma things are shown when the most command is called.
+
+.. _supybot.plugins.Karma.rankingDisplay:
+
+supybot.plugins.Karma.rankingDisplay
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 3
+
+Determines how many highest/lowest karma things are shown when karma is called with no arguments.
+
+.. _supybot.plugins.Karma.response:
+
+supybot.plugins.Karma.response
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will reply with a success message when something's karma is increased or decreased.
+
+.. _supybot.plugins.Karma.simpleOutput:
+
+supybot.plugins.Karma.simpleOutput
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma.
+
+.. _supybot.plugins.Karma.public:
+
+supybot.plugins.Karma.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/lart.rst

@@ -13,3 +13,28 @@ Uses the Luser Attitude Readjustment Tool on *<who|what>* (for *<reason>*,
 if given). If *<id>* is given, uses that specific lart. *<channel>* is
 only necessary if the message isn't sent in the channel itself.
 
+
+
+.. _plugin-lart-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Lart.showIds:
+
+supybot.plugins.Lart.showIds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will show the ids of a lart when the lart is given.
+
+.. _supybot.plugins.Lart.public:
+
+supybot.plugins.Lart.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/later.rst

@@ -28,3 +28,55 @@ Tells *<nick>* *<text>* the next time *<nick>* is in seen. *<nick>* can
 contain wildcard characters, and the first matching nick will be
 given the note.
 
+
+
+.. _plugin-later-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Later.maximum:
+
+supybot.plugins.Later.maximum
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 0
+
+Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum.
+
+.. _supybot.plugins.Later.messageExpiry:
+
+supybot.plugins.Later.messageExpiry
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 30
+
+Determines the maximum number of days that a message will remain queued for a user. After this time elapses, the message will be deleted. If this value is 0, there is no maximum.
+
+.. _supybot.plugins.Later.private:
+
+supybot.plugins.Later.private
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether users will be notified in the first place in which they're seen, or in private.
+
+.. _supybot.plugins.Later.public:
+
+supybot.plugins.Later.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Later.tellOnJoin:
+
+supybot.plugins.Later.tellOnJoin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether users will be notified upon joining any channel the bot is in, or only upon sending a message.
+

use/plugins/limiter.rst

@@ -4,3 +4,46 @@
 The Limiter plugin
 ==================
 
+
+
+.. _plugin-limiter-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Limiter.enable:
+
+supybot.plugins.Limiter.enable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will maintain the channel limit to be slightly above the current number of people in the channel, in order to make clone/drone attacks harder.
+
+.. _supybot.plugins.Limiter.maximumExcess:
+
+supybot.plugins.Limiter.maximumExcess
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 10
+
+Determines the maximum number of free spots that will be saved when limits are being enforced. This should always be larger than supybot.plugins.Limiter.limit.minimumExcess.
+
+.. _supybot.plugins.Limiter.minimumExcess:
+
+supybot.plugins.Limiter.minimumExcess
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 5
+
+Determines the minimum number of free spots that will be saved when limits are being enforced. This should always be smaller than supybot.plugins.Limiter.limit.maximumExcess.
+
+.. _supybot.plugins.Limiter.public:
+
+supybot.plugins.Limiter.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/math.rst

@@ -62,3 +62,19 @@ point arithmetic is used in order to prevent a user from being able to
 crash to the bot with something like '10**10**10**10'. One consequence
 is that large values such as '10**24' might not be exact.
 
+
+
+.. _plugin-math-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Math.public:
+
+supybot.plugins.Math.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/messageparser.rst

@@ -99,3 +99,73 @@ messageparser list [<channel>]
 Lists regexps present in the triggers database.
 *<channel>* is only necessary if the message isn't sent in the channel
 itself. Regexp ID listed in paretheses.
+
+
+.. _plugin-messageparser-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.MessageParser.enable:
+
+supybot.plugins.MessageParser.enable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db.
+
+.. _supybot.plugins.MessageParser.keepRankInfo:
+
+supybot.plugins.MessageParser.keepRankInfo
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether we keep updating the usage count for each regexp, for popularity ranking.
+
+.. _supybot.plugins.MessageParser.listSeparator:
+
+supybot.plugins.MessageParser.listSeparator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: , 
+
+Determines the separator used between regexps when shown by the list command.
+
+.. _supybot.plugins.MessageParser.rankListLength:
+
+supybot.plugins.MessageParser.rankListLength
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 20
+
+Determines the number of regexps returned by the triggerrank command.
+
+.. _supybot.plugins.MessageParser.requireManageCapability:
+
+supybot.plugins.MessageParser.requireManageCapability
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: admin; channel,op
+
+Determines the capabilities required (if any) to manage the regexp database, including add, remove, lock, unlock. Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability.
+
+.. _supybot.plugins.MessageParser.requireVacuumCapability:
+
+supybot.plugins.MessageParser.requireVacuumCapability
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: admin
+
+Determines the capability required (if any) to vacuum the database.
+
+.. _supybot.plugins.MessageParser.public:
+
+supybot.plugins.MessageParser.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/misc.rst

@@ -89,3 +89,82 @@ misc apropos <string>
 
 Searches for *<string>* in the commands currently offered by the bot,
 returning a list of the commands containing that string.
+
+
+.. _plugin-misc-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Misc.last:
+
+supybot.plugins.Misc.last
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Misc.last.nested:
+
+supybot.plugins.Misc.last.nested
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Misc.last.nested.includeNick:
+
+supybot.plugins.Misc.last.nested.includeNick
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether or not the nick will be included in the output of last when it is part of a nested command
+
+.. _supybot.plugins.Misc.last.nested.includeTimestamp:
+
+supybot.plugins.Misc.last.nested.includeTimestamp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether or not the timestamp will be included in the output of last when it is part of a nested command
+
+.. _supybot.plugins.Misc.listPrivatePlugins:
+
+supybot.plugins.Misc.listPrivatePlugins
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will list private plugins with the list command if given the --private switch. If this is disabled, non-owner users should be unable to see what private plugins are loaded.
+
+.. _supybot.plugins.Misc.listUnloadedPlugins:
+
+supybot.plugins.Misc.listUnloadedPlugins
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will list unloaded plugins with the list command if given the --unloaded switch. If this is disabled, non-owner users should be unable to see what unloaded plugins are available.
+
+.. _supybot.plugins.Misc.public:
+
+supybot.plugins.Misc.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Misc.timestampFormat:
+
+supybot.plugins.Misc.timestampFormat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: [%H:%M:%S]
+
+Determines the format string for timestamps in the Misc.last command. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown.
+

use/plugins/moobotfactoids.rst

@@ -102,3 +102,37 @@ moobotfactoids remove [<channel>] <factoid key>
 Deletes the factoid with the given key. *<channel>* is only necessary
 if the message isn't sent in the channel itself.
 
+
+
+.. _plugin-moobotfactoids-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.MoobotFactoids.mostCount:
+
+supybot.plugins.MoobotFactoids.mostCount
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 10
+
+Determines how many items are shown when the 'most' command is called.
+
+.. _supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch:
+
+supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether or not the factoid value will be shown when a listkeys search returns only one factoid key.
+
+.. _supybot.plugins.MoobotFactoids.public:
+
+supybot.plugins.MoobotFactoids.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/network.rst

@@ -85,3 +85,19 @@ Disconnects from the network represented by the network *<network>*.
 If *<quit message>* is given, quits the network with the given quit
 message. *<network>* is only necessary if the network is different
 from the network the command is sent on.
+
+
+.. _plugin-network-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Network.public:
+
+supybot.plugins.Network.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/news.rst

@@ -57,3 +57,19 @@ regular expression *<regexp>*. *<regexp>* should be of the form
 s/text/replacement/flags. *<channel>* is only necessary if the message
 isn't sent on the channel itself.
 
+
+
+.. _plugin-news-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.News.public:
+
+supybot.plugins.News.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/nickcapture.rst

@@ -4,3 +4,37 @@
 The NickCapture plugin
 ======================
 
+
+
+.. _plugin-nickcapture-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.NickCapture.ison:
+
+supybot.plugins.NickCapture.ison
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command.
+
+.. _supybot.plugins.NickCapture.ison.period:
+
+supybot.plugins.NickCapture.ison.period
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 600
+
+Determines how often (in seconds) the bot will check whether its nick ISON.
+
+.. _supybot.plugins.NickCapture.public:
+
+supybot.plugins.NickCapture.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/nickometer.rst

@@ -12,3 +12,19 @@ nickometer nickometer [<nick>]
 Tells you how lame said nick is. If *<nick>* is not given, uses the
 nick of the person giving the command.
 
+
+
+.. _plugin-nickometer-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Nickometer.public:
+
+supybot.plugins.Nickometer.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/note.rst

@@ -67,3 +67,55 @@ note send <recipient>,[<recipient>,[...]] <text>
 Sends a new note to the user specified.  Multiple recipients may be
 specified by separating their names by commas.
 
+
+
+.. _plugin-note-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Note.notify:
+
+supybot.plugins.Note.notify
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Note.notify.onJoin:
+
+supybot.plugins.Note.notify.onJoin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will notify people of their new messages when they join the channel. Normally it will notify them when they send a message to the channel, since oftentimes joins are the result of netsplits and not the actual presence of the user.
+
+.. _supybot.plugins.Note.notify.onJoin.repeatedly:
+
+supybot.plugins.Note.notify.onJoin.repeatedly
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will repeatedly notify people of their new messages when they join the channel. That means when they join the channel, the bot will tell them they have unread messages, even if it's told them before.
+
+.. _supybot.plugins.Note.notify.autoSend:
+
+supybot.plugins.Note.notify.autoSend
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 0
+
+Determines the upper limit for automatically sending messages instead of notifications. I.e., if this value is 2 and there are 2 new messages to notify a user about, instead of sending a notification message, the bot will simply send those new messages. If there are 3 new messages, however, the bot will send a notification message.
+
+.. _supybot.plugins.Note.public:
+
+supybot.plugins.Note.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/owner.rst

@@ -151,3 +151,28 @@ owner logmark <text>
 Logs *<text>* to the global Supybot log at critical priority.  Useful for
 marking logfiles for later searching.
 
+
+
+.. _plugin-owner-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Owner.public:
+
+supybot.plugins.Owner.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.Owner.quitMsg:
+
+supybot.plugins.Owner.quitMsg
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what quit message will be used by default. If the quit command is called without a quit message, this will be used. If this value is empty, the nick of the person giving the quit command will be used.
+

use/plugins/plugin.rst

@@ -60,3 +60,19 @@ plugin plugins <command>
 
 Returns the names of all plugins that contain *<command>*.
 
+
+
+.. _plugin-plugin-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Plugin.public:
+
+supybot.plugins.Plugin.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/plugindownloader.rst

@@ -20,3 +20,19 @@ Displays the list of plugins in the *<repository>*.
 If *<repository>* is not given, returns a list of available
 repositories.
 
+
+
+.. _plugin-plugindownloader-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.PluginDownloader.public:
+
+supybot.plugins.PluginDownloader.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/praise.rst

@@ -13,3 +13,28 @@ Praises *<who|what>* (for *<reason>*, if given). If *<id>* is given, uses
 that specific praise. *<channel>* is only necessary if the message isn't
 sent in the channel itself.
 
+
+
+.. _plugin-praise-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Praise.showIds:
+
+supybot.plugins.Praise.showIds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will show the ids of a praise when the praise is given.
+
+.. _supybot.plugins.Praise.public:
+
+supybot.plugins.Praise.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/protector.rst

@@ -4,3 +4,37 @@
 The Protector plugin
 ====================
 
+
+
+.. _plugin-protector-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Protector.enable:
+
+supybot.plugins.Protector.enable
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is enabled in a given channel.
+
+.. _supybot.plugins.Protector.immune:
+
+supybot.plugins.Protector.immune
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list.
+
+.. _supybot.plugins.Protector.public:
+
+supybot.plugins.Protector.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/quote.rst

@@ -12,3 +12,19 @@ quote random [<channel>]
 Returns a random quote from *<channel>*. *<channel>* is only necessary if
 the message isn't sent in the channel itself.
 
+
+
+.. _plugin-quote-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Quote.public:
+
+supybot.plugins.Quote.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/quotegrabs.rst

@@ -71,3 +71,55 @@ Grabs a quote from *<channel>* by *<nick>* for the quotegrabs table.
 *<channel>* is only necessary if the message isn't sent in the channel
 itself.
 
+
+
+.. _plugin-quotegrabs-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.QuoteGrabs.randomGrabber:
+
+supybot.plugins.QuoteGrabs.randomGrabber
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will randomly grab possibly-suitable quotes on occasion. The suitability of a given message is determined by ...
+
+.. _supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs:
+
+supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 864000
+
+Determines about how many seconds, on average, should elapse between random grabs. This is only an average value; grabs can happen from any time after half this time until never, although that's unlikely to occur.
+
+.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters:
+
+supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 8
+
+Determines the minimum number of characters in a message for it to be considered for random grabbing.
+
+.. _supybot.plugins.QuoteGrabs.randomGrabber.minimumWords:
+
+supybot.plugins.QuoteGrabs.randomGrabber.minimumWords
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 3
+
+Determines the minimum number of words in a message for it to be considered for random grabbing.
+
+.. _supybot.plugins.QuoteGrabs.public:
+
+supybot.plugins.QuoteGrabs.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/relay.rst

@@ -34,3 +34,100 @@ relay between those channels unless he's told to join both
 channels. If *<channel>* is not given, starts relaying on the channel
 the message was sent in.
 
+
+
+.. _plugin-relay-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Relay.color:
+
+supybot.plugins.Relay.color
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read.
+
+.. _supybot.plugins.Relay.hostmasks:
+
+supybot.plugins.Relay.hostmasks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will relay the hostmask of the person joining or parting the channel when he or she joins or parts.
+
+.. _supybot.plugins.Relay.ignores:
+
+supybot.plugins.Relay.ignores
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what hostmasks will not be relayed on a channel.
+
+.. _supybot.plugins.Relay.includeNetwork:
+
+supybot.plugins.Relay.includeNetwork
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will include the network in relayed PRIVMSGs; if you're only relaying between two networks, it's somewhat redundant, and you may wish to save the space.
+
+.. _supybot.plugins.Relay.noticeNonPrivmsgs:
+
+supybot.plugins.Relay.noticeNonPrivmsgs
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.)
+
+.. _supybot.plugins.Relay.punishOtherRelayBots:
+
+supybot.plugins.Relay.punishOtherRelayBots
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will detect other bots relaying and respond by kickbanning them.
+
+.. _supybot.plugins.Relay.topicSync:
+
+supybot.plugins.Relay.topicSync
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will synchronize topics between networks in the channels it relays.
+
+.. _supybot.plugins.Relay.channels:
+
+supybot.plugins.Relay.channels
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines which channels the bot will relay in.
+
+.. _supybot.plugins.Relay.channels.joinOnAllNetworks:
+
+supybot.plugins.Relay.channels.joinOnAllNetworks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will always join the channel(s) it relays for on all networks the bot is connected to.
+
+.. _supybot.plugins.Relay.public:
+
+supybot.plugins.Relay.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/reply.rst

@@ -43,3 +43,19 @@ reply reply <text>
 
 Replies with *<text>*. Equivalent to the alias, 'echo $nick: $1'.
 
+
+
+.. _plugin-reply-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Reply.public:
+
+supybot.plugins.Reply.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/rss.rst

@@ -70,3 +70,127 @@ Adds the list of feeds to the current list of announced feeds in
 well as URLs for RSS feeds. *<channel>* is only necessary if the
 message isn't sent in the channel itself.
 
+
+
+.. _plugin-rss-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.RSS.announcementPrefix:
+
+supybot.plugins.RSS.announcementPrefix
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: New news from 
+
+Determines what prefix is prepended (if any) to the new news item announcements made in the channel.
+
+.. _supybot.plugins.RSS.bold:
+
+supybot.plugins.RSS.bold
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will bold the title of the feed when it announces new news.
+
+.. _supybot.plugins.RSS.headlineSeparator:
+
+supybot.plugins.RSS.headlineSeparator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value:  || 
+
+Determines what string is used to separate headlines in new feeds.
+
+.. _supybot.plugins.RSS.initialAnnounceHeadlines:
+
+supybot.plugins.RSS.initialAnnounceHeadlines
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 5
+
+Indicates how many headlines an rss feed will output when it is first added to announce for a channel.
+
+.. _supybot.plugins.RSS.keywordBlacklist:
+
+supybot.plugins.RSS.keywordBlacklist
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist.
+
+.. _supybot.plugins.RSS.keywordWhitelist:
+
+supybot.plugins.RSS.keywordWhitelist
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist.
+
+.. _supybot.plugins.RSS.showLinks:
+
+supybot.plugins.RSS.showLinks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will list the link along with the title of the feed when the rss command is called. supybot.plugins.RSS.announce.showLinks affects whether links will be listed when a feed is automatically announced.
+
+.. _supybot.plugins.RSS.announce:
+
+supybot.plugins.RSS.announce
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines which RSS feeds should be announced in the channel; valid input is a list of strings (either registered RSS feeds or RSS feed URLs) separated by spaces.
+
+.. _supybot.plugins.RSS.announce.showLinks:
+
+supybot.plugins.RSS.announce.showLinks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will list the link along with the title of the feed when a feed is automatically announced.
+
+.. _supybot.plugins.RSS.defaultNumberOfHeadlines:
+
+supybot.plugins.RSS.defaultNumberOfHeadlines
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 1
+
+Indicates how many headlines an rss feed will output by default, if no number is provided.
+
+.. _supybot.plugins.RSS.feeds:
+
+supybot.plugins.RSS.feeds
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what feeds should be accessible as commands.
+
+.. _supybot.plugins.RSS.public:
+
+supybot.plugins.RSS.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+
+.. _supybot.plugins.RSS.waitPeriod:
+
+supybot.plugins.RSS.waitPeriod
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 1800
+
+Indicates how many seconds the bot will wait between retrieving RSS feeds; requests made within this period will return cached results.
+

use/plugins/scheduler.rst

@@ -39,3 +39,19 @@ scheduler remove <id>
 
 Removes the event scheduled with id *<id>* from the schedule.
 
+
+
+.. _plugin-scheduler-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Scheduler.public:
+
+supybot.plugins.Scheduler.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/seen.rst

@@ -51,3 +51,19 @@ seen since [<channel>] <nick>
 
 Returns the messages since *<nick>* last left the channel.
 
+
+
+.. _plugin-seen-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Seen.public:
+
+supybot.plugins.Seen.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/services.rst

@@ -77,3 +77,118 @@ services op [<channel>]
 Attempts to get opped by ChanServ in *<channel>*. *<channel>* is only
 necessary if the message isn't sent in the channel itself.
 
+
+
+.. _plugin-services-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Services.ChanServ:
+
+supybot.plugins.Services.ChanServ
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what nick the 'ChanServ' service has.
+
+.. _supybot.plugins.Services.ChanServ.halfop:
+
+supybot.plugins.Services.ChanServ.halfop
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will request to get half-opped by the ChanServ when it joins the channel.
+
+.. _supybot.plugins.Services.ChanServ.op:
+
+supybot.plugins.Services.ChanServ.op
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will request to get opped by the ChanServ when it joins the channel.
+
+.. _supybot.plugins.Services.ChanServ.password:
+
+supybot.plugins.Services.ChanServ.password
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what password the bot will use with ChanServ.
+
+.. _supybot.plugins.Services.ChanServ.voice:
+
+supybot.plugins.Services.ChanServ.voice
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will request to get voiced by the ChanServ when it joins the channel.
+
+.. _supybot.plugins.Services.NickServ:
+
+supybot.plugins.Services.NickServ
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what nick the 'NickServ' service has.
+
+.. _supybot.plugins.Services.NickServ.password:
+
+supybot.plugins.Services.NickServ.password
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Services.disabledNetworks:
+
+supybot.plugins.Services.disabledNetworks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: ['QuakeNet']
+
+Determines what networks this plugin will be disabled on.
+
+.. _supybot.plugins.Services.ghostDelay:
+
+supybot.plugins.Services.ghostDelay
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 60
+
+Determines how many seconds the bot will wait between successive GHOST attempts.
+
+.. _supybot.plugins.Services.nicks:
+
+supybot.plugins.Services.nicks
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what nicks the bot will use with services.
+
+.. _supybot.plugins.Services.noJoinsUntilIdentified:
+
+supybot.plugins.Services.noJoinsUntilIdentified
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will not join any channels until it is identified. This may be useful, for instances, if you have a vhost that isn't set until you're identified, or if you're joining +r channels that won't allow you to join unless you identify.
+
+.. _supybot.plugins.Services.public:
+
+supybot.plugins.Services.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/shrinkurl.rst

@@ -25,3 +25,91 @@ shrinkurl ln <url>
 
 Returns an ln-s.net version of *<url>*.
 
+
+
+.. _plugin-shrinkurl-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.ShrinkUrl.default:
+
+supybot.plugins.ShrinkUrl.default
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: ln
+
+Determines what website the bot will use when shrinking a URL.
+
+.. _supybot.plugins.ShrinkUrl.minimumLength:
+
+supybot.plugins.ShrinkUrl.minimumLength
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 48
+
+The minimum length a URL must be before the bot will shrink it.
+
+.. _supybot.plugins.ShrinkUrl.nonSnarfingRegexp:
+
+supybot.plugins.ShrinkUrl.nonSnarfingRegexp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: None
+
+Determines what URLs are to be snarfed; URLs matching the regexp given will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed.
+
+.. _supybot.plugins.ShrinkUrl.outFilter:
+
+supybot.plugins.ShrinkUrl.outFilter
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength.
+
+.. _supybot.plugins.ShrinkUrl.serviceRotation:
+
+supybot.plugins.ShrinkUrl.serviceRotation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter.
+
+.. _supybot.plugins.ShrinkUrl.shrinkSnarfer:
+
+supybot.plugins.ShrinkUrl.shrinkSnarfer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the shrink snarfer is enabled. This snarfer will watch for URLs in the channel, and if they're sufficiently long (as determined by supybot.plugins.ShrinkUrl.minimumLength) it will post a smaller URL from either ln-s.net or tinyurl.com, as denoted in supybot.plugins.ShrinkUrl.default.
+
+.. _supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain:
+
+supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the snarfer will show the domain of the URL being snarfed along with the shrunken URL.
+
+.. _supybot.plugins.ShrinkUrl.bold:
+
+supybot.plugins.ShrinkUrl.bold
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin will bold certain portions of its replies.
+
+.. _supybot.plugins.ShrinkUrl.public:
+
+supybot.plugins.ShrinkUrl.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/status.rst

@@ -60,3 +60,55 @@ status cpu
 
 Returns some interesting CPU-related statistics on the bot.
 
+
+
+.. _plugin-status-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Status.cpu:
+
+supybot.plugins.Status.cpu
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Status.cpu.children:
+
+supybot.plugins.Status.cpu.children
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the cpu command will list the time taken by children as well as the bot's process.
+
+.. _supybot.plugins.Status.cpu.memory:
+
+supybot.plugins.Status.cpu.memory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the cpu command will report the amount of memory being used by the bot.
+
+.. _supybot.plugins.Status.cpu.threads:
+
+supybot.plugins.Status.cpu.threads
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the cpu command will provide the number of threads spawned and active.
+
+.. _supybot.plugins.Status.public:
+
+supybot.plugins.Status.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/string.rst

@@ -97,3 +97,55 @@ string len <text>
 
 Returns the length of *<text>*.
 
+
+
+.. _plugin-string-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.String.levenshtein:
+
+supybot.plugins.String.levenshtein
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.String.levenshtein.max:
+
+supybot.plugins.String.levenshtein.max
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 256
+
+Determines the maximum size of a string given to the levenshtein command. The levenshtein command uses an O(m*n) algorithm, which means that with strings of length 256, it can take 1.5 seconds to finish; with strings of length 384, though, it can take 4 seconds to finish, and with strings of much larger lengths, it takes more and more time. Using nested commands, strings can get quite large, hence this variable, to limit the size of arguments passed to the levenshtein command.
+
+.. _supybot.plugins.String.re:
+
+supybot.plugins.String.re
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.String.re.timeout:
+
+supybot.plugins.String.re.timeout
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 0.1
+
+Determines the maximum time, in seconds, that a regular expression is given to execute before being terminated. Since there is a possibility that user input for the re command can cause it to eat up large amounts of ram or cpu time, it's a good idea to keep this low. Most normal regexps should not take very long at all.
+
+.. _supybot.plugins.String.public:
+
+supybot.plugins.String.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/success.rst

@@ -4,3 +4,28 @@
 The Success plugin
 ==================
 
+
+
+.. _plugin-success-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Success.prefixNick:
+
+supybot.plugins.Success.prefixNick
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will prefix the nick of the user giving an invalid command to the success response.
+
+.. _supybot.plugins.Success.public:
+
+supybot.plugins.Success.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/time.rst

@@ -69,3 +69,28 @@ time tztime <region>/<city>
 Takes a city and its region, and returns the locale time.
 
 .. _command-time-until:
+
+
+.. _plugin-time-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Time.format:
+
+supybot.plugins.Time.format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: %I:%M %p, %B %d, %Y
+
+Determines the format string for timestamps. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, the timestamp will not be shown.
+
+.. _supybot.plugins.Time.public:
+
+supybot.plugins.Time.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/todo.rst

@@ -58,3 +58,28 @@ todo change <task id> <regexp>
 
 Modify the task with the given id using the supplied regexp.
 
+
+
+.. _plugin-todo-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Todo.allowThirdpartyReader:
+
+supybot.plugins.Todo.allowThirdpartyReader
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether users can read the todo-list of another user.
+
+.. _supybot.plugins.Todo.public:
+
+supybot.plugins.Todo.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/topic.rst

@@ -193,3 +193,82 @@ topic separator [<channel>] <separator>
 
 Sets the topic separator for *<channel>* to *<separator>* Converts the
 current topic appropriately.
+
+
+.. _plugin-topic-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Topic.default:
+
+supybot.plugins.Topic.default
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what the default topic for the channel is. This is used by the default command to set this topic.
+
+.. _supybot.plugins.Topic.format:
+
+supybot.plugins.Topic.format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: $topic ($nick)
+
+Determines what format is used to add topics in the topic. All the standard substitutes apply, in addition to "$topic" for the topic itself.
+
+.. _supybot.plugins.Topic.recognizeTopiclen:
+
+supybot.plugins.Topic.recognizeTopiclen
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether the bot will recognize the TOPICLEN value sent to it by the server and thus refuse to send TOPICs longer than the TOPICLEN. These topics are likely to be truncated by the server anyway, so this defaults to True.
+
+.. _supybot.plugins.Topic.requireManageCapability:
+
+supybot.plugins.Topic.requireManageCapability
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: channel,op; channel,halfop
+
+Determines the capabilities required (if any) to make any topic changes, (everything except for read-only operations). Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability.
+
+.. _supybot.plugins.Topic.separator:
+
+supybot.plugins.Topic.separator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value:  || 
+
+Determines what separator is used between individually added topics in the channel topic.
+
+.. _supybot.plugins.Topic.undo:
+
+supybot.plugins.Topic.undo
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Topic.undo.max:
+
+supybot.plugins.Topic.undo.max
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 10
+
+Determines the number of previous topics to keep around in case the undo command is called.
+
+.. _supybot.plugins.Topic.public:
+
+supybot.plugins.Topic.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/unix.rst

@@ -86,3 +86,127 @@ unix wtf [is] <something>
 Returns wtf *<something>* is. 'wtf' is a \*nix command that first
 appeared in NetBSD 1.5. In most \*nices, it's available in some sort
 of 'bsdgames' package.
+
+
+.. _plugin-unix-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Unix.fortune:
+
+supybot.plugins.Unix.fortune
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Unix.fortune.command:
+
+supybot.plugins.Unix.fortune.command
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what command will be called for the fortune command.
+
+.. _supybot.plugins.Unix.fortune.equal:
+
+supybot.plugins.Unix.fortune.equal
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether fortune will give equal weight to the different fortune databases. If false, then larger databases will be given more weight. This sends the -e option to the fortune program.
+
+.. _supybot.plugins.Unix.fortune.files:
+
+supybot.plugins.Unix.fortune.files
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: []
+
+Determines what specific file (if any) will be used with the fortune command; if none is given, the system-wide default will be used. Do note that this fortune file must be placed with the rest of your system's fortune files.
+
+.. _supybot.plugins.Unix.fortune.offensive:
+
+supybot.plugins.Unix.fortune.offensive
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether fortune will retrieve offensive fortunes along with the normal fortunes. This sends the -a option to the fortune program.
+
+.. _supybot.plugins.Unix.fortune.short:
+
+supybot.plugins.Unix.fortune.short
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether only short fortunes will be used if possible. This sends the -s option to the fortune program.
+
+.. _supybot.plugins.Unix.ping:
+
+supybot.plugins.Unix.ping
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Unix.ping.command:
+
+supybot.plugins.Unix.ping.command
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: /bin/ping
+
+Determines what command will be called for the ping command.
+
+.. _supybot.plugins.Unix.spell:
+
+supybot.plugins.Unix.spell
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Unix.spell.command:
+
+supybot.plugins.Unix.spell.command
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: /usr/bin/aspell
+
+Determines what command will be called for the spell command.
+
+.. _supybot.plugins.Unix.wtf:
+
+supybot.plugins.Unix.wtf
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Unix.wtf.command:
+
+supybot.plugins.Unix.wtf.command
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 
+
+Determines what command will be called for the wtf command.
+
+.. _supybot.plugins.Unix.public:
+
+supybot.plugins.Unix.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/url.rst

@@ -25,3 +25,28 @@ given, returns all the URLs that are found. to just the URL.
 *<channel>* is only necessary if the message isn't sent in the channel
 itself.
 
+
+
+.. _plugin-url-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.URL.nonSnarfingRegexp:
+
+supybot.plugins.URL.nonSnarfingRegexp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: None
+
+Determines what URLs are not to be snarfed and stored in the database for the channel; URLs matching the given regexp will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed.
+
+.. _supybot.plugins.URL.public:
+
+supybot.plugins.URL.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/user.rst

@@ -159,3 +159,19 @@ Changes your current user database name to the new name given.
 This message must be sent to the bot privately (not on a channel) since
 it may contain a password.
 
+
+
+.. _plugin-user-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.User.public:
+
+supybot.plugins.User.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/utilities.rst

@@ -70,3 +70,19 @@ utilities apply <command> <text>
 
 Tokenizes *<text>* and calls *<command>* with the resulting arguments.
 
+
+
+.. _plugin-utilities-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Utilities.public:
+
+supybot.plugins.Utilities.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+

use/plugins/web.rst

@@ -75,3 +75,55 @@ Returns the contents of *<url>*, or as much as is configured in
 :ref:`supybot.plugins.Web.fetch.maximum.` If that configuration variable is
 set to 0, this command will be effectively disabled.
 
+
+
+.. _plugin-web-config:
+
+Configuration
+-------------
+
+.. _supybot.plugins.Web.nonSnarfingRegexp:
+
+supybot.plugins.Web.nonSnarfingRegexp
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: None
+
+Determines what URLs are to be snarfed and stored in the database in the channel; URLs matching the regexp given will not be snarfed. Give the empty string if you have no URLs that you'd like to exclude from being snarfed.
+
+.. _supybot.plugins.Web.titleSnarfer:
+
+supybot.plugins.Web.titleSnarfer
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: False
+
+Determines whether the bot will output the HTML title of URLs it sees in the channel.
+
+.. _supybot.plugins.Web.fetch:
+
+supybot.plugins.Web.fetch
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+
+
+
+.. _supybot.plugins.Web.fetch.maximum:
+
+supybot.plugins.Web.fetch.maximum
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: 0
+
+Determines the maximum number of bytes the bot will download via the 'fetch' command in this plugin.
+
+.. _supybot.plugins.Web.public:
+
+supybot.plugins.Web.public
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Default value: True
+
+Determines whether this plugin is publicly visible.
+