Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-07 19:49:23 +01:00
Code Issues Projects Releases Wiki Activity

supybot-plugin-doc: Remove extra space + regenerate all READMEs.

Browse Source
This commit is contained in:
Valentin Lorentz 2021-12-04 03:19:12 +01:00
parent 2d2241787f
commit ed9dffdd7f
70 changed files with 316 additions and 316 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
plugins/Admin/README.rst
View File

@ -80,7 +80,7 @@ Configuration
supybot.plugins.Admin.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/Aka/README.rst
View File

@ -133,7 +133,7 @@ Configuration
supybot.plugins.Aka.maximumWordsInName
This config variable defaults to "5", is not network-specific, and is not channel-specific.
This config variable defaults to "5", is not network-specific, and is not channel-specific.
The maximum number of words allowed in a command name. Setting this to an high value may slow down your bot on long commands.
@ -141,7 +141,7 @@ supybot.plugins.Aka.maximumWordsInName
supybot.plugins.Aka.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -155,7 +155,7 @@ supybot.plugins.Aka.web
supybot.plugins.Aka.web.enable
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether the Akas will be browsable through the HTTP server.

4
plugins/Alias/README.rst
View File

@ -85,7 +85,7 @@ supybot.plugins.Alias.escapedaliases
supybot.plugins.Alias.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -93,7 +93,7 @@ supybot.plugins.Alias.public
supybot.plugins.Alias.validName
This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific.
This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific.
Regex which alias names must match in order to be valid

10
plugins/Anonymous/README.rst
View File

@ -80,7 +80,7 @@ Configuration
supybot.plugins.Anonymous.allowPrivateTarget
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether the bot will allow the "tell" command to be used. If true, the bot will allow the "tell" command to send private messages to other users.
@ -88,7 +88,7 @@ supybot.plugins.Anonymous.allowPrivateTarget
supybot.plugins.Anonymous.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -96,7 +96,7 @@ supybot.plugins.Anonymous.public
supybot.plugins.Anonymous.requireCapability
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
Determines what capability (if any) the bot should require people trying to use this plugin to have.
@ -104,7 +104,7 @@ supybot.plugins.Anonymous.requireCapability
supybot.plugins.Anonymous.requirePresenceInChannel
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to.
@ -112,7 +112,7 @@ supybot.plugins.Anonymous.requirePresenceInChannel
supybot.plugins.Anonymous.requireRegistration
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot should require people trying to use this plugin to be registered.

24
plugins/AutoMode/README.rst
View File

@ -37,7 +37,7 @@ Configuration
supybot.plugins.AutoMode.alternativeCapabilities
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will check for 'alternative capabilities' (ie. autoop, autohalfop, autovoice) in addition to/instead of classic ones.
@ -45,7 +45,7 @@ supybot.plugins.AutoMode.alternativeCapabilities
supybot.plugins.AutoMode.ban
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will automatically ban people who join the channel and are on the banlist.
@ -53,7 +53,7 @@ supybot.plugins.AutoMode.ban
supybot.plugins.AutoMode.ban.period
This config variable defaults to "86400", is network-specific, and is channel-specific.
This config variable defaults to "86400", is network-specific, and is channel-specific.
Determines how many seconds the bot will automatically ban a person when banning.
@ -61,7 +61,7 @@ supybot.plugins.AutoMode.ban
supybot.plugins.AutoMode.delay
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.
Determines how many seconds the bot will wait before applying a mode. Has no effect on bans.
@ -69,7 +69,7 @@ supybot.plugins.AutoMode.delay
supybot.plugins.AutoMode.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether this plugin is enabled.
@ -77,7 +77,7 @@ supybot.plugins.AutoMode.enable
supybot.plugins.AutoMode.extra
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
Extra modes that will be applied to a user. Example syntax: user1+o-v user2+v user3-v
@ -85,7 +85,7 @@ supybot.plugins.AutoMode.extra
supybot.plugins.AutoMode.fallthrough
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on.
@ -93,7 +93,7 @@ supybot.plugins.AutoMode.fallthrough
supybot.plugins.AutoMode.halfop
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will automatically halfop people with the <channel>,halfop capability when they join the channel.
@ -101,7 +101,7 @@ supybot.plugins.AutoMode.halfop
supybot.plugins.AutoMode.op
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will automatically op people with the <channel>,op capability when they join the channel.
@ -109,7 +109,7 @@ supybot.plugins.AutoMode.op
supybot.plugins.AutoMode.owner
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability.
@ -117,7 +117,7 @@ supybot.plugins.AutoMode.owner
supybot.plugins.AutoMode.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -125,7 +125,7 @@ supybot.plugins.AutoMode.public
supybot.plugins.AutoMode.voice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will automatically voice people with the <channel>,voice capability when they join the channel.

4
plugins/Autocomplete/README.rst
View File

@ -30,7 +30,7 @@ Configuration
supybot.plugins.Autocomplete.enabled
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Whether the bot should reply to autocomplete requests from clients.
@ -38,7 +38,7 @@ supybot.plugins.Autocomplete.enabled
supybot.plugins.Autocomplete.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

20
plugins/BadWords/README.rst
View File

@ -47,7 +47,7 @@ Configuration
supybot.plugins.BadWords.kick
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will kick people with a warning when they use bad words.
@ -55,7 +55,7 @@ supybot.plugins.BadWords.kick
supybot.plugins.BadWords.kick.message
This config variable defaults to "You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.", is network-specific, and is channel-specific.
This config variable defaults to "You have been kicked for using a word prohibited in the presence of this bot. Please use more appropriate language in the future.", is network-specific, and is channel-specific.
Determines the kick message used by the bot when kicking users for saying bad words.
@ -63,7 +63,7 @@ supybot.plugins.BadWords.kick
supybot.plugins.BadWords.nastyChars
This config variable defaults to "!@#&", is not network-specific, and is not channel-specific.
This config variable defaults to "!@#&", is not network-specific, and is not channel-specific.
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.
@ -71,7 +71,7 @@ supybot.plugins.BadWords.nastyChars
supybot.plugins.BadWords.phrases
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Comma-separated groups of words that are considered to be 'bad'.
@ -79,7 +79,7 @@ supybot.plugins.BadWords.phrases
supybot.plugins.BadWords.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -87,7 +87,7 @@ supybot.plugins.BadWords.public
supybot.plugins.BadWords.replaceMethod
This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific.
This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific.
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. Valid strings: simple and nastyCharacters.
@ -95,7 +95,7 @@ supybot.plugins.BadWords.replaceMethod
supybot.plugins.BadWords.requireWordBoundaries
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
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.
@ -103,7 +103,7 @@ supybot.plugins.BadWords.requireWordBoundaries
supybot.plugins.BadWords.simpleReplacement
This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific.
This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific.
Determines what word will replace bad words if the replacement method is 'simple'.
@ -111,7 +111,7 @@ supybot.plugins.BadWords.simpleReplacement
supybot.plugins.BadWords.stripFormatting
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
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.
@ -119,7 +119,7 @@ supybot.plugins.BadWords.stripFormatting
supybot.plugins.BadWords.words
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Determines what words are considered to be 'bad' so the bot won't say them.

10
plugins/Channel/README.rst
View File

@ -225,7 +225,7 @@ Configuration
supybot.plugins.Channel.alwaysRejoin
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will always try to rejoin a channel whenever it's kicked from the channel.
@ -233,7 +233,7 @@ supybot.plugins.Channel.alwaysRejoin
supybot.plugins.Channel.nicksInPrivate
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the output of 'nicks' will be sent in private. This prevents mass-highlights of a channel's users, accidental or on purpose.
@ -241,7 +241,7 @@ supybot.plugins.Channel.nicksInPrivate
supybot.plugins.Channel.partMsg
This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.
This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.
Determines what part message should be used by default. If the part command is called without a part message, this will be used. If this value is empty, then no part message will be used (they are optional in the IRC protocol). The standard substitutions ($version, $nick, etc.) are all handled appropriately.
@ -249,7 +249,7 @@ supybot.plugins.Channel.partMsg
supybot.plugins.Channel.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -257,7 +257,7 @@ supybot.plugins.Channel.public
supybot.plugins.Channel.rejoinDelay
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.
Determines how many seconds the bot will wait before rejoining a channel if kicked and supybot.plugins.Channel.alwaysRejoin is on.

32
plugins/ChannelLogger/README.rst
View File

