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

all plugins: regenerate READMEs

Browse Source
This commit is contained in:
Valentin Lorentz 2021-04-22 00:29:15 +02:00
parent e16c10ff77
commit fec6959acb
68 changed files with 780 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
plugins/Admin/README.rst
View File

@ -75,6 +75,7 @@ Configuration
.. _conf-supybot.plugins.Admin.public:
supybot.plugins.Admin.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

16
plugins/Aka/README.rst
View File

@ -128,6 +128,7 @@ Configuration
.. _conf-supybot.plugins.Aka.maximumWordsInName:
supybot.plugins.Aka.maximumWordsInName
This config variable defaults to "5", is not network-specific, and is not channel-specific.
@ -135,8 +136,23 @@ supybot.plugins.Aka.maximumWordsInName
.. _conf-supybot.plugins.Aka.public:
supybot.plugins.Aka.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.Aka.web:
supybot.plugins.Aka.web
This is a group of:
.. _conf-supybot.plugins.Aka.web.enable:
supybot.plugins.Aka.web.enable
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.

14
plugins/Alias/README.rst
View File

@ -66,8 +66,21 @@ unlock <alias>
Configuration
-------------
.. _conf-supybot.plugins.Alias.aliases:
supybot.plugins.Alias.aliases
This is a group of:
.. _conf-supybot.plugins.Alias.escapedaliases:
supybot.plugins.Alias.escapedaliases
This is a group of:
.. _conf-supybot.plugins.Alias.public:
supybot.plugins.Alias.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -75,6 +88,7 @@ supybot.plugins.Alias.public
.. _conf-supybot.plugins.Alias.validName:
supybot.plugins.Alias.validName
This config variable defaults to "^[^\\x00-\\x20]+$", is not network-specific, and is not channel-specific.

5
plugins/Anonymous/README.rst
View File

@ -75,6 +75,7 @@ Configuration
.. _conf-supybot.plugins.Anonymous.allowPrivateTarget:
supybot.plugins.Anonymous.allowPrivateTarget
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -82,6 +83,7 @@ supybot.plugins.Anonymous.allowPrivateTarget
.. _conf-supybot.plugins.Anonymous.public:
supybot.plugins.Anonymous.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -89,6 +91,7 @@ supybot.plugins.Anonymous.public
.. _conf-supybot.plugins.Anonymous.requireCapability:
supybot.plugins.Anonymous.requireCapability
This config variable defaults to "", is network-specific, and is channel-specific.
@ -96,6 +99,7 @@ supybot.plugins.Anonymous.requireCapability
.. _conf-supybot.plugins.Anonymous.requirePresenceInChannel:
supybot.plugins.Anonymous.requirePresenceInChannel
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -103,6 +107,7 @@ supybot.plugins.Anonymous.requirePresenceInChannel
.. _conf-supybot.plugins.Anonymous.requireRegistration:
supybot.plugins.Anonymous.requireRegistration
This config variable defaults to "True", is network-specific, and is channel-specific.

14
plugins/AutoMode/README.rst
View File

@ -33,6 +33,7 @@ Configuration
.. _conf-supybot.plugins.AutoMode.alternativeCapabilities:
supybot.plugins.AutoMode.alternativeCapabilities
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -40,12 +41,14 @@ supybot.plugins.AutoMode.alternativeCapabilities
.. _conf-supybot.plugins.AutoMode.ban:
supybot.plugins.AutoMode.ban
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.
.. _conf-supybot.plugins.AutoMode.ban.period:
.. _conf-supybot.plugins.AutoMode.ban.period:
supybot.plugins.AutoMode.ban.period
This config variable defaults to "86400", is network-specific, and is channel-specific.
@ -54,6 +57,7 @@ supybot.plugins.AutoMode.ban
.. _conf-supybot.plugins.AutoMode.delay:
supybot.plugins.AutoMode.delay
This config variable defaults to "0", is network-specific, and is channel-specific.
@ -61,6 +65,7 @@ supybot.plugins.AutoMode.delay
.. _conf-supybot.plugins.AutoMode.enable:
supybot.plugins.AutoMode.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -68,6 +73,7 @@ supybot.plugins.AutoMode.enable
.. _conf-supybot.plugins.AutoMode.extra:
supybot.plugins.AutoMode.extra
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -75,6 +81,7 @@ supybot.plugins.AutoMode.extra
.. _conf-supybot.plugins.AutoMode.fallthrough:
supybot.plugins.AutoMode.fallthrough
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -82,6 +89,7 @@ supybot.plugins.AutoMode.fallthrough
.. _conf-supybot.plugins.AutoMode.halfop:
supybot.plugins.AutoMode.halfop
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -89,6 +97,7 @@ supybot.plugins.AutoMode.halfop
.. _conf-supybot.plugins.AutoMode.op:
supybot.plugins.AutoMode.op
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -96,6 +105,7 @@ supybot.plugins.AutoMode.op
.. _conf-supybot.plugins.AutoMode.owner:
supybot.plugins.AutoMode.owner
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -103,6 +113,7 @@ supybot.plugins.AutoMode.owner
.. _conf-supybot.plugins.AutoMode.public:
supybot.plugins.AutoMode.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -110,6 +121,7 @@ supybot.plugins.AutoMode.public
.. _conf-supybot.plugins.AutoMode.voice:
supybot.plugins.AutoMode.voice
This config variable defaults to "False", is network-specific, and is channel-specific.

2
plugins/Autocomplete/README.rst
View File

@ -26,6 +26,7 @@ Configuration
.. _conf-supybot.plugins.Autocomplete.enabled:
supybot.plugins.Autocomplete.enabled
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -33,6 +34,7 @@ supybot.plugins.Autocomplete.enabled
.. _conf-supybot.plugins.Autocomplete.public:
supybot.plugins.Autocomplete.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

12
plugins/BadWords/README.rst
View File

@ -42,12 +42,14 @@ Configuration
.. _conf-supybot.plugins.BadWords.kick:
supybot.plugins.BadWords.kick
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.
.. _conf-supybot.plugins.BadWords.kick.message:
.. _conf-supybot.plugins.BadWords.kick.message:
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.
@ -56,6 +58,7 @@ supybot.plugins.BadWords.kick
.. _conf-supybot.plugins.BadWords.nastyChars:
supybot.plugins.BadWords.nastyChars
This config variable defaults to "!@#&", is not network-specific, and is not channel-specific.
@ -63,6 +66,7 @@ supybot.plugins.BadWords.nastyChars
.. _conf-supybot.plugins.BadWords.phrases:
supybot.plugins.BadWords.phrases
This config variable defaults to " ", is not network-specific, and is not channel-specific.
@ -70,6 +74,7 @@ supybot.plugins.BadWords.phrases
.. _conf-supybot.plugins.BadWords.public:
supybot.plugins.BadWords.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -77,6 +82,7 @@ supybot.plugins.BadWords.public
.. _conf-supybot.plugins.BadWords.replaceMethod:
supybot.plugins.BadWords.replaceMethod
This config variable defaults to "nastyCharacters", is not network-specific, and is not channel-specific.
@ -84,6 +90,7 @@ supybot.plugins.BadWords.replaceMethod
.. _conf-supybot.plugins.BadWords.requireWordBoundaries:
supybot.plugins.BadWords.requireWordBoundaries
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -91,6 +98,7 @@ supybot.plugins.BadWords.requireWordBoundaries
.. _conf-supybot.plugins.BadWords.simpleReplacement:
supybot.plugins.BadWords.simpleReplacement
This config variable defaults to "[CENSORED]", is not network-specific, and is not channel-specific.
@ -98,6 +106,7 @@ supybot.plugins.BadWords.simpleReplacement
.. _conf-supybot.plugins.BadWords.stripFormatting:
supybot.plugins.BadWords.stripFormatting
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -105,6 +114,7 @@ supybot.plugins.BadWords.stripFormatting
.. _conf-supybot.plugins.BadWords.words:
supybot.plugins.BadWords.words
This config variable defaults to " ", is not network-specific, and is not channel-specific.

5
plugins/Channel/README.rst
View File

@ -220,6 +220,7 @@ Configuration
.. _conf-supybot.plugins.Channel.alwaysRejoin:
supybot.plugins.Channel.alwaysRejoin
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -227,6 +228,7 @@ supybot.plugins.Channel.alwaysRejoin
.. _conf-supybot.plugins.Channel.nicksInPrivate:
supybot.plugins.Channel.nicksInPrivate
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -234,6 +236,7 @@ supybot.plugins.Channel.nicksInPrivate
.. _conf-supybot.plugins.Channel.partMsg:
supybot.plugins.Channel.partMsg
This config variable defaults to "Limnoria $version", is network-specific, and is channel-specific.
@ -241,6 +244,7 @@ supybot.plugins.Channel.partMsg
.. _conf-supybot.plugins.Channel.public:
supybot.plugins.Channel.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -248,6 +252,7 @@ supybot.plugins.Channel.public
.. _conf-supybot.plugins.Channel.rejoinDelay:
supybot.plugins.Channel.rejoinDelay
This config variable defaults to "0", is network-specific, and is channel-specific.

23
plugins/ChannelLogger/README.rst
View File

@ -18,33 +18,38 @@ Configuration
.. _conf-supybot.plugins.ChannelLogger.directories:
supybot.plugins.ChannelLogger.directories
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.
.. _conf-supybot.plugins.ChannelLogger.directories.channel:
.. _conf-supybot.plugins.ChannelLogger.directories.channel:
supybot.plugins.ChannelLogger.directories.channel
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.
.. _conf-supybot.plugins.ChannelLogger.directories.network:
.. _conf-supybot.plugins.ChannelLogger.directories.network:
supybot.plugins.ChannelLogger.directories.network
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.
.. _conf-supybot.plugins.ChannelLogger.directories.timestamp:
.. _conf-supybot.plugins.ChannelLogger.directories.timestamp:
supybot.plugins.ChannelLogger.directories.timestamp
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.
.. _conf-supybot.plugins.ChannelLogger.directories.timestamp.format:
.. _conf-supybot.plugins.ChannelLogger.directories.timestamp.format:
supybot.plugins.ChannelLogger.directories.timestamp.format
This config variable defaults to "%B", is not network-specific, and is not channel-specific.
@ -53,6 +58,7 @@ supybot.plugins.ChannelLogger.directories
.. _conf-supybot.plugins.ChannelLogger.enable:
supybot.plugins.ChannelLogger.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -60,6 +66,7 @@ supybot.plugins.ChannelLogger.enable
.. _conf-supybot.plugins.ChannelLogger.filenameTimestamp:
supybot.plugins.ChannelLogger.filenameTimestamp
This config variable defaults to "%Y-%m-%d", is network-specific, and is channel-specific.
@ -67,6 +74,7 @@ supybot.plugins.ChannelLogger.filenameTimestamp
.. _conf-supybot.plugins.ChannelLogger.flushImmediately:
supybot.plugins.ChannelLogger.flushImmediately
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -74,6 +82,7 @@ supybot.plugins.ChannelLogger.flushImmediately
.. _conf-supybot.plugins.ChannelLogger.noLogPrefix:
supybot.plugins.ChannelLogger.noLogPrefix
This config variable defaults to "[nolog]", is network-specific, and is channel-specific.
@ -81,6 +90,7 @@ supybot.plugins.ChannelLogger.noLogPrefix
.. _conf-supybot.plugins.ChannelLogger.public:
supybot.plugins.ChannelLogger.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -88,6 +98,7 @@ supybot.plugins.ChannelLogger.public
.. _conf-supybot.plugins.ChannelLogger.rewriteRelayed:
supybot.plugins.ChannelLogger.rewriteRelayed
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -95,6 +106,7 @@ supybot.plugins.ChannelLogger.rewriteRelayed
.. _conf-supybot.plugins.ChannelLogger.rotateLogs:
supybot.plugins.ChannelLogger.rotateLogs
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -102,6 +114,7 @@ supybot.plugins.ChannelLogger.rotateLogs
.. _conf-supybot.plugins.ChannelLogger.showJoinParts:
supybot.plugins.ChannelLogger.showJoinParts
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -109,6 +122,7 @@ supybot.plugins.ChannelLogger.showJoinParts
.. _conf-supybot.plugins.ChannelLogger.stripFormatting:
supybot.plugins.ChannelLogger.stripFormatting
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -116,6 +130,7 @@ supybot.plugins.ChannelLogger.stripFormatting
.. _conf-supybot.plugins.ChannelLogger.timestamp:
supybot.plugins.ChannelLogger.timestamp
This config variable defaults to "True", is network-specific, and is channel-specific.

4
plugins/ChannelStats/README.rst
View File

@ -40,6 +40,7 @@ Configuration
.. _conf-supybot.plugins.ChannelStats.frowns:
supybot.plugins.ChannelStats.frowns
This config variable defaults to ":| :-/ :-\\ :\\ :/ :( :-( :'(", is network-specific, and is channel-specific.
@ -47,6 +48,7 @@ supybot.plugins.ChannelStats.frowns
.. _conf-supybot.plugins.ChannelStats.public:
supybot.plugins.ChannelStats.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -54,6 +56,7 @@ supybot.plugins.ChannelStats.public
.. _conf-supybot.plugins.ChannelStats.selfStats:
supybot.plugins.ChannelStats.selfStats
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -61,6 +64,7 @@ supybot.plugins.ChannelStats.selfStats
.. _conf-supybot.plugins.ChannelStats.smileys:
supybot.plugins.ChannelStats.smileys
This config variable defaults to ":) ;) ;] :-) :-D :D :P :p (= =)", is network-specific, and is channel-specific.

1
plugins/Conditional/README.rst
View File

@ -118,6 +118,7 @@ Configuration
.. _conf-supybot.plugins.Conditional.public:
supybot.plugins.Conditional.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Config/README.rst
View File

@ -93,6 +93,7 @@ Configuration
.. _conf-supybot.plugins.Config.public:
supybot.plugins.Config.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

3
plugins/Ctcp/README.rst
View File

@ -32,6 +32,7 @@ Configuration
.. _conf-supybot.plugins.Ctcp.public:
supybot.plugins.Ctcp.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -39,6 +40,7 @@ supybot.plugins.Ctcp.public
.. _conf-supybot.plugins.Ctcp.userinfo:
supybot.plugins.Ctcp.userinfo
This config variable defaults to "", is not network-specific, and is not channel-specific.
@ -46,6 +48,7 @@ supybot.plugins.Ctcp.userinfo
.. _conf-supybot.plugins.Ctcp.versionWait:
supybot.plugins.Ctcp.versionWait
This config variable defaults to "10", is not network-specific, and is not channel-specific.

5
plugins/DDG/README.rst
View File

@ -32,6 +32,7 @@ Configuration
.. _conf-supybot.plugins.DDG.maxResults:
supybot.plugins.DDG.maxResults
This config variable defaults to "4", is network-specific, and is channel-specific.
@ -39,6 +40,7 @@ supybot.plugins.DDG.maxResults
.. _conf-supybot.plugins.DDG.public:
supybot.plugins.DDG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -46,6 +48,7 @@ supybot.plugins.DDG.public
.. _conf-supybot.plugins.DDG.region:
supybot.plugins.DDG.region
This config variable defaults to "", is network-specific, and is channel-specific.
@ -53,6 +56,7 @@ supybot.plugins.DDG.region
.. _conf-supybot.plugins.DDG.searchFilter:
supybot.plugins.DDG.searchFilter
This config variable defaults to "moderate", is network-specific, and is channel-specific.
@ -60,6 +64,7 @@ supybot.plugins.DDG.searchFilter
.. _conf-supybot.plugins.DDG.showSnippet:
supybot.plugins.DDG.showSnippet
This config variable defaults to "True", is network-specific, and is channel-specific.

1
plugins/Debug/README.rst
View File

@ -75,6 +75,7 @@ Configuration
.. _conf-supybot.plugins.Debug.public:
supybot.plugins.Debug.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

4
plugins/Dict/README.rst
View File

@ -48,6 +48,7 @@ Configuration
.. _conf-supybot.plugins.Dict.default:
supybot.plugins.Dict.default
This config variable defaults to "*", is network-specific, and is channel-specific.
@ -55,6 +56,7 @@ supybot.plugins.Dict.default
.. _conf-supybot.plugins.Dict.public:
supybot.plugins.Dict.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -62,6 +64,7 @@ supybot.plugins.Dict.public
.. _conf-supybot.plugins.Dict.server:
supybot.plugins.Dict.server
This config variable defaults to "dict.org", is not network-specific, and is not channel-specific.
@ -69,6 +72,7 @@ supybot.plugins.Dict.server
.. _conf-supybot.plugins.Dict.showDictName:
supybot.plugins.Dict.showDictName
This config variable defaults to "True", is network-specific, and is channel-specific.

2
plugins/Dunno/README.rst
View File