@ -22,7 +22,7 @@ Configuration
supybot.plugins.ChannelLogger.directories
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether the bot will partition its channel logs into separate directories based on different criteria.
@ -30,7 +30,7 @@ supybot.plugins.ChannelLogger.directories
supybot.plugins.ChannelLogger.directories.channel
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether the bot will use a channel directory if using directories.
@ -38,7 +38,7 @@ supybot.plugins.ChannelLogger.directories
supybot.plugins.ChannelLogger.directories.network
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether the bot will use a network directory if using directories.
@ -46,7 +46,7 @@ supybot.plugins.ChannelLogger.directories
supybot.plugins.ChannelLogger.directories.timestamp
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether the bot will use a timestamp (determined by supybot.plugins.ChannelLogger.directories.timestamp.format) if using directories.
@ -54,7 +54,7 @@ supybot.plugins.ChannelLogger.directories
supybot.plugins.ChannelLogger.directories.timestamp.format
This config variable defaults to "%B", is not network-specific, and is not channel-specific.
This config variable defaults to "%B", is not network-specific, and is not channel-specific.
Determines what timestamp format will be used in the directory structure for channel logs if supybot.plugins.ChannelLogger.directories.timestamp is True.
@ -62,7 +62,7 @@ supybot.plugins.ChannelLogger.directories
supybot.plugins.ChannelLogger.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether logging is enabled.
@ -70,7 +70,7 @@ supybot.plugins.ChannelLogger.enable
supybot.plugins.ChannelLogger.filenameTimestamp
This config variable defaults to "%Y-%m-%d", is network-specific, and is channel-specific.
This config variable defaults to "%Y-%m-%d", is network-specific, and is channel-specific.
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.
@ -78,7 +78,7 @@ supybot.plugins.ChannelLogger.filenameTimestamp
supybot.plugins.ChannelLogger.flushImmediately
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether channel logfiles will be flushed anytime they're written to, rather than being buffered by the operating system.
@ -86,7 +86,7 @@ supybot.plugins.ChannelLogger.flushImmediately
supybot.plugins.ChannelLogger.noLogPrefix
This config variable defaults to "[nolog]", is network-specific, and is channel-specific.
This config variable defaults to "[nolog]", is network-specific, and is channel-specific.
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.
@ -94,7 +94,7 @@ supybot.plugins.ChannelLogger.noLogPrefix
supybot.plugins.ChannelLogger.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -102,7 +102,7 @@ supybot.plugins.ChannelLogger.public
supybot.plugins.ChannelLogger.rewriteRelayed
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will rewrite outgoing relayed messages (eg. from the Relay plugin) to use the original nick instead of the bot's nick.
@ -110,7 +110,7 @@ supybot.plugins.ChannelLogger.rewriteRelayed
supybot.plugins.ChannelLogger.rotateLogs
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
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.
@ -118,7 +118,7 @@ supybot.plugins.ChannelLogger.rotateLogs
supybot.plugins.ChannelLogger.showAway
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether users going away and coming back should be logged. This is only supported on networks implementing the 'away-notify' IRCv3 capability.
@ -126,7 +126,7 @@ supybot.plugins.ChannelLogger.showAway
supybot.plugins.ChannelLogger.showJoinParts
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether joins and parts are logged
@ -134,7 +134,7 @@ supybot.plugins.ChannelLogger.showJoinParts
supybot.plugins.ChannelLogger.stripFormatting
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether formatting characters (such as bolding, color, etc.) are removed when writing the logs to disk.
@ -142,7 +142,7 @@ supybot.plugins.ChannelLogger.stripFormatting
supybot.plugins.ChannelLogger.timestamp
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the logs for this channel are timestamped with the timestamp in supybot.log.timestampFormat.

8
plugins/ChannelStats/README.rst
View File

@ -45,7 +45,7 @@ Configuration
supybot.plugins.ChannelStats.frowns
This config variable defaults to ":| :-/ :-\\ :\\ :/ :( :-( :'(", is network-specific, and is channel-specific.
This config variable defaults to ":| :-/ :-\\ :\\ :/ :( :-( :'(", is network-specific, and is channel-specific.
Determines what words (i.e., pieces of text with no spaces in them) are considered 'frowns' for the purposes of stats-keeping.
@ -53,7 +53,7 @@ supybot.plugins.ChannelStats.frowns
supybot.plugins.ChannelStats.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -61,7 +61,7 @@ supybot.plugins.ChannelStats.public
supybot.plugins.ChannelStats.selfStats
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines 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).
@ -69,7 +69,7 @@ supybot.plugins.ChannelStats.selfStats
supybot.plugins.ChannelStats.smileys
This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific.
This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific.
Determines what words (i.e., pieces of text with no spaces in them) are considered 'smileys' for the purposes of stats-keeping.

2
plugins/Conditional/README.rst
View File

@ -123,7 +123,7 @@ Configuration
supybot.plugins.Conditional.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Config/README.rst
View File

@ -98,7 +98,7 @@ Configuration
supybot.plugins.Config.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/Ctcp/README.rst
View File

@ -37,7 +37,7 @@ Configuration
supybot.plugins.Ctcp.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -45,7 +45,7 @@ supybot.plugins.Ctcp.public
supybot.plugins.Ctcp.userinfo
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what will be sent when a USERINFO query is received.
@ -53,7 +53,7 @@ supybot.plugins.Ctcp.userinfo
supybot.plugins.Ctcp.versionWait
This config variable defaults to "10", is not network-specific, and is not channel-specific.
This config variable defaults to "10", is not network-specific, and is not channel-specific.
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.

10
plugins/DDG/README.rst
View File

@ -37,7 +37,7 @@ Configuration
supybot.plugins.DDG.maxResults
This config variable defaults to "4", is network-specific, and is channel-specific.
This config variable defaults to "4", is network-specific, and is channel-specific.
Determines the maximum number of results the bot will respond with.
@ -45,7 +45,7 @@ supybot.plugins.DDG.maxResults
supybot.plugins.DDG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -53,7 +53,7 @@ supybot.plugins.DDG.public
supybot.plugins.DDG.region
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
Set the DDG search region to return results for the language/country of your choice. E.g. 'us-en' for United States. https://duckduckgo.com/params
@ -61,7 +61,7 @@ supybot.plugins.DDG.region
supybot.plugins.DDG.searchFilter
This config variable defaults to "moderate", is network-specific, and is channel-specific.
This config variable defaults to "moderate", is network-specific, and is channel-specific.
Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off.
@ -69,7 +69,7 @@ supybot.plugins.DDG.searchFilter
supybot.plugins.DDG.showSnippet
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will show a snippet of each resulting link. If False, it will show the title of the link instead.

2
plugins/Debug/README.rst
View File

@ -80,7 +80,7 @@ Configuration
supybot.plugins.Debug.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

8
plugins/Dict/README.rst
View File

@ -53,7 +53,7 @@ Configuration
supybot.plugins.Dict.default
This config variable defaults to "*", is network-specific, and is channel-specific.
This config variable defaults to "*", is network-specific, and is channel-specific.
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.
@ -61,7 +61,7 @@ supybot.plugins.Dict.default
supybot.plugins.Dict.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -69,7 +69,7 @@ supybot.plugins.Dict.public
supybot.plugins.Dict.server
This config variable defaults to "dict.org", is not network-specific, and is not channel-specific.
This config variable defaults to "dict.org", is not network-specific, and is not channel-specific.
Determines what server the bot will retrieve definitions from.
@ -77,7 +77,7 @@ supybot.plugins.Dict.server
supybot.plugins.Dict.showDictName
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will show which dictionaries responded to a query, if the selected dictionary is '*'.

4
plugins/Dunno/README.rst
View File

@ -66,7 +66,7 @@ Configuration
supybot.plugins.Dunno.prefixNick
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will prefix the nick of the user giving an invalid command to the "dunno" response.
@ -74,7 +74,7 @@ supybot.plugins.Dunno.prefixNick
supybot.plugins.Dunno.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

22
plugins/Factoids/README.rst
View File

@ -83,7 +83,7 @@ Configuration
supybot.plugins.Factoids.format
This config variable defaults to "$value", is network-specific, and is channel-specific.
This config variable defaults to "$value", is network-specific, and is channel-specific.
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.
@ -91,7 +91,7 @@ supybot.plugins.Factoids.format
supybot.plugins.Factoids.keepRankInfo
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether we keep updating the usage count for each factoid, for popularity ranking.
@ -99,7 +99,7 @@ supybot.plugins.Factoids.keepRankInfo
supybot.plugins.Factoids.learnSeparator
This config variable defaults to "is", is network-specific, and is channel-specific.
This config variable defaults to "is", is network-specific, and is channel-specific.
Determines what separator must be used in the learn command. Defaults to 'is' -- learn <key> is <value>. Users might want to change this to something else, so it's configurable.
@ -107,7 +107,7 @@ supybot.plugins.Factoids.learnSeparator
supybot.plugins.Factoids.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -115,7 +115,7 @@ supybot.plugins.Factoids.public
supybot.plugins.Factoids.rankListLength
This config variable defaults to "20", is network-specific, and is channel-specific.
This config variable defaults to "20", is network-specific, and is channel-specific.
Determines the number of factoid keys returned by the factrank command.
@ -123,7 +123,7 @@ supybot.plugins.Factoids.rankListLength
supybot.plugins.Factoids.replyApproximateSearchKeys
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
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.
@ -131,7 +131,7 @@ supybot.plugins.Factoids.replyApproximateSearchKeys
supybot.plugins.Factoids.replyWhenInvalidCommand
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines 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.
@ -139,7 +139,7 @@ supybot.plugins.Factoids.replyWhenInvalidCommand
supybot.plugins.Factoids.requireVoice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Only allows a user with voice or above on a channel to use the 'learn' and 'forget' commands.
@ -147,7 +147,7 @@ supybot.plugins.Factoids.requireVoice
supybot.plugins.Factoids.showFactoidIfOnlyOneMatch
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will reply with the single matching factoid if only one factoid matches when using the search command.
@ -161,7 +161,7 @@ supybot.plugins.Factoids.web
supybot.plugins.Factoids.web.channel
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether factoids can be displayed via the web server.
@ -169,7 +169,7 @@ supybot.plugins.Factoids.web
supybot.plugins.Factoids.web.enable
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether the Factoids plugins will be browsable on the HTTP server.