@ -59,6 +59,7 @@ Configuration
.. _conf-supybot.plugins.Dunno.prefixNick:
supybot.plugins.Dunno.prefixNick
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -66,6 +67,7 @@ supybot.plugins.Dunno.prefixNick
.. _conf-supybot.plugins.Dunno.public:
supybot.plugins.Dunno.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

31
plugins/Factoids/README.rst
View File

@ -78,6 +78,7 @@ Configuration
.. _conf-supybot.plugins.Factoids.format:
supybot.plugins.Factoids.format
This config variable defaults to "$value", is network-specific, and is channel-specific.
@ -85,6 +86,7 @@ supybot.plugins.Factoids.format
.. _conf-supybot.plugins.Factoids.keepRankInfo:
supybot.plugins.Factoids.keepRankInfo
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -92,6 +94,7 @@ supybot.plugins.Factoids.keepRankInfo
.. _conf-supybot.plugins.Factoids.learnSeparator:
supybot.plugins.Factoids.learnSeparator
This config variable defaults to "is", is network-specific, and is channel-specific.
@ -99,6 +102,7 @@ supybot.plugins.Factoids.learnSeparator
.. _conf-supybot.plugins.Factoids.public:
supybot.plugins.Factoids.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -106,6 +110,7 @@ supybot.plugins.Factoids.public
.. _conf-supybot.plugins.Factoids.rankListLength:
supybot.plugins.Factoids.rankListLength
This config variable defaults to "20", is network-specific, and is channel-specific.
@ -113,6 +118,7 @@ supybot.plugins.Factoids.rankListLength
.. _conf-supybot.plugins.Factoids.replyApproximateSearchKeys:
supybot.plugins.Factoids.replyApproximateSearchKeys
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -120,6 +126,7 @@ supybot.plugins.Factoids.replyApproximateSearchKeys
.. _conf-supybot.plugins.Factoids.replyWhenInvalidCommand:
supybot.plugins.Factoids.replyWhenInvalidCommand
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -127,6 +134,7 @@ supybot.plugins.Factoids.replyWhenInvalidCommand
.. _conf-supybot.plugins.Factoids.requireVoice:
supybot.plugins.Factoids.requireVoice
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -134,8 +142,31 @@ supybot.plugins.Factoids.requireVoice
.. _conf-supybot.plugins.Factoids.showFactoidIfOnlyOneMatch:
supybot.plugins.Factoids.showFactoidIfOnlyOneMatch
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.
.. _conf-supybot.plugins.Factoids.web:
supybot.plugins.Factoids.web
This is a group of:
.. _conf-supybot.plugins.Factoids.web.channel:
supybot.plugins.Factoids.web.channel
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether factoids can be displayed via the web server.
.. _conf-supybot.plugins.Factoids.web.enable:
supybot.plugins.Factoids.web.enable
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.

51
plugins/Fediverse/README.rst
View File

@ -62,10 +62,61 @@ statuses <@user@instance>
Configuration
-------------
.. _conf-supybot.plugins.Fediverse.format:
supybot.plugins.Fediverse.format
This is a group of:
.. _conf-supybot.plugins.Fediverse.format.statuses:
supybot.plugins.Fediverse.format.statuses
This is a group of:
.. _conf-supybot.plugins.Fediverse.format.statuses.showContentWithCW:
supybot.plugins.Fediverse.format.statuses.showContentWithCW
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.
.. _conf-supybot.plugins.Fediverse.public:
supybot.plugins.Fediverse.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.Fediverse.snarfers:
supybot.plugins.Fediverse.snarfers
This is a group of:
.. _conf-supybot.plugins.Fediverse.snarfers.profile:
supybot.plugins.Fediverse.snarfers.profile
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.
.. _conf-supybot.plugins.Fediverse.snarfers.status:
supybot.plugins.Fediverse.snarfers.status
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.
.. _conf-supybot.plugins.Fediverse.snarfers.username:
supybot.plugins.Fediverse.snarfers.username
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.

45
plugins/Filter/README.rst
View File

@ -173,8 +173,53 @@ Configuration
.. _conf-supybot.plugins.Filter.public:
supybot.plugins.Filter.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.Filter.shrink:
supybot.plugins.Filter.shrink
This is a group of:
.. _conf-supybot.plugins.Filter.shrink.minimum:
supybot.plugins.Filter.shrink.minimum
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.
.. _conf-supybot.plugins.Filter.spellit:
supybot.plugins.Filter.spellit
This is a group of:
.. _conf-supybot.plugins.Filter.spellit.replaceLetters:
supybot.plugins.Filter.spellit.replaceLetters
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.
.. _conf-supybot.plugins.Filter.spellit.replaceNumbers:
supybot.plugins.Filter.spellit.replaceNumbers
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.
.. _conf-supybot.plugins.Filter.spellit.replacePunctuation:
supybot.plugins.Filter.spellit.replacePunctuation
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.

1
plugins/Format/README.rst
View File

@ -111,6 +111,7 @@ Configuration
.. _conf-supybot.plugins.Format.public:
supybot.plugins.Format.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

29
plugins/GPG/README.rst
View File

@ -45,8 +45,37 @@ signing gettoken takes no arguments
Configuration
-------------
.. _conf-supybot.plugins.GPG.auth:
supybot.plugins.GPG.auth
This is a group of:
.. _conf-supybot.plugins.GPG.auth.sign:
supybot.plugins.GPG.auth.sign
This is a group of:
.. _conf-supybot.plugins.GPG.auth.sign.TokenTimeout:
supybot.plugins.GPG.auth.sign.TokenTimeout
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).
.. _conf-supybot.plugins.GPG.auth.sign.enable:
supybot.plugins.GPG.auth.sign.enable
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.
.. _conf-supybot.plugins.GPG.public:
supybot.plugins.GPG.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Games/README.rst
View File

@ -50,6 +50,7 @@ Configuration
.. _conf-supybot.plugins.Games.public:
supybot.plugins.Games.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

10
plugins/Google/README.rst
View File

@ -82,6 +82,7 @@ Configuration
.. _conf-supybot.plugins.Google.baseUrl:
supybot.plugins.Google.baseUrl
This config variable defaults to "google.com", is network-specific, and is channel-specific.
@ -89,6 +90,7 @@ supybot.plugins.Google.baseUrl
.. _conf-supybot.plugins.Google.bold:
supybot.plugins.Google.bold
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -96,6 +98,7 @@ supybot.plugins.Google.bold
.. _conf-supybot.plugins.Google.colorfulFilter:
supybot.plugins.Google.colorfulFilter
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -103,6 +106,7 @@ supybot.plugins.Google.colorfulFilter
.. _conf-supybot.plugins.Google.defaultLanguage:
supybot.plugins.Google.defaultLanguage
This config variable defaults to "lang_en", is network-specific, and is channel-specific.
@ -110,6 +114,7 @@ supybot.plugins.Google.defaultLanguage
.. _conf-supybot.plugins.Google.maximumResults:
supybot.plugins.Google.maximumResults
This config variable defaults to "3", is network-specific, and is channel-specific.
@ -117,6 +122,7 @@ supybot.plugins.Google.maximumResults
.. _conf-supybot.plugins.Google.oneToOne:
supybot.plugins.Google.oneToOne
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -124,6 +130,7 @@ supybot.plugins.Google.oneToOne
.. _conf-supybot.plugins.Google.public:
supybot.plugins.Google.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -131,6 +138,7 @@ supybot.plugins.Google.public
.. _conf-supybot.plugins.Google.referer:
supybot.plugins.Google.referer
This config variable defaults to "", is not network-specific, and is not channel-specific.
@ -138,6 +146,7 @@ supybot.plugins.Google.referer
.. _conf-supybot.plugins.Google.searchFilter:
supybot.plugins.Google.searchFilter
This config variable defaults to "moderate", is network-specific, and is channel-specific.
@ -145,6 +154,7 @@ supybot.plugins.Google.searchFilter
.. _conf-supybot.plugins.Google.searchSnarfer:
supybot.plugins.Google.searchSnarfer
This config variable defaults to "False", is network-specific, and is channel-specific.

1
plugins/Hashes/README.rst
View File

@ -52,6 +52,7 @@ Configuration
.. _conf-supybot.plugins.Hashes.public:
supybot.plugins.Hashes.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

17
plugins/Herald/README.rst
View File

@ -49,19 +49,22 @@ Configuration
.. _conf-supybot.plugins.Herald.default:
supybot.plugins.Herald.default
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.
.. _conf-supybot.plugins.Herald.default.notice:
.. _conf-supybot.plugins.Herald.default.notice:
supybot.plugins.Herald.default.notice
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.
.. _conf-supybot.plugins.Herald.default.public:
.. _conf-supybot.plugins.Herald.default.public:
supybot.plugins.Herald.default.public
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -70,6 +73,7 @@ supybot.plugins.Herald.default
.. _conf-supybot.plugins.Herald.heralding:
supybot.plugins.Herald.heralding
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -77,6 +81,7 @@ supybot.plugins.Herald.heralding
.. _conf-supybot.plugins.Herald.public:
supybot.plugins.Herald.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -84,6 +89,7 @@ supybot.plugins.Herald.public
.. _conf-supybot.plugins.Herald.requireCapability:
supybot.plugins.Herald.requireCapability
This config variable defaults to "", is not network-specific, and is not channel-specific.
@ -91,19 +97,22 @@ supybot.plugins.Herald.requireCapability
.. _conf-supybot.plugins.Herald.throttle:
supybot.plugins.Herald.throttle
This config variable defaults to "600", is network-specific, and is channel-specific.
Determines the minimum number of seconds between heralds.
.. _conf-supybot.plugins.Herald.throttle.afterPart:
.. _conf-supybot.plugins.Herald.throttle.afterPart:
supybot.plugins.Herald.throttle.afterPart
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.
.. _conf-supybot.plugins.Herald.throttle.afterSplit:
.. _conf-supybot.plugins.Herald.throttle.afterSplit:
supybot.plugins.Herald.throttle.afterSplit
This config variable defaults to "60", is network-specific, and is channel-specific.

1
plugins/Internet/README.rst
View File

@ -39,6 +39,7 @@ Configuration
.. _conf-supybot.plugins.Internet.public:
supybot.plugins.Internet.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

10
plugins/Karma/README.rst
View File

@ -60,6 +60,7 @@ Configuration
.. _conf-supybot.plugins.Karma.allowSelfRating:
supybot.plugins.Karma.allowSelfRating
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -67,6 +68,7 @@ supybot.plugins.Karma.allowSelfRating
.. _conf-supybot.plugins.Karma.allowUnaddressedKarma:
supybot.plugins.Karma.allowUnaddressedKarma
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -74,6 +76,7 @@ supybot.plugins.Karma.allowUnaddressedKarma
.. _conf-supybot.plugins.Karma.decrementChars:
supybot.plugins.Karma.decrementChars
This config variable defaults to "--", is network-specific, and is channel-specific.
@ -81,6 +84,7 @@ supybot.plugins.Karma.decrementChars
.. _conf-supybot.plugins.Karma.incrementChars:
supybot.plugins.Karma.incrementChars
This config variable defaults to "++", is network-specific, and is channel-specific.
@ -88,6 +92,7 @@ supybot.plugins.Karma.incrementChars
.. _conf-supybot.plugins.Karma.mostDisplay:
supybot.plugins.Karma.mostDisplay
This config variable defaults to "25", is network-specific, and is channel-specific.
@ -95,6 +100,7 @@ supybot.plugins.Karma.mostDisplay
.. _conf-supybot.plugins.Karma.onlyNicks:
supybot.plugins.Karma.onlyNicks
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -102,6 +108,7 @@ supybot.plugins.Karma.onlyNicks
.. _conf-supybot.plugins.Karma.public:
supybot.plugins.Karma.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -109,6 +116,7 @@ supybot.plugins.Karma.public
.. _conf-supybot.plugins.Karma.rankingDisplay:
supybot.plugins.Karma.rankingDisplay
This config variable defaults to "3", is network-specific, and is channel-specific.
@ -116,6 +124,7 @@ supybot.plugins.Karma.rankingDisplay
.. _conf-supybot.plugins.Karma.response:
supybot.plugins.Karma.response
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -123,6 +132,7 @@ supybot.plugins.Karma.response
.. _conf-supybot.plugins.Karma.simpleOutput:
supybot.plugins.Karma.simpleOutput
This config variable defaults to "False", is network-specific, and is channel-specific.

2
plugins/Lart/README.rst
View File

@ -65,6 +65,7 @@ Configuration
.. _conf-supybot.plugins.Lart.public:
supybot.plugins.Lart.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -72,6 +73,7 @@ supybot.plugins.Lart.public
.. _conf-supybot.plugins.Lart.showIds:
supybot.plugins.Lart.showIds
This config variable defaults to "False", is network-specific, and is channel-specific.

19
plugins/Later/README.rst
View File

@ -68,8 +68,23 @@ undo <nick>
Configuration
-------------
.. _conf-supybot.plugins.Later.format:
supybot.plugins.Later.format
This is a group of:
.. _conf-supybot.plugins.Later.format.senderHostname:
supybot.plugins.Later.format.senderHostname
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).
.. _conf-supybot.plugins.Later.maximum:
supybot.plugins.Later.maximum
This config variable defaults to "0", is not network-specific, and is not channel-specific.
@ -77,6 +92,7 @@ supybot.plugins.Later.maximum
.. _conf-supybot.plugins.Later.messageExpiry:
supybot.plugins.Later.messageExpiry
This config variable defaults to "30", is not network-specific, and is not channel-specific.
@ -84,6 +100,7 @@ supybot.plugins.Later.messageExpiry
.. _conf-supybot.plugins.Later.private:
supybot.plugins.Later.private
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -91,6 +108,7 @@ supybot.plugins.Later.private
.. _conf-supybot.plugins.Later.public:
supybot.plugins.Later.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -98,6 +116,7 @@ supybot.plugins.Later.public
.. _conf-supybot.plugins.Later.tellOnJoin:
supybot.plugins.Later.tellOnJoin
This config variable defaults to "False", is not network-specific, and is not channel-specific.

4
plugins/Limiter/README.rst
View File

@ -25,6 +25,7 @@ Configuration
.. _conf-supybot.plugins.Limiter.enable:
supybot.plugins.Limiter.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -32,6 +33,7 @@ supybot.plugins.Limiter.enable
.. _conf-supybot.plugins.Limiter.maximumExcess:
supybot.plugins.Limiter.maximumExcess
This config variable defaults to "10", is network-specific, and is channel-specific.
@ -39,6 +41,7 @@ supybot.plugins.Limiter.maximumExcess
.. _conf-supybot.plugins.Limiter.minimumExcess:
supybot.plugins.Limiter.minimumExcess
This config variable defaults to "5", is network-specific, and is channel-specific.
@ -46,6 +49,7 @@ supybot.plugins.Limiter.minimumExcess
.. _conf-supybot.plugins.Limiter.public:
supybot.plugins.Limiter.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

8
plugins/LogToIrc/README.rst
View File

@ -14,6 +14,7 @@ Configuration
.. _conf-supybot.plugins.LogToIrc.channelModesRequired:
supybot.plugins.LogToIrc.channelModesRequired
This config variable defaults to "s", is network-specific, and is not channel-specific.
@ -21,6 +22,7 @@ supybot.plugins.LogToIrc.channelModesRequired
.. _conf-supybot.plugins.LogToIrc.color:
supybot.plugins.LogToIrc.color
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -28,6 +30,7 @@ supybot.plugins.LogToIrc.color
.. _conf-supybot.plugins.LogToIrc.level:
supybot.plugins.LogToIrc.level
This config variable defaults to "WARNING", is network-specific, and is channel-specific.
@ -35,6 +38,7 @@ supybot.plugins.LogToIrc.level
.. _conf-supybot.plugins.LogToIrc.networks:
supybot.plugins.LogToIrc.networks
This config variable defaults to " ", is not network-specific, and is not channel-specific.
@ -42,6 +46,7 @@ supybot.plugins.LogToIrc.networks
.. _conf-supybot.plugins.LogToIrc.notice:
supybot.plugins.LogToIrc.notice
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -49,6 +54,7 @@ supybot.plugins.LogToIrc.notice
.. _conf-supybot.plugins.LogToIrc.public:
supybot.plugins.LogToIrc.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -56,6 +62,7 @@ supybot.plugins.LogToIrc.public
.. _conf-supybot.plugins.LogToIrc.targets:
supybot.plugins.LogToIrc.targets
This config variable defaults to " ", is network-specific, and is not channel-specific.
@ -63,6 +70,7 @@ supybot.plugins.LogToIrc.targets
.. _conf-supybot.plugins.LogToIrc.userCapabilityRequired:
supybot.plugins.LogToIrc.userCapabilityRequired
This config variable defaults to "owner", is not network-specific, and is not channel-specific.

1
plugins/Math/README.rst
View File