10
plugins/Fediverse/README.rst
View File

@ -81,7 +81,7 @@ supybot.plugins.Fediverse.format
supybot.plugins.Fediverse.format.statuses.showContentWithCW
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the content of a status will be shown when the status has a Content Warning.
@ -89,7 +89,7 @@ supybot.plugins.Fediverse.format
supybot.plugins.Fediverse.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -103,7 +103,7 @@ supybot.plugins.Fediverse.snarfers
supybot.plugins.Fediverse.snarfers.profile
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will output the profile of URLs to Fediverse accounts it sees in channel messages.
@ -111,7 +111,7 @@ supybot.plugins.Fediverse.snarfers
supybot.plugins.Fediverse.snarfers.status
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will output the content of statuses whose URLs it sees in channel messages.
@ -119,7 +119,7 @@ supybot.plugins.Fediverse.snarfers
supybot.plugins.Fediverse.snarfers.username
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will output the profile of @username@hostname accounts it sees in channel messages.

10
plugins/Filter/README.rst
View File

@ -183,7 +183,7 @@ Configuration
supybot.plugins.Filter.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -197,7 +197,7 @@ supybot.plugins.Filter.shrink
supybot.plugins.Filter.shrink.minimum
This config variable defaults to "4", is network-specific, and is channel-specific.
This config variable defaults to "4", is network-specific, and is channel-specific.
Determines the minimum number of a letters in a word before it will be shrunken by the shrink command/filter.
@ -211,7 +211,7 @@ supybot.plugins.Filter.spellit
supybot.plugins.Filter.spellit.replaceLetters
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether or not to replace letters in the output of spellit.
@ -219,7 +219,7 @@ supybot.plugins.Filter.spellit
supybot.plugins.Filter.spellit.replaceNumbers
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether or not to replace numbers in the output of spellit.
@ -227,7 +227,7 @@ supybot.plugins.Filter.spellit
supybot.plugins.Filter.spellit.replacePunctuation
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether or not to replace punctuation in the output of spellit.

2
plugins/Format/README.rst
View File

@ -111,7 +111,7 @@ Configuration
supybot.plugins.Format.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/GPG/README.rst
View File

@ -64,7 +64,7 @@ supybot.plugins.GPG.auth
supybot.plugins.GPG.auth.sign.TokenTimeout
This config variable defaults to "600", is not network-specific, and is not channel-specific.
This config variable defaults to "600", is not network-specific, and is not channel-specific.
Determines the lifetime of a GPG signature authentication token (in seconds).
@ -72,7 +72,7 @@ supybot.plugins.GPG.auth
supybot.plugins.GPG.auth.sign.enable
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether or not users are allowed to use GPG signing for authentication.
@ -80,7 +80,7 @@ supybot.plugins.GPG.auth
supybot.plugins.GPG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Games/README.rst
View File

@ -55,7 +55,7 @@ Configuration
supybot.plugins.Games.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

20
plugins/Google/README.rst
View File

@ -87,7 +87,7 @@ Configuration
supybot.plugins.Google.baseUrl
This config variable defaults to "google.com", is network-specific, and is channel-specific.
This config variable defaults to "google.com", is network-specific, and is channel-specific.
Determines the base URL used for requests.
@ -95,7 +95,7 @@ supybot.plugins.Google.baseUrl
supybot.plugins.Google.bold
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether results are bolded.
@ -103,7 +103,7 @@ supybot.plugins.Google.bold
supybot.plugins.Google.colorfulFilter
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the word 'google' in the bot's output will be made colorful (like Google's logo).
@ -111,7 +111,7 @@ supybot.plugins.Google.colorfulFilter
supybot.plugins.Google.defaultLanguage
This config variable defaults to "lang_en", is network-specific, and is channel-specific.
This config variable defaults to "lang_en", is network-specific, and is channel-specific.
Determines what default language is used in searches. If left empty, no specific language will be requested. Valid strings: lang_af, lang_sq, lang_am, lang_ar, lang_hy, lang_az, lang_eu, lang_be, lang_bn, lang_bg, lang_my, lang_ca, lang_zh, lang_zh-CN, lang_zh-TW, lang_hr, lang_cs, lang_da, lang_dv, lang_nl, lang_en, lang_eo, lang_et, lang_tl, lang_fi, lang_fr, lang_gl, lang_ka, lang_de, lang_el, lang_gu, lang_iw, lang_hi, lang_hu, lang_is, lang_id, lang_iu, lang_it, lang_ja, lang_kn, lang_kk, lang_km, lang_ko, lang_ku, lang_ky, lang_lo, lang_lv, lang_lt, lang_mk, lang_ms, lang_ml, lang_mt, lang_mr, lang_mn, lang_ne, lang_no, lang_or, lang_ps, lang_fa, lang_pl, lang_pt-PT, lang_pa, lang_ro, lang_ru, lang_sa, lang_sr, lang_sd, lang_si, lang_sk, lang_sl, lang_es, lang_sv, lang_tg, lang_ta, lang_tl, lang_te, lang_th, lang_bo, lang_tr, lang_uk, lang_ur, lang_uz, lang_ug, lang_vi, and lang_auto.
@ -119,7 +119,7 @@ supybot.plugins.Google.defaultLanguage
supybot.plugins.Google.maximumResults
This config variable defaults to "3", is network-specific, and is channel-specific.
This config variable defaults to "3", is network-specific, and is channel-specific.
Determines the maximum number of results returned from the google command.
@ -127,7 +127,7 @@ supybot.plugins.Google.maximumResults
supybot.plugins.Google.oneToOne
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether results are sent in different lines or all in the same one.
@ -135,7 +135,7 @@ supybot.plugins.Google.oneToOne
supybot.plugins.Google.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -143,7 +143,7 @@ supybot.plugins.Google.public
supybot.plugins.Google.referer
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
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
@ -151,7 +151,7 @@ supybot.plugins.Google.referer
supybot.plugins.Google.searchFilter
This config variable defaults to "moderate", is network-specific, and is channel-specific.
This config variable defaults to "moderate", is network-specific, and is channel-specific.
Determines what level of search filtering to use by default. 'active' - most filtering, 'moderate' - default filtering, 'off' - no filtering Valid strings: active, moderate, and off.
@ -159,7 +159,7 @@ supybot.plugins.Google.searchFilter
supybot.plugins.Google.searchSnarfer
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
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.

2
plugins/Hashes/README.rst
View File

@ -57,7 +57,7 @@ Configuration
supybot.plugins.Hashes.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

18
plugins/Herald/README.rst
View File

@ -54,7 +54,7 @@ Configuration
supybot.plugins.Herald.default
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
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.
@ -62,7 +62,7 @@ supybot.plugins.Herald.default
supybot.plugins.Herald.default.notice
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the default herald will be sent as a NOTICE instead of a PRIVMSG.
@ -70,7 +70,7 @@ supybot.plugins.Herald.default
supybot.plugins.Herald.default.public
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the default herald will be sent publicly.
@ -78,7 +78,7 @@ supybot.plugins.Herald.default
supybot.plugins.Herald.heralding
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether messages will be sent to the channel when a recognized user joins; basically enables or disables the plugin.
@ -86,7 +86,7 @@ supybot.plugins.Herald.heralding
supybot.plugins.Herald.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -94,7 +94,7 @@ supybot.plugins.Herald.public
supybot.plugins.Herald.requireCapability
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what capability (if any) is required to add/change/remove the herald of another user.
@ -102,7 +102,7 @@ supybot.plugins.Herald.requireCapability
supybot.plugins.Herald.throttle
This config variable defaults to "600", is network-specific, and is channel-specific.
This config variable defaults to "600", is network-specific, and is channel-specific.
Determines the minimum number of seconds between heralds.
@ -110,7 +110,7 @@ supybot.plugins.Herald.throttle
supybot.plugins.Herald.throttle.afterPart
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.
Determines the minimum number of seconds after parting that the bot will not herald the person when they rejoin.
@ -118,7 +118,7 @@ supybot.plugins.Herald.throttle
supybot.plugins.Herald.throttle.afterSplit
This config variable defaults to "60", is network-specific, and is channel-specific.
This config variable defaults to "60", is network-specific, and is channel-specific.
Determines the minimum number of seconds after a netsplit that the bot will not herald the users that split.