@ -54,6 +54,7 @@ Configuration
.. _conf-supybot.plugins.Math.public:
supybot.plugins.Math.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

9
plugins/MessageParser/README.rst
View File

@ -74,6 +74,7 @@ Configuration
.. _conf-supybot.plugins.MessageParser.enable:
supybot.plugins.MessageParser.enable
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -81,6 +82,7 @@ supybot.plugins.MessageParser.enable
.. _conf-supybot.plugins.MessageParser.enableForNotices:
supybot.plugins.MessageParser.enableForNotices
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -88,6 +90,7 @@ supybot.plugins.MessageParser.enableForNotices
.. _conf-supybot.plugins.MessageParser.keepRankInfo:
supybot.plugins.MessageParser.keepRankInfo
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -95,6 +98,7 @@ supybot.plugins.MessageParser.keepRankInfo
.. _conf-supybot.plugins.MessageParser.listSeparator:
supybot.plugins.MessageParser.listSeparator
This config variable defaults to ", ", is network-specific, and is channel-specific.
@ -102,6 +106,7 @@ supybot.plugins.MessageParser.listSeparator
.. _conf-supybot.plugins.MessageParser.maxTriggers:
supybot.plugins.MessageParser.maxTriggers
This config variable defaults to "0", is network-specific, and is channel-specific.
@ -109,6 +114,7 @@ supybot.plugins.MessageParser.maxTriggers
.. _conf-supybot.plugins.MessageParser.public:
supybot.plugins.MessageParser.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -116,6 +122,7 @@ supybot.plugins.MessageParser.public
.. _conf-supybot.plugins.MessageParser.rankListLength:
supybot.plugins.MessageParser.rankListLength
This config variable defaults to "20", is network-specific, and is channel-specific.
@ -123,6 +130,7 @@ supybot.plugins.MessageParser.rankListLength
.. _conf-supybot.plugins.MessageParser.requireManageCapability:
supybot.plugins.MessageParser.requireManageCapability
This config variable defaults to "admin; channel,op", is network-specific, and is channel-specific.
@ -130,6 +138,7 @@ supybot.plugins.MessageParser.requireManageCapability
.. _conf-supybot.plugins.MessageParser.requireVacuumCapability:
supybot.plugins.MessageParser.requireVacuumCapability
This config variable defaults to "admin", is network-specific, and is channel-specific.

34
plugins/Misc/README.rst
View File

@ -83,13 +83,43 @@ Configuration
.. _conf-supybot.plugins.Misc.customHelpString:
supybot.plugins.Misc.customHelpString
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.
.. _conf-supybot.plugins.Misc.last:
supybot.plugins.Misc.last
This is a group of:
.. _conf-supybot.plugins.Misc.last.nested:
supybot.plugins.Misc.last.nested
This is a group of:
.. _conf-supybot.plugins.Misc.last.nested.includeNick:
supybot.plugins.Misc.last.nested.includeNick
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
.. _conf-supybot.plugins.Misc.last.nested.includeTimestamp:
supybot.plugins.Misc.last.nested.includeTimestamp
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
.. _conf-supybot.plugins.Misc.listPrivatePlugins:
supybot.plugins.Misc.listPrivatePlugins
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -97,6 +127,7 @@ supybot.plugins.Misc.listPrivatePlugins
.. _conf-supybot.plugins.Misc.listUnloadedPlugins:
supybot.plugins.Misc.listUnloadedPlugins
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -104,6 +135,7 @@ supybot.plugins.Misc.listUnloadedPlugins
.. _conf-supybot.plugins.Misc.mores:
supybot.plugins.Misc.mores
This config variable defaults to "1", is network-specific, and is channel-specific.
@ -111,6 +143,7 @@ supybot.plugins.Misc.mores
.. _conf-supybot.plugins.Misc.public:
supybot.plugins.Misc.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -118,6 +151,7 @@ supybot.plugins.Misc.public
.. _conf-supybot.plugins.Misc.timestampFormat:
supybot.plugins.Misc.timestampFormat
This config variable defaults to "[%H:%M:%S]", is not network-specific, and is not channel-specific.

3
plugins/MoobotFactoids/README.rst
View File

@ -86,6 +86,7 @@ Configuration
.. _conf-supybot.plugins.MoobotFactoids.mostCount:
supybot.plugins.MoobotFactoids.mostCount
This config variable defaults to "10", is network-specific, and is channel-specific.
@ -93,6 +94,7 @@ supybot.plugins.MoobotFactoids.mostCount
.. _conf-supybot.plugins.MoobotFactoids.public:
supybot.plugins.MoobotFactoids.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -100,6 +102,7 @@ supybot.plugins.MoobotFactoids.public
.. _conf-supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch:
supybot.plugins.MoobotFactoids.showFactoidIfOnlyOneMatch
This config variable defaults to "True", is network-specific, and is channel-specific.

1
plugins/Network/README.rst
View File

@ -85,6 +85,7 @@ Configuration
.. _conf-supybot.plugins.Network.public:
supybot.plugins.Network.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/News/README.rst
View File

@ -49,6 +49,7 @@ Configuration
.. _conf-supybot.plugins.News.public:
supybot.plugins.News.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/NickAuth/README.rst
View File

@ -47,6 +47,7 @@ Configuration
.. _conf-supybot.plugins.NickAuth.public:
supybot.plugins.NickAuth.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

5
plugins/NickCapture/README.rst
View File

@ -21,12 +21,14 @@ Configuration
.. _conf-supybot.plugins.NickCapture.ison:
supybot.plugins.NickCapture.ison
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.
.. _conf-supybot.plugins.NickCapture.ison.period:
.. _conf-supybot.plugins.NickCapture.ison.period:
supybot.plugins.NickCapture.ison.period
This config variable defaults to "600", is not network-specific, and is not channel-specific.
@ -35,6 +37,7 @@ supybot.plugins.NickCapture.ison
.. _conf-supybot.plugins.NickCapture.public:
supybot.plugins.NickCapture.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Nickometer/README.rst
View File

@ -29,6 +29,7 @@ Configuration
.. _conf-supybot.plugins.Nickometer.public:
supybot.plugins.Nickometer.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

31
plugins/Note/README.rst
View File

@ -56,8 +56,39 @@ unsend <id>
Configuration
-------------
.. _conf-supybot.plugins.Note.notify:
supybot.plugins.Note.notify
This is a group of:
.. _conf-supybot.plugins.Note.notify.autoSend:
supybot.plugins.Note.notify.autoSend
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.
.. _conf-supybot.plugins.Note.notify.onJoin:
supybot.plugins.Note.notify.onJoin
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.
.. _conf-supybot.plugins.Note.notify.onJoin.repeatedly:
supybot.plugins.Note.notify.onJoin.repeatedly
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.
.. _conf-supybot.plugins.Note.public:
supybot.plugins.Note.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

3
plugins/Owner/README.rst
View File

@ -104,6 +104,7 @@ Configuration
.. _conf-supybot.plugins.Owner.announceFormat:
supybot.plugins.Owner.announceFormat
This config variable defaults to "Announcement from my owner ($owner): $text", is not network-specific, and is not channel-specific.
@ -111,6 +112,7 @@ supybot.plugins.Owner.announceFormat
.. _conf-supybot.plugins.Owner.public:
supybot.plugins.Owner.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -118,6 +120,7 @@ supybot.plugins.Owner.public
.. _conf-supybot.plugins.Owner.quitMsg:
supybot.plugins.Owner.quitMsg
This config variable defaults to "Limnoria $version", is not network-specific, and is not channel-specific.

1
plugins/Plugin/README.rst
View File

@ -51,6 +51,7 @@ Configuration
.. _conf-supybot.plugins.Plugin.public:
supybot.plugins.Plugin.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/PluginDownloader/README.rst
View File

@ -75,6 +75,7 @@ Configuration
.. _conf-supybot.plugins.PluginDownloader.public:
supybot.plugins.PluginDownloader.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

2
plugins/Praise/README.rst
View File

@ -66,6 +66,7 @@ Configuration
.. _conf-supybot.plugins.Praise.public:
supybot.plugins.Praise.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -73,6 +74,7 @@ supybot.plugins.Praise.public
.. _conf-supybot.plugins.Praise.showIds:
supybot.plugins.Praise.showIds
This config variable defaults to "False", is network-specific, and is channel-specific.

3
plugins/Protector/README.rst
View File