2
plugins/Internet/README.rst
View File

@ -44,7 +44,7 @@ Configuration
supybot.plugins.Internet.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

20
plugins/Karma/README.rst
View File

@ -65,7 +65,7 @@ Configuration
supybot.plugins.Karma.allowSelfRating
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether users can adjust the karma of their nick.
@ -73,7 +73,7 @@ supybot.plugins.Karma.allowSelfRating
supybot.plugins.Karma.allowUnaddressedKarma
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will increase/decrease karma without being addressed.
@ -81,7 +81,7 @@ supybot.plugins.Karma.allowUnaddressedKarma
supybot.plugins.Karma.decrementChars
This config variable defaults to "--", is network-specific, and is channel-specific.
This config variable defaults to "--", is network-specific, and is channel-specific.
A space separated list of characters to decrease karma.
@ -89,7 +89,7 @@ supybot.plugins.Karma.decrementChars
supybot.plugins.Karma.incrementChars
This config variable defaults to "++", is network-specific, and is channel-specific.
This config variable defaults to "++", is network-specific, and is channel-specific.
A space separated list of characters to increase karma.
@ -97,7 +97,7 @@ supybot.plugins.Karma.incrementChars
supybot.plugins.Karma.mostDisplay
This config variable defaults to "25", is network-specific, and is channel-specific.
This config variable defaults to "25", is network-specific, and is channel-specific.
Determines how many karma things are shown when the most command is called.
@ -105,7 +105,7 @@ supybot.plugins.Karma.mostDisplay
supybot.plugins.Karma.onlyNicks
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will only increase/decrease karma for nicks in the current channel.
@ -113,7 +113,7 @@ supybot.plugins.Karma.onlyNicks
supybot.plugins.Karma.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -121,7 +121,7 @@ supybot.plugins.Karma.public
supybot.plugins.Karma.rankingDisplay
This config variable defaults to "3", is network-specific, and is channel-specific.
This config variable defaults to "3", is network-specific, and is channel-specific.
Determines how many highest/lowest karma things are shown when karma is called with no arguments.
@ -129,7 +129,7 @@ supybot.plugins.Karma.rankingDisplay
supybot.plugins.Karma.response
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will reply with a success message when something's karma is increased or decreased.
@ -137,7 +137,7 @@ supybot.plugins.Karma.response
supybot.plugins.Karma.simpleOutput
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma.

4
plugins/Lart/README.rst
View File

@ -70,7 +70,7 @@ Configuration
supybot.plugins.Lart.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -78,7 +78,7 @@ supybot.plugins.Lart.public
supybot.plugins.Lart.showIds
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will show the ids of a lart when the lart is given.

12
plugins/Later/README.rst
View File

@ -81,7 +81,7 @@ supybot.plugins.Later.format
supybot.plugins.Later.format.senderHostname
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether senders' hostname will be shown in messages (instead of just the nick).
@ -89,7 +89,7 @@ supybot.plugins.Later.format
supybot.plugins.Later.maximum
This config variable defaults to "0", is not network-specific, and is not channel-specific.
This config variable defaults to "0", is not network-specific, and is not channel-specific.
Determines the maximum number of messages to be queued for a user. If this value is 0, there is no maximum.
@ -97,7 +97,7 @@ supybot.plugins.Later.maximum
supybot.plugins.Later.messageExpiry
This config variable defaults to "30", is not network-specific, and is not channel-specific.
This config variable defaults to "30", is not network-specific, and is not channel-specific.
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.
@ -105,7 +105,7 @@ supybot.plugins.Later.messageExpiry
supybot.plugins.Later.private
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users will be notified in the first place in which they're seen, or in private.
@ -113,7 +113,7 @@ supybot.plugins.Later.private
supybot.plugins.Later.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -121,7 +121,7 @@ supybot.plugins.Later.public
supybot.plugins.Later.tellOnJoin
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users will be notified upon joining any channel the bot is in, or only upon sending a message.

8
plugins/Limiter/README.rst
View File

@ -29,7 +29,7 @@ Configuration
supybot.plugins.Limiter.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
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.
@ -37,7 +37,7 @@ supybot.plugins.Limiter.enable
supybot.plugins.Limiter.maximumExcess
This config variable defaults to "10", is network-specific, and is channel-specific.
This config variable defaults to "10", is network-specific, and is channel-specific.
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.
@ -45,7 +45,7 @@ supybot.plugins.Limiter.maximumExcess
supybot.plugins.Limiter.minimumExcess
This config variable defaults to "5", is network-specific, and is channel-specific.
This config variable defaults to "5", is network-specific, and is channel-specific.
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.
@ -53,7 +53,7 @@ supybot.plugins.Limiter.minimumExcess
supybot.plugins.Limiter.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

16
plugins/LogToIrc/README.rst
View File

@ -17,7 +17,7 @@ Configuration
supybot.plugins.LogToIrc.channelModesRequired
This config variable defaults to "s", is network-specific, and is not channel-specific.
This config variable defaults to "s", is network-specific, and is not channel-specific.
Determines what channel modes a channel will be required to have for the bot to log to the channel. If this string is empty, no modes will be checked.
@ -25,7 +25,7 @@ supybot.plugins.LogToIrc.channelModesRequired
supybot.plugins.LogToIrc.color
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot's logs to IRC will be colorized with mIRC colors.
@ -33,7 +33,7 @@ supybot.plugins.LogToIrc.color
supybot.plugins.LogToIrc.level
This config variable defaults to "WARNING", is network-specific, and is channel-specific.
This config variable defaults to "WARNING", is network-specific, and is channel-specific.
Determines what the minimum priority level logged will be to IRC. See supybot.log.level for possible values. DEBUG is disabled due to the large quantity of output.
@ -41,7 +41,7 @@ supybot.plugins.LogToIrc.level
supybot.plugins.LogToIrc.networks
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Determines what networks the bot should log to. If no networks are set, the bot will log on one network (whichever happens to be around at the time it feels like logging).
@ -49,7 +49,7 @@ supybot.plugins.LogToIrc.networks
supybot.plugins.LogToIrc.notice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot's logs to IRC will be sent via NOTICE instead of PRIVMSG. Channels will always be PRIVMSGed, regardless of this variable; NOTICEs will only be used if this variable is True and the target is a nick, not a channel.
@ -57,7 +57,7 @@ supybot.plugins.LogToIrc.notice
supybot.plugins.LogToIrc.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -65,7 +65,7 @@ supybot.plugins.LogToIrc.public
supybot.plugins.LogToIrc.targets
This config variable defaults to " ", is network-specific, and is not channel-specific.
This config variable defaults to " ", is network-specific, and is not channel-specific.
Space-separated list of channels/nicks the bot should log to. If no channels/nicks are set, this plugin will effectively be turned off.
@ -73,7 +73,7 @@ supybot.plugins.LogToIrc.targets
supybot.plugins.LogToIrc.userCapabilityRequired
This config variable defaults to "owner", is not network-specific, and is not channel-specific.
This config variable defaults to "owner", is not network-specific, and is not channel-specific.
Determines what capability is required for the bot to log to in private messages to the user. If this is empty, there will be no capability that's checked.

2
plugins/Math/README.rst
View File

@ -59,7 +59,7 @@ Configuration
supybot.plugins.Math.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

18
plugins/MessageParser/README.rst
View File

@ -79,7 +79,7 @@ Configuration
supybot.plugins.MessageParser.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the message parser is enabled. If enabled, will trigger on regexps added to the regexp db.
@ -87,7 +87,7 @@ supybot.plugins.MessageParser.enable
supybot.plugins.MessageParser.enableForNotices
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the message parser is enabled for NOTICE messages too.
@ -95,7 +95,7 @@ supybot.plugins.MessageParser.enableForNotices
supybot.plugins.MessageParser.keepRankInfo
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether we keep updating the usage count for each regexp, for popularity ranking.
@ -103,7 +103,7 @@ supybot.plugins.MessageParser.keepRankInfo
supybot.plugins.MessageParser.listSeparator
This config variable defaults to ", ", is network-specific, and is channel-specific.
This config variable defaults to ", ", is network-specific, and is channel-specific.
Determines the separator used between regexps when shown by the list command.
@ -111,7 +111,7 @@ supybot.plugins.MessageParser.listSeparator
supybot.plugins.MessageParser.maxTriggers
This config variable defaults to "0", is network-specific, and is channel-specific.
This config variable defaults to "0", is network-specific, and is channel-specific.
Determines the maximum number of triggers in one message. Set this to 0 to allow an infinite number of triggers.
@ -119,7 +119,7 @@ supybot.plugins.MessageParser.maxTriggers
supybot.plugins.MessageParser.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -127,7 +127,7 @@ supybot.plugins.MessageParser.public
supybot.plugins.MessageParser.rankListLength
This config variable defaults to "20", is network-specific, and is channel-specific.
This config variable defaults to "20", is network-specific, and is channel-specific.
Determines the number of regexps returned by the triggerrank command.
@ -135,7 +135,7 @@ supybot.plugins.MessageParser.rankListLength
supybot.plugins.MessageParser.requireManageCapability
This config variable defaults to "admin; channel,op", is network-specific, and is channel-specific.
This config variable defaults to "admin; channel,op", is network-specific, and is channel-specific.
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.
@ -143,7 +143,7 @@ supybot.plugins.MessageParser.requireManageCapability
supybot.plugins.MessageParser.requireVacuumCapability
This config variable defaults to "admin", is network-specific, and is channel-specific.
This config variable defaults to "admin", is network-specific, and is channel-specific.
Determines the capability required (if any) to vacuum the database.