@ -20,6 +20,7 @@ Configuration
.. _conf-supybot.plugins.Protector.enable:
supybot.plugins.Protector.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -27,6 +28,7 @@ supybot.plugins.Protector.enable
.. _conf-supybot.plugins.Protector.immune:
supybot.plugins.Protector.immune
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -34,6 +36,7 @@ supybot.plugins.Protector.immune
.. _conf-supybot.plugins.Protector.public:
supybot.plugins.Protector.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Quote/README.rst
View File

@ -62,6 +62,7 @@ Configuration
.. _conf-supybot.plugins.Quote.public:
supybot.plugins.Quote.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

11
plugins/QuoteGrabs/README.rst
View File

@ -67,6 +67,7 @@ Configuration
.. _conf-supybot.plugins.QuoteGrabs.public:
supybot.plugins.QuoteGrabs.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -74,26 +75,30 @@ supybot.plugins.QuoteGrabs.public
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber:
supybot.plugins.QuoteGrabs.randomGrabber
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 ...
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs:
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs:
supybot.plugins.QuoteGrabs.randomGrabber.averageTimeBetweenGrabs
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.
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters:
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters:
supybot.plugins.QuoteGrabs.randomGrabber.minimumCharacters
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.
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumWords:
.. _conf-supybot.plugins.QuoteGrabs.randomGrabber.minimumWords:
supybot.plugins.QuoteGrabs.randomGrabber.minimumWords
This config variable defaults to "3", is network-specific, and is channel-specific.

14
plugins/RSS/README.rst
View File

@ -101,6 +101,7 @@ Configuration
.. _conf-supybot.plugins.RSS.announce:
supybot.plugins.RSS.announce
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -108,6 +109,7 @@ supybot.plugins.RSS.announce
.. _conf-supybot.plugins.RSS.announceFormat:
supybot.plugins.RSS.announceFormat
This config variable defaults to "News from $feed_name: $title <$link>", is network-specific, and is channel-specific.
@ -115,6 +117,7 @@ supybot.plugins.RSS.announceFormat
.. _conf-supybot.plugins.RSS.defaultNumberOfHeadlines:
supybot.plugins.RSS.defaultNumberOfHeadlines
This config variable defaults to "1", is network-specific, and is channel-specific.
@ -122,6 +125,7 @@ supybot.plugins.RSS.defaultNumberOfHeadlines
.. _conf-supybot.plugins.RSS.feeds:
supybot.plugins.RSS.feeds
This config variable defaults to " ", is not network-specific, and is not channel-specific.
@ -129,6 +133,7 @@ supybot.plugins.RSS.feeds
.. _conf-supybot.plugins.RSS.format:
supybot.plugins.RSS.format
This config variable defaults to "$date: $title <$link>", is network-specific, and is channel-specific.
@ -136,6 +141,7 @@ supybot.plugins.RSS.format
.. _conf-supybot.plugins.RSS.headlineSeparator:
supybot.plugins.RSS.headlineSeparator
This config variable defaults to " | ", is network-specific, and is channel-specific.
@ -143,6 +149,7 @@ supybot.plugins.RSS.headlineSeparator
.. _conf-supybot.plugins.RSS.initialAnnounceHeadlines:
supybot.plugins.RSS.initialAnnounceHeadlines
This config variable defaults to "5", is network-specific, and is channel-specific.
@ -150,6 +157,7 @@ supybot.plugins.RSS.initialAnnounceHeadlines
.. _conf-supybot.plugins.RSS.keywordBlacklist:
supybot.plugins.RSS.keywordBlacklist
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -157,6 +165,7 @@ supybot.plugins.RSS.keywordBlacklist
.. _conf-supybot.plugins.RSS.keywordWhitelist:
supybot.plugins.RSS.keywordWhitelist
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -164,6 +173,7 @@ supybot.plugins.RSS.keywordWhitelist
.. _conf-supybot.plugins.RSS.maximumAnnounceHeadlines:
supybot.plugins.RSS.maximumAnnounceHeadlines
This config variable defaults to "5", is network-specific, and is channel-specific.
@ -171,6 +181,7 @@ supybot.plugins.RSS.maximumAnnounceHeadlines
.. _conf-supybot.plugins.RSS.notice:
supybot.plugins.RSS.notice
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -178,6 +189,7 @@ supybot.plugins.RSS.notice
.. _conf-supybot.plugins.RSS.public:
supybot.plugins.RSS.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -185,6 +197,7 @@ supybot.plugins.RSS.public
.. _conf-supybot.plugins.RSS.sortFeedItems:
supybot.plugins.RSS.sortFeedItems
This config variable defaults to "asInFeed", is not network-specific, and is not channel-specific.
@ -192,6 +205,7 @@ supybot.plugins.RSS.sortFeedItems
.. _conf-supybot.plugins.RSS.waitPeriod:
supybot.plugins.RSS.waitPeriod
This config variable defaults to "1800", is not network-specific, and is not channel-specific.

12
plugins/Relay/README.rst
View File

@ -46,12 +46,14 @@ Configuration
.. _conf-supybot.plugins.Relay.channels:
supybot.plugins.Relay.channels
This config variable defaults to " ", is not network-specific, and is not channel-specific.
Determines which channels the bot will relay in.
.. _conf-supybot.plugins.Relay.channels.joinOnAllNetworks:
.. _conf-supybot.plugins.Relay.channels.joinOnAllNetworks:
supybot.plugins.Relay.channels.joinOnAllNetworks
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -60,6 +62,7 @@ supybot.plugins.Relay.channels
.. _conf-supybot.plugins.Relay.color:
supybot.plugins.Relay.color
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -67,6 +70,7 @@ supybot.plugins.Relay.color
.. _conf-supybot.plugins.Relay.hostmasks:
supybot.plugins.Relay.hostmasks
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -74,6 +78,7 @@ supybot.plugins.Relay.hostmasks
.. _conf-supybot.plugins.Relay.ignores:
supybot.plugins.Relay.ignores
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -81,6 +86,7 @@ supybot.plugins.Relay.ignores
.. _conf-supybot.plugins.Relay.includeNetwork:
supybot.plugins.Relay.includeNetwork
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -88,6 +94,7 @@ supybot.plugins.Relay.includeNetwork
.. _conf-supybot.plugins.Relay.noticeNonPrivmsgs:
supybot.plugins.Relay.noticeNonPrivmsgs
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -95,6 +102,7 @@ supybot.plugins.Relay.noticeNonPrivmsgs
.. _conf-supybot.plugins.Relay.public:
supybot.plugins.Relay.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -102,6 +110,7 @@ supybot.plugins.Relay.public
.. _conf-supybot.plugins.Relay.punishOtherRelayBots:
supybot.plugins.Relay.punishOtherRelayBots
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -109,6 +118,7 @@ supybot.plugins.Relay.punishOtherRelayBots
.. _conf-supybot.plugins.Relay.topicSync:
supybot.plugins.Relay.topicSync
This config variable defaults to "True", is network-specific, and is channel-specific.

1
plugins/Reply/README.rst
View File

@ -50,6 +50,7 @@ Configuration
.. _conf-supybot.plugins.Reply.public:
supybot.plugins.Reply.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Scheduler/README.rst
View File

@ -50,6 +50,7 @@ Configuration
.. _conf-supybot.plugins.Scheduler.public:
supybot.plugins.Scheduler.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

6
plugins/SedRegex/README.rst
View File

@ -43,6 +43,7 @@ Configuration
.. _conf-supybot.plugins.SedRegex.boldReplacementText:
supybot.plugins.SedRegex.boldReplacementText
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -50,6 +51,7 @@ supybot.plugins.SedRegex.boldReplacementText
.. _conf-supybot.plugins.SedRegex.displayErrors:
supybot.plugins.SedRegex.displayErrors
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -57,6 +59,7 @@ supybot.plugins.SedRegex.displayErrors
.. _conf-supybot.plugins.SedRegex.enable:
supybot.plugins.SedRegex.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -64,6 +67,7 @@ supybot.plugins.SedRegex.enable
.. _conf-supybot.plugins.SedRegex.ignoreRegex:
supybot.plugins.SedRegex.ignoreRegex
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -71,6 +75,7 @@ supybot.plugins.SedRegex.ignoreRegex
.. _conf-supybot.plugins.SedRegex.processTimeout:
supybot.plugins.SedRegex.processTimeout
This config variable defaults to "0.5", is not network-specific, and is not channel-specific.
@ -78,6 +83,7 @@ supybot.plugins.SedRegex.processTimeout
.. _conf-supybot.plugins.SedRegex.public:
supybot.plugins.SedRegex.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