16
plugins/Misc/README.rst
View File

@ -88,7 +88,7 @@ Configuration
supybot.plugins.Misc.customHelpString
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Sets a custom help string, displayed when the 'help' command is called without arguments.
@ -108,7 +108,7 @@ supybot.plugins.Misc.last
supybot.plugins.Misc.last.nested.includeNick
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether or not the nick will be included in the output of last when it is part of a nested command
@ -116,7 +116,7 @@ supybot.plugins.Misc.last
supybot.plugins.Misc.last.nested.includeTimestamp
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether or not the timestamp will be included in the output of last when it is part of a nested command
@ -124,7 +124,7 @@ supybot.plugins.Misc.last
supybot.plugins.Misc.listPrivatePlugins
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
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.
@ -132,7 +132,7 @@ supybot.plugins.Misc.listPrivatePlugins
supybot.plugins.Misc.listUnloadedPlugins
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
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.
@ -140,7 +140,7 @@ supybot.plugins.Misc.listUnloadedPlugins
supybot.plugins.Misc.mores
This config variable defaults to "1", is network-specific, and is channel-specific.
This config variable defaults to "1", is network-specific, and is channel-specific.
Determines how many messages the bot will issue when using the 'more' command.
@ -148,7 +148,7 @@ supybot.plugins.Misc.mores
supybot.plugins.Misc.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -156,7 +156,7 @@ supybot.plugins.Misc.public
supybot.plugins.Misc.timestampFormat
This config variable defaults to "[%H:%M:%S]", is not network-specific, and is not channel-specific.
This config variable defaults to "[%H:%M:%S]", is not network-specific, and is not channel-specific.
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.

6
plugins/MoobotFactoids/README.rst
View File

@ -91,7 +91,7 @@ Configuration
supybot.plugins.MoobotFactoids.mostCount
This config variable defaults to "10", is network-specific, and is channel-specific.
This config variable defaults to "10", is network-specific, and is channel-specific.
Determines how many items are shown when the 'most' command is called.
@ -99,7 +99,7 @@ supybot.plugins.MoobotFactoids.mostCount
supybot.plugins.MoobotFactoids.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -107,7 +107,7 @@ supybot.plugins.MoobotFactoids.public
supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether or not the factoid value will be shown when a listkeys search returns only one factoid key.

2
plugins/Network/README.rst
View File

@ -90,7 +90,7 @@ Configuration
supybot.plugins.Network.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/News/README.rst
View File

@ -54,7 +54,7 @@ Configuration
supybot.plugins.News.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/NickAuth/README.rst
View File

@ -52,7 +52,7 @@ Configuration
supybot.plugins.NickAuth.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/NickCapture/README.rst
View File

@ -25,7 +25,7 @@ Configuration
supybot.plugins.NickCapture.ison
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command.
@ -33,7 +33,7 @@ supybot.plugins.NickCapture.ison
supybot.plugins.NickCapture.ison.period
This config variable defaults to "600", is not network-specific, and is not channel-specific.
This config variable defaults to "600", is not network-specific, and is not channel-specific.
Determines how often (in seconds) the bot will check whether its nick ISON.
@ -41,7 +41,7 @@ supybot.plugins.NickCapture.ison
supybot.plugins.NickCapture.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Nickometer/README.rst
View File

@ -34,7 +34,7 @@ Configuration
supybot.plugins.Nickometer.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

8
plugins/Note/README.rst
View File

@ -69,7 +69,7 @@ supybot.plugins.Note.notify
supybot.plugins.Note.notify.autoSend
This config variable defaults to "0", is not network-specific, and is not channel-specific.
This config variable defaults to "0", is not network-specific, and is not channel-specific.
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.
@ -77,7 +77,7 @@ supybot.plugins.Note.notify
supybot.plugins.Note.notify.onJoin
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
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.
@ -85,7 +85,7 @@ supybot.plugins.Note.notify
supybot.plugins.Note.notify.onJoin.repeatedly
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
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.
@ -93,7 +93,7 @@ supybot.plugins.Note.notify
supybot.plugins.Note.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/Owner/README.rst
View File

@ -109,7 +109,7 @@ Configuration
supybot.plugins.Owner.announceFormat
This config variable defaults to "Announcement from my owner ($owner): $text", is not network-specific, and is not channel-specific.
This config variable defaults to "Announcement from my owner ($owner): $text", is not network-specific, and is not channel-specific.
Determines the format of messages sent by the 'announce' command. $owner may be used for the username of the owner calling this command, and $text for the announcement being made.
@ -117,7 +117,7 @@ supybot.plugins.Owner.announceFormat
supybot.plugins.Owner.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -125,7 +125,7 @@ supybot.plugins.Owner.public
supybot.plugins.Owner.quitMsg
This config variable defaults to "Limnoria $version", is not network-specific, and is not channel-specific.
This config variable defaults to "Limnoria $version", is not network-specific, and is not channel-specific.
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. The standard substitutions ($version, $nick, etc.) are all handled appropriately.

2
plugins/Plugin/README.rst
View File

@ -56,7 +56,7 @@ Configuration
supybot.plugins.Plugin.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/PluginDownloader/README.rst
View File

@ -80,7 +80,7 @@ Configuration
supybot.plugins.PluginDownloader.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

4
plugins/Poll/README.rst
View File

@ -80,7 +80,7 @@ Configuration
supybot.plugins.Poll.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -88,7 +88,7 @@ supybot.plugins.Poll.public
supybot.plugins.Poll.requireManageCapability
This config variable defaults to "channel,op; channel,halfop", is network-specific, and is channel-specific.
This config variable defaults to "channel,op; channel,halfop", is network-specific, and is channel-specific.
Determines the capabilities required (if any) to open and close polls. Use 'channel,capab' for channel-level capabilities. Note that absence of an explicit anticapability means user has capability.

4
plugins/Praise/README.rst
View File

@ -71,7 +71,7 @@ Configuration
supybot.plugins.Praise.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -79,7 +79,7 @@ supybot.plugins.Praise.public
supybot.plugins.Praise.showIds
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will show the ids of a praise when the praise is given.

6
plugins/Protector/README.rst
View File

@ -24,7 +24,7 @@ Configuration
supybot.plugins.Protector.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether this plugin is enabled in a given channel.
@ -32,7 +32,7 @@ supybot.plugins.Protector.enable
supybot.plugins.Protector.immune
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list.
@ -40,7 +40,7 @@ supybot.plugins.Protector.immune
supybot.plugins.Protector.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Quote/README.rst
View File

@ -67,7 +67,7 @@ Configuration
supybot.plugins.Quote.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

10
plugins/QuoteGrabs/README.rst
View File

@ -72,7 +72,7 @@ Configuration
supybot.plugins.QuoteGrabs.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -80,7 +80,7 @@ supybot.plugins.QuoteGrabs.public
supybot.plugins.QuoteGrabs.randomGrabber
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will randomly grab possibly-suitable quotes on occasion. The suitability of a given message is determined by ...
@ -88,7 +88,7 @@ supybot.plugins.QuoteGrabs.randomGrabber
supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs
This config variable defaults to "864000", is network-specific, and is channel-specific.
This config variable defaults to "864000", is network-specific, and is channel-specific.
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.
@ -96,7 +96,7 @@ supybot.plugins.QuoteGrabs.randomGrabber
supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters
This config variable defaults to "8", is network-specific, and is channel-specific.
This config variable defaults to "8", is network-specific, and is channel-specific.
Determines the minimum number of characters in a message for it to be considered for random grabbing.
@ -104,7 +104,7 @@ supybot.plugins.QuoteGrabs.randomGrabber
supybot.plugins.QuoteGrabs.randomGrabber.minimumWords
This config variable defaults to "3", is network-specific, and is channel-specific.
This config variable defaults to "3", is network-specific, and is channel-specific.
Determines the minimum number of words in a message for it to be considered for random grabbing.