3
plugins/Seen/README.rst
View File

@ -50,6 +50,7 @@ Configuration
.. _conf-supybot.plugins.Seen.minimumNonWildcard:
supybot.plugins.Seen.minimumNonWildcard
This config variable defaults to "2", is network-specific, and is channel-specific.
@ -57,6 +58,7 @@ supybot.plugins.Seen.minimumNonWildcard
.. _conf-supybot.plugins.Seen.public:
supybot.plugins.Seen.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -64,6 +66,7 @@ supybot.plugins.Seen.public
.. _conf-supybot.plugins.Seen.showLastMessage:
supybot.plugins.Seen.showLastMessage
This config variable defaults to "True", is network-specific, and is channel-specific.

25
plugins/Services/README.rst
View File

@ -80,33 +80,38 @@ Configuration
.. _conf-supybot.plugins.Services.ChanServ:
supybot.plugins.Services.ChanServ
This config variable defaults to "ChanServ", is network-specific, and is not channel-specific.
Determines what nick the 'ChanServ' service has.
.. _conf-supybot.plugins.Services.ChanServ.halfop:
.. _conf-supybot.plugins.Services.ChanServ.halfop:
supybot.plugins.Services.ChanServ.halfop
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.
.. _conf-supybot.plugins.Services.ChanServ.op:
.. _conf-supybot.plugins.Services.ChanServ.op:
supybot.plugins.Services.ChanServ.op
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.
.. _conf-supybot.plugins.Services.ChanServ.password:
.. _conf-supybot.plugins.Services.ChanServ.password:
supybot.plugins.Services.ChanServ.password
This config variable defaults to "", is network-specific, and is channel-specific.
Determines what password the bot will use with ChanServ.
.. _conf-supybot.plugins.Services.ChanServ.voice:
.. _conf-supybot.plugins.Services.ChanServ.voice:
supybot.plugins.Services.ChanServ.voice
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -115,13 +120,21 @@ supybot.plugins.Services.ChanServ
.. _conf-supybot.plugins.Services.NickServ:
supybot.plugins.Services.NickServ
This config variable defaults to "NickServ", is network-specific, and is not channel-specific.
Determines what nick the 'NickServ' service has.
.. _conf-supybot.plugins.Services.NickServ.password:
supybot.plugins.Services.NickServ.password
This is a group of:
.. _conf-supybot.plugins.Services.disabledNetworks:
supybot.plugins.Services.disabledNetworks
This config variable defaults to "QuakeNet", is not network-specific, and is not channel-specific.
@ -129,6 +142,7 @@ supybot.plugins.Services.disabledNetworks
.. _conf-supybot.plugins.Services.ghostDelay:
supybot.plugins.Services.ghostDelay
This config variable defaults to "60", is network-specific, and is not channel-specific.
@ -136,6 +150,7 @@ supybot.plugins.Services.ghostDelay
.. _conf-supybot.plugins.Services.nicks:
supybot.plugins.Services.nicks
This config variable defaults to " ", is network-specific, and is not channel-specific.
@ -143,6 +158,7 @@ supybot.plugins.Services.nicks
.. _conf-supybot.plugins.Services.noJoinsUntilIdentified:
supybot.plugins.Services.noJoinsUntilIdentified
This config variable defaults to "False", is network-specific, and is not channel-specific.
@ -150,6 +166,7 @@ supybot.plugins.Services.noJoinsUntilIdentified
.. _conf-supybot.plugins.Services.public:
supybot.plugins.Services.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

11
plugins/ShrinkUrl/README.rst
View File

@ -38,6 +38,7 @@ Configuration
.. _conf-supybot.plugins.ShrinkUrl.bold:
supybot.plugins.ShrinkUrl.bold
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -45,6 +46,7 @@ supybot.plugins.ShrinkUrl.bold
.. _conf-supybot.plugins.ShrinkUrl.default:
supybot.plugins.ShrinkUrl.default
This config variable defaults to "x0", is network-specific, and is channel-specific.
@ -52,6 +54,7 @@ supybot.plugins.ShrinkUrl.default
.. _conf-supybot.plugins.ShrinkUrl.minimumLength:
supybot.plugins.ShrinkUrl.minimumLength
This config variable defaults to "48", is network-specific, and is channel-specific.
@ -59,6 +62,7 @@ supybot.plugins.ShrinkUrl.minimumLength
.. _conf-supybot.plugins.ShrinkUrl.nonSnarfingRegexp:
supybot.plugins.ShrinkUrl.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
@ -66,6 +70,7 @@ supybot.plugins.ShrinkUrl.nonSnarfingRegexp
.. _conf-supybot.plugins.ShrinkUrl.outFilter:
supybot.plugins.ShrinkUrl.outFilter
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -73,6 +78,7 @@ supybot.plugins.ShrinkUrl.outFilter
.. _conf-supybot.plugins.ShrinkUrl.public:
supybot.plugins.ShrinkUrl.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -80,6 +86,7 @@ supybot.plugins.ShrinkUrl.public
.. _conf-supybot.plugins.ShrinkUrl.serviceRotation:
supybot.plugins.ShrinkUrl.serviceRotation
This config variable defaults to " ", is network-specific, and is channel-specific.
@ -87,12 +94,14 @@ supybot.plugins.ShrinkUrl.serviceRotation
.. _conf-supybot.plugins.ShrinkUrl.shrinkSnarfer:
supybot.plugins.ShrinkUrl.shrinkSnarfer
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.
.. _conf-supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain:
.. _conf-supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain:
supybot.plugins.ShrinkUrl.shrinkSnarfer.showDomain
This config variable defaults to "True", is network-specific, and is channel-specific.

31
plugins/Status/README.rst
View File

@ -72,8 +72,39 @@ uptime takes no arguments
Configuration
-------------
.. _conf-supybot.plugins.Status.cpu:
supybot.plugins.Status.cpu
This is a group of:
.. _conf-supybot.plugins.Status.cpu.children:
supybot.plugins.Status.cpu.children
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.
.. _conf-supybot.plugins.Status.cpu.memory:
supybot.plugins.Status.cpu.memory
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.
.. _conf-supybot.plugins.Status.cpu.threads:
supybot.plugins.Status.cpu.threads
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.
.. _conf-supybot.plugins.Status.public:
supybot.plugins.Status.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

29
plugins/String/README.rst
View File

@ -85,10 +85,39 @@ xor <password> <text>
Configuration
-------------
.. _conf-supybot.plugins.String.levenshtein:
supybot.plugins.String.levenshtein
This is a group of:
.. _conf-supybot.plugins.String.levenshtein.max:
supybot.plugins.String.levenshtein.max
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.
.. _conf-supybot.plugins.String.public:
supybot.plugins.String.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.String.re:
supybot.plugins.String.re
This is a group of:
.. _conf-supybot.plugins.String.re.timeout:
supybot.plugins.String.re.timeout
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.

2
plugins/Success/README.rst
View File

@ -58,6 +58,7 @@ Configuration
.. _conf-supybot.plugins.Success.prefixNick:
supybot.plugins.Success.prefixNick
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -65,6 +66,7 @@ supybot.plugins.Success.prefixNick
.. _conf-supybot.plugins.Success.public:
supybot.plugins.Success.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

2
plugins/Time/README.rst
View File

@ -62,6 +62,7 @@ Configuration
.. _conf-supybot.plugins.Time.format:
supybot.plugins.Time.format
This config variable defaults to "%Y-%m-%dT%H:%M:%S%z", is network-specific, and is channel-specific.
@ -69,6 +70,7 @@ supybot.plugins.Time.format
.. _conf-supybot.plugins.Time.public:
supybot.plugins.Time.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

2
plugins/Todo/README.rst
View File

@ -54,6 +54,7 @@ Configuration
.. _conf-supybot.plugins.Todo.allowThirdpartyReader:
supybot.plugins.Todo.allowThirdpartyReader
This config variable defaults to "False", is not network-specific, and is not channel-specific.
@ -61,6 +62,7 @@ supybot.plugins.Todo.allowThirdpartyReader
.. _conf-supybot.plugins.Todo.public:
supybot.plugins.Todo.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

23
plugins/Topic/README.rst
View File

@ -133,6 +133,7 @@ Configuration
.. _conf-supybot.plugins.Topic.allowSeparatorinTopics:
supybot.plugins.Topic.allowSeparatorinTopics
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -140,6 +141,7 @@ supybot.plugins.Topic.allowSeparatorinTopics
.. _conf-supybot.plugins.Topic.alwaysSetOnJoin:
supybot.plugins.Topic.alwaysSetOnJoin
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -147,6 +149,7 @@ supybot.plugins.Topic.alwaysSetOnJoin
.. _conf-supybot.plugins.Topic.default:
supybot.plugins.Topic.default
This config variable defaults to "", is network-specific, and is channel-specific.
@ -154,6 +157,7 @@ supybot.plugins.Topic.default
.. _conf-supybot.plugins.Topic.format:
supybot.plugins.Topic.format
This config variable defaults to "$topic", is network-specific, and is channel-specific.
@ -161,6 +165,7 @@ supybot.plugins.Topic.format
.. _conf-supybot.plugins.Topic.public:
supybot.plugins.Topic.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -168,6 +173,7 @@ supybot.plugins.Topic.public
.. _conf-supybot.plugins.Topic.recognizeTopiclen:
supybot.plugins.Topic.recognizeTopiclen
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -175,6 +181,7 @@ supybot.plugins.Topic.recognizeTopiclen
.. _conf-supybot.plugins.Topic.requireManageCapability:
supybot.plugins.Topic.requireManageCapability
This config variable defaults to "channel,op; channel,halfop", is network-specific, and is channel-specific.
@ -182,6 +189,7 @@ supybot.plugins.Topic.requireManageCapability
.. _conf-supybot.plugins.Topic.separator:
supybot.plugins.Topic.separator
This config variable defaults to " | ", is network-specific, and is channel-specific.
@ -189,8 +197,23 @@ supybot.plugins.Topic.separator
.. _conf-supybot.plugins.Topic.setOnJoin:
supybot.plugins.Topic.setOnJoin
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.
.. _conf-supybot.plugins.Topic.undo:
supybot.plugins.Topic.undo
This is a group of:
.. _conf-supybot.plugins.Topic.undo.max:
supybot.plugins.Topic.undo.max
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.

2
plugins/URL/README.rst
View File

@ -35,6 +35,7 @@ Configuration
.. _conf-supybot.plugins.URL.nonSnarfingRegexp:
supybot.plugins.URL.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
@ -42,6 +43,7 @@ supybot.plugins.URL.nonSnarfingRegexp
.. _conf-supybot.plugins.URL.public:
supybot.plugins.URL.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

147
plugins/Unix/README.rst
View File

@ -85,10 +85,157 @@ wtf [is] <something>
Configuration
-------------
.. _conf-supybot.plugins.Unix.fortune:
supybot.plugins.Unix.fortune
This is a group of:
.. _conf-supybot.plugins.Unix.fortune.command:
supybot.plugins.Unix.fortune.command
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what command will be called for the fortune command.
.. _conf-supybot.plugins.Unix.fortune.equal:
supybot.plugins.Unix.fortune.equal
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.
.. _conf-supybot.plugins.Unix.fortune.files:
supybot.plugins.Unix.fortune.files
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.
.. _conf-supybot.plugins.Unix.fortune.offensive:
supybot.plugins.Unix.fortune.offensive
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.
.. _conf-supybot.plugins.Unix.fortune.short:
supybot.plugins.Unix.fortune.short
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.
.. _conf-supybot.plugins.Unix.ping:
supybot.plugins.Unix.ping
This is a group of:
.. _conf-supybot.plugins.Unix.ping.command:
supybot.plugins.Unix.ping.command
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.
.. _conf-supybot.plugins.Unix.ping.defaultCount:
supybot.plugins.Unix.ping.defaultCount
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.
.. _conf-supybot.plugins.Unix.ping6:
supybot.plugins.Unix.ping6
This is a group of:
.. _conf-supybot.plugins.Unix.ping6.command:
supybot.plugins.Unix.ping6.command
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.
.. _conf-supybot.plugins.Unix.public:
supybot.plugins.Unix.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.
.. _conf-supybot.plugins.Unix.spell:
supybot.plugins.Unix.spell
This is a group of:
.. _conf-supybot.plugins.Unix.spell.command:
supybot.plugins.Unix.spell.command
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.
.. _conf-supybot.plugins.Unix.spell.language:
supybot.plugins.Unix.spell.language
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.
.. _conf-supybot.plugins.Unix.sysuname:
supybot.plugins.Unix.sysuname
This is a group of:
.. _conf-supybot.plugins.Unix.sysuname.command:
supybot.plugins.Unix.sysuname.command
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.
.. _conf-supybot.plugins.Unix.sysuptime:
supybot.plugins.Unix.sysuptime
This is a group of:
.. _conf-supybot.plugins.Unix.sysuptime.command:
supybot.plugins.Unix.sysuptime.command
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.
.. _conf-supybot.plugins.Unix.wtf:
supybot.plugins.Unix.wtf
This is a group of:
.. _conf-supybot.plugins.Unix.wtf.command:
supybot.plugins.Unix.wtf.command
This config variable defaults to "", is not network-specific, and is not channel-specific.
Determines what command will be called for the wtf command.

3
plugins/User/README.rst
View File

@ -104,6 +104,7 @@ Configuration
.. _conf-supybot.plugins.User.customWhoamiError:
supybot.plugins.User.customWhoamiError
This config variable defaults to "", is not network-specific, and is not channel-specific.
@ -111,6 +112,7 @@ supybot.plugins.User.customWhoamiError
.. _conf-supybot.plugins.User.listInPrivate:
supybot.plugins.User.listInPrivate
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -118,6 +120,7 @@ supybot.plugins.User.listInPrivate
.. _conf-supybot.plugins.User.public:
supybot.plugins.User.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

1
plugins/Utilities/README.rst
View File

@ -72,6 +72,7 @@ Configuration
.. _conf-supybot.plugins.Utilities.public:
supybot.plugins.Utilities.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.

33
plugins/Web/README.rst
View File

@ -62,13 +62,37 @@ Configuration
.. _conf-supybot.plugins.Web.checkIgnored:
supybot.plugins.Web.checkIgnored
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.
.. _conf-supybot.plugins.Web.fetch:
supybot.plugins.Web.fetch
This is a group of:
.. _conf-supybot.plugins.Web.fetch.maximum:
supybot.plugins.Web.fetch.maximum
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.
.. _conf-supybot.plugins.Web.fetch.timeout:
supybot.plugins.Web.fetch.timeout
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
.. _conf-supybot.plugins.Web.nonSnarfingRegexp:
supybot.plugins.Web.nonSnarfingRegexp
This config variable defaults to "", is network-specific, and is channel-specific.
@ -76,6 +100,7 @@ supybot.plugins.Web.nonSnarfingRegexp
.. _conf-supybot.plugins.Web.public:
supybot.plugins.Web.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
@ -83,6 +108,7 @@ supybot.plugins.Web.public
.. _conf-supybot.plugins.Web.snarfMultipleUrls:
supybot.plugins.Web.snarfMultipleUrls
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -90,6 +116,7 @@ supybot.plugins.Web.snarfMultipleUrls
.. _conf-supybot.plugins.Web.snarferPrefix:
supybot.plugins.Web.snarferPrefix
This config variable defaults to "Title:", is network-specific, and is channel-specific.
@ -97,6 +124,7 @@ supybot.plugins.Web.snarferPrefix
.. _conf-supybot.plugins.Web.snarferReportIOExceptions:
supybot.plugins.Web.snarferReportIOExceptions
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -104,6 +132,7 @@ supybot.plugins.Web.snarferReportIOExceptions
.. _conf-supybot.plugins.Web.snarferShowDomain:
supybot.plugins.Web.snarferShowDomain
This config variable defaults to "True", is network-specific, and is channel-specific.
@ -111,6 +140,7 @@ supybot.plugins.Web.snarferShowDomain
.. _conf-supybot.plugins.Web.snarferShowTargetDomain:
supybot.plugins.Web.snarferShowTargetDomain
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -118,6 +148,7 @@ supybot.plugins.Web.snarferShowTargetDomain
.. _conf-supybot.plugins.Web.timeout:
supybot.plugins.Web.timeout
This config variable defaults to "5", is not network-specific, and is not channel-specific.
@ -125,6 +156,7 @@ supybot.plugins.Web.timeout
.. _conf-supybot.plugins.Web.titleSnarfer:
supybot.plugins.Web.titleSnarfer
This config variable defaults to "False", is network-specific, and is channel-specific.
@ -132,6 +164,7 @@ supybot.plugins.Web.titleSnarfer
.. _conf-supybot.plugins.Web.urlWhitelist:
supybot.plugins.Web.urlWhitelist
This config variable defaults to " ", is not network-specific, and is not channel-specific.