28
plugins/RSS/README.rst
View File

@ -106,7 +106,7 @@ Configuration
supybot.plugins.RSS.announce
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
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.
@ -114,7 +114,7 @@ supybot.plugins.RSS.announce
supybot.plugins.RSS.announceFormat
This config variable defaults to "News from $feed_name: $title <$link>", is network-specific, and is channel-specific.
This config variable defaults to "News from $feed_name: $title <$link>", is network-specific, and is channel-specific.
The format the bot will use for displaying headlines of a RSS feed that is announced. See supybot.plugins.RSS.format for the available variables.
@ -122,7 +122,7 @@ supybot.plugins.RSS.announceFormat
supybot.plugins.RSS.defaultNumberOfHeadlines
This config variable defaults to "1", is network-specific, and is channel-specific.
This config variable defaults to "1", is network-specific, and is channel-specific.
Indicates how many headlines an rss feed will output by default, if no number is provided.
@ -130,7 +130,7 @@ supybot.plugins.RSS.defaultNumberOfHeadlines
supybot.plugins.RSS.feeds
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Determines what feeds should be accessible as commands.
@ -138,7 +138,7 @@ supybot.plugins.RSS.feeds
supybot.plugins.RSS.format
This config variable defaults to "$date: $title <$link>", is network-specific, and is channel-specific.
This config variable defaults to "$date: $title <$link>", is network-specific, and is channel-specific.
The format the bot will use for displaying headlines of a RSS feed that is triggered manually. In addition to fields defined by feedparser ($published (the entry date), $title, $link, $description, $id, etc.), the following variables can be used: $feed_name, $date (parsed date, as defined in supybot.reply.format.time)
@ -146,7 +146,7 @@ supybot.plugins.RSS.format
supybot.plugins.RSS.headlineSeparator
This config variable defaults to " | ", is network-specific, and is channel-specific.
This config variable defaults to " | ", is network-specific, and is channel-specific.
Determines what string is used to separate headlines in new feeds.
@ -154,7 +154,7 @@ supybot.plugins.RSS.headlineSeparator
supybot.plugins.RSS.initialAnnounceHeadlines
This config variable defaults to "5", is network-specific, and is channel-specific.
This config variable defaults to "5", is network-specific, and is channel-specific.
Indicates how many headlines an rss feed will output when it is first added to announce for a channel.
@ -162,7 +162,7 @@ supybot.plugins.RSS.initialAnnounceHeadlines
supybot.plugins.RSS.keywordBlacklist
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist.
@ -170,7 +170,7 @@ supybot.plugins.RSS.keywordBlacklist
supybot.plugins.RSS.keywordWhitelist
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist.
@ -178,7 +178,7 @@ supybot.plugins.RSS.keywordWhitelist
supybot.plugins.RSS.maximumAnnounceHeadlines
This config variable defaults to "5", is network-specific, and is channel-specific.
This config variable defaults to "5", is network-specific, and is channel-specific.
Indicates how many new news entries may be sent at the same time. Extra entries will be discarded.
@ -186,7 +186,7 @@ supybot.plugins.RSS.maximumAnnounceHeadlines
supybot.plugins.RSS.notice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether announces will be sent as notices instead of privmsgs.
@ -194,7 +194,7 @@ supybot.plugins.RSS.notice
supybot.plugins.RSS.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -202,7 +202,7 @@ supybot.plugins.RSS.public
supybot.plugins.RSS.sortFeedItems
This config variable defaults to "asInFeed", is not network-specific, and is not channel-specific.
This config variable defaults to "asInFeed", is not network-specific, and is not channel-specific.
Determines whether feed items should be sorted by their publication/update timestamp or kept in the same order as they appear in a feed. Valid strings: asInFeed, oldestFirst, newestFirst, outdatedFirst, and updatedFirst.
@ -210,7 +210,7 @@ supybot.plugins.RSS.sortFeedItems
supybot.plugins.RSS.waitPeriod
This config variable defaults to "1800", is not network-specific, and is not channel-specific.
This config variable defaults to "1800", is not network-specific, and is not channel-specific.
Indicates how many seconds the bot will wait between retrieving RSS feeds; requests made within this period will return cached results.

20
plugins/Relay/README.rst
View File

@ -51,7 +51,7 @@ Configuration
supybot.plugins.Relay.channels
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Determines which channels the bot will relay in.
@ -59,7 +59,7 @@ supybot.plugins.Relay.channels
supybot.plugins.Relay.channels.joinOnAllNetworks
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will always join the channel(s) it relays when connecting to any network.
@ -67,7 +67,7 @@ supybot.plugins.Relay.channels
supybot.plugins.Relay.color
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read.
@ -75,7 +75,7 @@ supybot.plugins.Relay.color
supybot.plugins.Relay.hostmasks
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will relay the hostmask of the person joining or parting the channel when they join or part.
@ -83,7 +83,7 @@ supybot.plugins.Relay.hostmasks
supybot.plugins.Relay.ignores
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
Determines what hostmasks will not be relayed on a channel.
@ -91,7 +91,7 @@ supybot.plugins.Relay.ignores
supybot.plugins.Relay.includeNetwork
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines 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.
@ -99,7 +99,7 @@ supybot.plugins.Relay.includeNetwork
supybot.plugins.Relay.noticeNonPrivmsgs
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.)
@ -107,7 +107,7 @@ supybot.plugins.Relay.noticeNonPrivmsgs
supybot.plugins.Relay.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -115,7 +115,7 @@ supybot.plugins.Relay.public
supybot.plugins.Relay.punishOtherRelayBots
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will detect other bots relaying and respond by kickbanning them.
@ -123,7 +123,7 @@ supybot.plugins.Relay.punishOtherRelayBots
supybot.plugins.Relay.topicSync
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will synchronize topics between networks in the channels it relays.

2
plugins/Reply/README.rst
View File

@ -55,7 +55,7 @@ Configuration
supybot.plugins.Reply.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Scheduler/README.rst
View File

@ -55,7 +55,7 @@ Configuration
supybot.plugins.Scheduler.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

12
plugins/SedRegex/README.rst
View File

@ -47,7 +47,7 @@ Configuration
supybot.plugins.SedRegex.boldReplacementText
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Should the replacement text be bolded?
@ -55,7 +55,7 @@ supybot.plugins.SedRegex.boldReplacementText
supybot.plugins.SedRegex.displayErrors
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Should errors be displayed?
@ -63,7 +63,7 @@ supybot.plugins.SedRegex.displayErrors
supybot.plugins.SedRegex.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Should Perl/sed-style regex replacing work in this channel?
@ -71,7 +71,7 @@ supybot.plugins.SedRegex.enable
supybot.plugins.SedRegex.ignoreRegex
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Should Perl/sed regex replacing ignore messages which look like valid regex?
@ -79,7 +79,7 @@ supybot.plugins.SedRegex.ignoreRegex
supybot.plugins.SedRegex.processTimeout
This config variable defaults to "0.5", is not network-specific, and is not channel-specific.
This config variable defaults to "0.5", is not network-specific, and is not channel-specific.
Sets the timeout when processing a single regexp. The default should be adequate unless you have a busy or low-powered system that cannot process regexps quickly enough. However, you will not want to set this value too high as that would make your bot vulnerable to ReDoS attacks.
@ -87,7 +87,7 @@ supybot.plugins.SedRegex.processTimeout
supybot.plugins.SedRegex.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/Seen/README.rst
View File

@ -55,7 +55,7 @@ Configuration
supybot.plugins.Seen.minimumNonWildcard
This config variable defaults to "2", is network-specific, and is channel-specific.
This config variable defaults to "2", is network-specific, and is channel-specific.
The minimum non-wildcard characters required to perform a 'seen' request. Of course, it only applies if there is a wildcard in the request.
@ -63,7 +63,7 @@ supybot.plugins.Seen.minimumNonWildcard
supybot.plugins.Seen.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -71,7 +71,7 @@ supybot.plugins.Seen.public
supybot.plugins.Seen.showLastMessage
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the last message will be displayed with @seen. Useful for keeping messages from a channel private.

22
plugins/Services/README.rst
View File

@ -95,7 +95,7 @@ Configuration
supybot.plugins.Services.ChanServ
This config variable defaults to "ChanServ", is network-specific, and is not channel-specific.
This config variable defaults to "ChanServ", is network-specific, and is not channel-specific.
Determines what nick the 'ChanServ' service has.
@ -103,7 +103,7 @@ supybot.plugins.Services.ChanServ
supybot.plugins.Services.ChanServ.halfop
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will request to get half-opped by the ChanServ when it joins the channel.
@ -111,7 +111,7 @@ supybot.plugins.Services.ChanServ
supybot.plugins.Services.ChanServ.op
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will request to get opped by the ChanServ when it joins the channel.
@ -119,7 +119,7 @@ supybot.plugins.Services.ChanServ
supybot.plugins.Services.ChanServ.password
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
Determines what password the bot will use with ChanServ.
@ -127,7 +127,7 @@ supybot.plugins.Services.ChanServ
supybot.plugins.Services.ChanServ.voice
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will request to get voiced by the ChanServ when it joins the channel.
@ -135,7 +135,7 @@ supybot.plugins.Services.ChanServ
supybot.plugins.Services.NickServ
This config variable defaults to "NickServ", is network-specific, and is not channel-specific.
This config variable defaults to "NickServ", is network-specific, and is not channel-specific.
Determines what nick the 'NickServ' service has.
@ -149,7 +149,7 @@ supybot.plugins.Services.NickServ
supybot.plugins.Services.disabledNetworks
This config variable defaults to "QuakeNet", is not network-specific, and is not channel-specific.
This config variable defaults to "QuakeNet", is not network-specific, and is not channel-specific.
Determines what networks this plugin will be disabled on.
@ -157,7 +157,7 @@ supybot.plugins.Services.disabledNetworks
supybot.plugins.Services.ghostDelay
This config variable defaults to "60", is network-specific, and is not channel-specific.
This config variable defaults to "60", is network-specific, and is not channel-specific.
Determines how many seconds the bot will wait between successive GHOST attempts. Set this to 0 to disable GHOST.
@ -165,7 +165,7 @@ supybot.plugins.Services.ghostDelay
supybot.plugins.Services.nicks
This config variable defaults to " ", is network-specific, and is not channel-specific.
This config variable defaults to " ", is network-specific, and is not channel-specific.
Determines what nicks the bot will use with services.
@ -173,7 +173,7 @@ supybot.plugins.Services.nicks
supybot.plugins.Services.noJoinsUntilIdentified
This config variable defaults to "False", is network-specific, and is not channel-specific.
This config variable defaults to "False", is network-specific, and is not channel-specific.
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.
@ -181,7 +181,7 @@ supybot.plugins.Services.noJoinsUntilIdentified
supybot.plugins.Services.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

18
plugins/ShrinkUrl/README.rst
View File

@ -43,7 +43,7 @@ Configuration
supybot.plugins.ShrinkUrl.bold
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin will bold certain portions of its replies.
@ -51,7 +51,7 @@ supybot.plugins.ShrinkUrl.bold
supybot.plugins.ShrinkUrl.default
This config variable defaults to "x0", is network-specific, and is channel-specific.
This config variable defaults to "x0", is network-specific, and is channel-specific.
Determines what website the bot will use when shrinking a URL. Valid strings: tiny, ur1, and x0.
@ -59,7 +59,7 @@ supybot.plugins.ShrinkUrl.default
supybot.plugins.ShrinkUrl.minimumLength
This config variable defaults to "48", is network-specific, and is channel-specific.
This config variable defaults to "48", is network-specific, and is channel-specific.
The minimum length a URL must be before the bot will shrink it.
@ -67,7 +67,7 @@ supybot.plugins.ShrinkUrl.minimumLength
supybot.plugins.ShrinkUrl.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
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.
@ -75,7 +75,7 @@ supybot.plugins.ShrinkUrl.nonSnarfingRegexp
supybot.plugins.ShrinkUrl.outFilter
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will shrink the URLs of outgoing messages if those URLs are longer than supybot.plugins.ShrinkUrl.minimumLength.
@ -83,7 +83,7 @@ supybot.plugins.ShrinkUrl.outFilter
supybot.plugins.ShrinkUrl.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -91,7 +91,7 @@ supybot.plugins.ShrinkUrl.public
supybot.plugins.ShrinkUrl.serviceRotation
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
If set to a non-empty value, specifies the list of services to rotate through for the shrinkSnarfer and outFilter.
@ -99,7 +99,7 @@ supybot.plugins.ShrinkUrl.serviceRotation
supybot.plugins.ShrinkUrl.shrinkSnarfer
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
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 the service as denoted in supybot.plugins.ShrinkUrl.default.
@ -107,7 +107,7 @@ supybot.plugins.ShrinkUrl.shrinkSnarfer
supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the snarfer will show the domain of the URL being snarfed along with the shrunken URL.

8
plugins/Status/README.rst
View File

@ -85,7 +85,7 @@ supybot.plugins.Status.cpu
supybot.plugins.Status.cpu.children
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the cpu command will list the time taken by children as well as the bot's process.
@ -93,7 +93,7 @@ supybot.plugins.Status.cpu
supybot.plugins.Status.cpu.memory
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the cpu command will report the amount of memory being used by the bot.
@ -101,7 +101,7 @@ supybot.plugins.Status.cpu
supybot.plugins.Status.cpu.threads
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the cpu command will provide the number of threads spawned and active.
@ -109,7 +109,7 @@ supybot.plugins.Status.cpu
supybot.plugins.Status.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

6
plugins/String/README.rst
View File

@ -98,7 +98,7 @@ supybot.plugins.String.levenshtein
supybot.plugins.String.levenshtein.max
This config variable defaults to "256", is not network-specific, and is not channel-specific.
This config variable defaults to "256", is not network-specific, and is not channel-specific.
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.
@ -106,7 +106,7 @@ supybot.plugins.String.levenshtein
supybot.plugins.String.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -120,7 +120,7 @@ supybot.plugins.String.re
supybot.plugins.String.re.timeout
This config variable defaults to "0.1", is not network-specific, and is not channel-specific.
This config variable defaults to "0.1", is not network-specific, and is not channel-specific.
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.

4
plugins/Success/README.rst
View File

@ -63,7 +63,7 @@ Configuration
supybot.plugins.Success.prefixNick
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will prefix the nick of the user giving an invalid command to the success response.
@ -71,7 +71,7 @@ supybot.plugins.Success.prefixNick
supybot.plugins.Success.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

4
plugins/Time/README.rst
View File

@ -67,7 +67,7 @@ Configuration
supybot.plugins.Time.format
This config variable defaults to "%Y-%m-%dT%H:%M:%S%z", is network-specific, and is channel-specific.
This config variable defaults to "%Y-%m-%dT%H:%M:%S%z", is network-specific, and is channel-specific.
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.
@ -75,7 +75,7 @@ supybot.plugins.Time.format
supybot.plugins.Time.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

4
plugins/Todo/README.rst
View File

@ -59,7 +59,7 @@ Configuration
supybot.plugins.Todo.allowThirdpartyReader
This config variable defaults to "False", is not network-specific, and is not channel-specific.
This config variable defaults to "False", is not network-specific, and is not channel-specific.
Determines whether users can read the todo-list of another user.
@ -67,7 +67,7 @@ supybot.plugins.Todo.allowThirdpartyReader
supybot.plugins.Todo.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

20
plugins/Topic/README.rst
View File

@ -138,7 +138,7 @@ Configuration
supybot.plugins.Topic.allowSeparatorinTopics
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will allow topics containing the defined separator to be used. You may want to disable this if you are signing all topics by nick (see the 'format' option for ways to adjust this).
@ -146,7 +146,7 @@ supybot.plugins.Topic.allowSeparatorinTopics
supybot.plugins.Topic.alwaysSetOnJoin
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will set the topic every time it joins, or only if the topic is empty. Requires 'config plugins.topic.setOnJoin' to be set to True.
@ -154,7 +154,7 @@ supybot.plugins.Topic.alwaysSetOnJoin
supybot.plugins.Topic.default
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
Determines what the default topic for the channel is. This is used by the default command to set this topic.
@ -162,7 +162,7 @@ supybot.plugins.Topic.default
supybot.plugins.Topic.format
This config variable defaults to "$topic", is network-specific, and is channel-specific.
This config variable defaults to "$topic", is network-specific, and is channel-specific.
Determines what format is used to add topics in the topic. All the standard substitutes apply, in addition to "$topic" for the topic itself.
@ -170,7 +170,7 @@ supybot.plugins.Topic.format
supybot.plugins.Topic.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -178,7 +178,7 @@ supybot.plugins.Topic.public
supybot.plugins.Topic.recognizeTopiclen
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines 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.
@ -186,7 +186,7 @@ supybot.plugins.Topic.recognizeTopiclen
supybot.plugins.Topic.requireManageCapability
This config variable defaults to "channel,op; channel,halfop", is network-specific, and is channel-specific.
This config variable defaults to "channel,op; channel,halfop", is network-specific, and is channel-specific.
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.
@ -194,7 +194,7 @@ supybot.plugins.Topic.requireManageCapability
supybot.plugins.Topic.separator
This config variable defaults to " | ", is network-specific, and is channel-specific.
This config variable defaults to " | ", is network-specific, and is channel-specific.
Determines what separator is used between individually added topics in the channel topic.
@ -202,7 +202,7 @@ supybot.plugins.Topic.separator
supybot.plugins.Topic.setOnJoin
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the bot will automatically set the topic on join if it is empty.
@ -216,7 +216,7 @@ supybot.plugins.Topic.undo
supybot.plugins.Topic.undo.max
This config variable defaults to "10", is network-specific, and is channel-specific.
This config variable defaults to "10", is network-specific, and is channel-specific.
Determines the number of previous topics to keep around in case the undo command is called.

4
plugins/URL/README.rst
View File

@ -40,7 +40,7 @@ Configuration
supybot.plugins.URL.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
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.
@ -48,7 +48,7 @@ supybot.plugins.URL.nonSnarfingRegexp
supybot.plugins.URL.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

28
plugins/Unix/README.rst
View File

@ -98,7 +98,7 @@ supybot.plugins.Unix.fortune
supybot.plugins.Unix.fortune.command
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what command will be called for the fortune command.
@ -106,7 +106,7 @@ supybot.plugins.Unix.fortune
supybot.plugins.Unix.fortune.equal
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines 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.
@ -114,7 +114,7 @@ supybot.plugins.Unix.fortune
supybot.plugins.Unix.fortune.files
This config variable defaults to " ", is network-specific, and is channel-specific.
This config variable defaults to " ", is network-specific, and is channel-specific.
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.
@ -122,7 +122,7 @@ supybot.plugins.Unix.fortune
supybot.plugins.Unix.fortune.offensive
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether fortune will retrieve offensive fortunes along with the normal fortunes. This sends the -a option to the fortune program.
@ -130,7 +130,7 @@ supybot.plugins.Unix.fortune
supybot.plugins.Unix.fortune.short
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether only short fortunes will be used if possible. This sends the -s option to the fortune program.
@ -144,7 +144,7 @@ supybot.plugins.Unix.ping
supybot.plugins.Unix.ping.command
This config variable defaults to "/bin/ping", is not network-specific, and is not channel-specific.
This config variable defaults to "/bin/ping", is not network-specific, and is not channel-specific.
Determines what command will be called for the ping command.
@ -152,7 +152,7 @@ supybot.plugins.Unix.ping
supybot.plugins.Unix.ping.defaultCount
This config variable defaults to "5", is not network-specific, and is not channel-specific.
This config variable defaults to "5", is not network-specific, and is not channel-specific.
Determines what ping and ping6 counts (-c) will default to.
@ -166,7 +166,7 @@ supybot.plugins.Unix.ping6
supybot.plugins.Unix.ping6.command
This config variable defaults to "/bin/ping6", is not network-specific, and is not channel-specific.
This config variable defaults to "/bin/ping6", is not network-specific, and is not channel-specific.
Determines what command will be called for the ping6 command.
@ -174,7 +174,7 @@ supybot.plugins.Unix.ping6
supybot.plugins.Unix.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -188,7 +188,7 @@ supybot.plugins.Unix.spell
supybot.plugins.Unix.spell.command
This config variable defaults to "/usr/bin/aspell", is not network-specific, and is not channel-specific.
This config variable defaults to "/usr/bin/aspell", is not network-specific, and is not channel-specific.
Determines what command will be called for the spell command.
@ -196,7 +196,7 @@ supybot.plugins.Unix.spell
supybot.plugins.Unix.spell.language
This config variable defaults to "en", is not network-specific, and is not channel-specific.
This config variable defaults to "en", is not network-specific, and is not channel-specific.
Determines what aspell dictionary will be used for spell checking.
@ -210,7 +210,7 @@ supybot.plugins.Unix.sysuname
supybot.plugins.Unix.sysuname.command
This config variable defaults to "/bin/uname", is not network-specific, and is not channel-specific.
This config variable defaults to "/bin/uname", is not network-specific, and is not channel-specific.
Determines what command will be called for the uname command.
@ -224,7 +224,7 @@ supybot.plugins.Unix.sysuptime
supybot.plugins.Unix.sysuptime.command
This config variable defaults to "/usr/bin/uptime", is not network-specific, and is not channel-specific.
This config variable defaults to "/usr/bin/uptime", is not network-specific, and is not channel-specific.
Determines what command will be called for the uptime command.
@ -238,7 +238,7 @@ supybot.plugins.Unix.wtf
supybot.plugins.Unix.wtf.command
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what command will be called for the wtf command.

6
plugins/User/README.rst
View File

@ -109,7 +109,7 @@ Configuration
supybot.plugins.User.customWhoamiError
This config variable defaults to "", is not network-specific, and is not channel-specific.
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what message the bot sends when a user isn't identified or recognized.
@ -117,7 +117,7 @@ supybot.plugins.User.customWhoamiError
supybot.plugins.User.listInPrivate
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the output of 'user list' will be sent in private. This prevents mass-highlights of people who use their nick as their bot username.
@ -125,7 +125,7 @@ supybot.plugins.User.listInPrivate
supybot.plugins.User.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

2
plugins/Utilities/README.rst
View File

@ -77,7 +77,7 @@ Configuration
supybot.plugins.Utilities.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.

26
plugins/Web/README.rst
View File

@ -67,7 +67,7 @@ Configuration
supybot.plugins.Web.checkIgnored
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether the title snarfer checks if the author of a message is ignored.
@ -81,7 +81,7 @@ supybot.plugins.Web.fetch
supybot.plugins.Web.fetch.maximum
This config variable defaults to "0", is not network-specific, and is not channel-specific.
This config variable defaults to "0", is not network-specific, and is not channel-specific.
Determines the maximum number of bytes the bot will download via the 'fetch' command in this plugin.
@ -89,7 +89,7 @@ supybot.plugins.Web.fetch
supybot.plugins.Web.fetch.timeout
This config variable defaults to "5", is not network-specific, and is not channel-specific.
This config variable defaults to "5", is not network-specific, and is not channel-specific.
Determines the maximum number of seconds the bot will wait for the site to respond, when using the 'fetch' command in this plugin. If 0, will use socket.defaulttimeout
@ -97,7 +97,7 @@ supybot.plugins.Web.fetch
supybot.plugins.Web.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
This config variable defaults to "", is network-specific, and is channel-specific.
Determines what 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.
@ -105,7 +105,7 @@ supybot.plugins.Web.nonSnarfingRegexp
supybot.plugins.Web.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
@ -113,7 +113,7 @@ supybot.plugins.Web.public
supybot.plugins.Web.snarfMultipleUrls
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the title snarfer will query all URLs in a message, or only the first one.
@ -121,7 +121,7 @@ supybot.plugins.Web.snarfMultipleUrls
supybot.plugins.Web.snarferPrefix
This config variable defaults to "Title:", is network-specific, and is channel-specific.
This config variable defaults to "Title:", is network-specific, and is channel-specific.
Determines the string used at before a web page's title.
@ -129,7 +129,7 @@ supybot.plugins.Web.snarferPrefix
supybot.plugins.Web.snarferReportIOExceptions
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will notfiy the user about network exceptions like hostnotfound, timeout ....
@ -137,7 +137,7 @@ supybot.plugins.Web.snarferReportIOExceptions
supybot.plugins.Web.snarferShowDomain
This config variable defaults to "True", is network-specific, and is channel-specific.
This config variable defaults to "True", is network-specific, and is channel-specific.
Determines whether domain names should be displayed by the title snarfer.
@ -145,7 +145,7 @@ supybot.plugins.Web.snarferShowDomain
supybot.plugins.Web.snarferShowTargetDomain
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the domain name displayed by the snarfer will be the original one (posted on IRC) or the target one (got after following redirects, if any).
@ -153,7 +153,7 @@ supybot.plugins.Web.snarferShowTargetDomain
supybot.plugins.Web.timeout
This config variable defaults to "5", is not network-specific, and is not channel-specific.
This config variable defaults to "5", is not network-specific, and is not channel-specific.
Determines the maximum number of seconds the bot will wait for the site to respond, when using a command in this plugin other than 'fetch'. If 0, will use socket.defaulttimeout
@ -161,7 +161,7 @@ supybot.plugins.Web.timeout
supybot.plugins.Web.titleSnarfer
This config variable defaults to "False", is network-specific, and is channel-specific.
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will output the HTML title of URLs it sees in the channel.
@ -169,7 +169,7 @@ supybot.plugins.Web.titleSnarfer
supybot.plugins.Web.urlWhitelist
This config variable defaults to " ", is not network-specific, and is not channel-specific.
This config variable defaults to " ", is not network-specific, and is not channel-specific.
If set, bot will only fetch data from urls in the whitelist, i.e. starting with http://domain/optionalpath/. This will apply to all commands that retrieve data from user-supplied URLs, including fetch, headers, title, doctype.

2
scripts/supybot-plugin-doc
View File

@ -246,7 +246,7 @@ class PluginDoc(object):
cv = '' if v._channelValue else ' not'
nv = '' if v._networkValue else ' not'
kind = (
'is%s network-specific, and is %s channel-specific.'
'is%s network-specific, and is%s channel-specific.'
% (nv, cv)
)
else: