diff --git a/docs/CONFIGURATION b/docs/CONFIGURATION index 0507565ef..e61716729 100644 --- a/docs/CONFIGURATION +++ b/docs/CONFIGURATION @@ -44,33 +44,19 @@ under the "supybot" (the base group) hierarchy. You would simply issue this command: @config list supybot - jemfinch|lambda: alwaysJoinOnInvite, capabilities, channels, - defaultIgnore, defaultSocketTimeout, externalIP, flush, - followIdentificationThroughNickChanges, - humanTimestampFormat, ident, networks, nick, pidFile, - snarfThrottle, upkeepInterval, and user + @capabilities, @commands, @databases, @debug, @directories, @drivers, + @log, @networks, @nick, @plugins, @protocols, @replies, @reply, + alwaysJoinOnInvite, channels, defaultIgnore, defaultSocketTimeout, + externalIP, flush, followIdentificationThroughNickChanges, + humanTimestampFormat, ident, pidFile, snarfThrottle, upkeepInterval, + and user -These are all the configuration values you can set which are under the +These are all the configuration groups and values which are under the base "supybot" group. Actually, their full names would each have a "supybot." appended on to the front of them, but it is omitted in the -listing in order to shorten the output. - -Now, to see all of the available configuration groups under the base -"supybot" group, we simply use the "--groups" flag to config list: - - @config list --groups supybot - jemfinch|lambda: capabilities, commands, databases, debug, - directories, drivers, log, networks, nick, plugins, - protcols, replies, and reply - -These are all the subgroups of "supybot". Again, the full name of -these would have "supybot." prepended to them. So really, we have -supybot.commands, supybot.databases, etc. - -Note: an item can show up in both lists if it is a group that itself -has a value. For example, all plugins fall under this category, as -their value is a boolean value determining whether or not that plugin -is to be loaded when the bot is started. +listing in order to shorten the output. The first entries in the output are +the groups (distinguished by the @ symbol in front of them), and the rest are +the configuration values. Okay, now that you've used the Config plugin to list configuration variables, it's time that we start looking at individual variables and @@ -81,20 +67,14 @@ each configuration variable is that they all have an associated help string to tell you what they represent. So the first command we'll cover is "config help". To see the help string for any value or group, simply use the "config help" command. For example, to see what -this "supybot.prefixChars" configuration variable is all about, we'd +this "supybot.snarfThrottle" configuration variable is all about, we'd do this: - @config help supybot.reply.whenAddressedBy.chars - - jemfinch|lambda: Determines what prefix characters the bot - will reply to. A prefix character is a single character that - the bot will use to determine what messages are addressed to - it; when there are no prefix characters set, it just uses - its nick. Each character in this string is interpreted - individually; you can have multiple prefix chars - simultaneously, and if any one of them is used as a prefix - the bot will assume it is being addressed. (Current value: - @) + @config help supybot.snarfThrottle + jemfinch|lambda: A floating point number of seconds to throttle snarfed + URLs, in order to prevent loops between two bots snarfing the same URLs and + having the snarfed URL in the output of the snarf message. (Current value: + 10.0) Pretty simple, eh? diff --git a/docs/DocBook/configuration.sgml b/docs/DocBook/configuration.sgml index e719dac76..7e6fda860 100644 --- a/docs/DocBook/configuration.sgml +++ b/docs/DocBook/configuration.sgml @@ -29,6 +29,11 @@ 26 Feb 2004 Conversion to Supybot DTD + + 0.3 + 4 Sep 2004 + Update Docbook translation + @@ -47,8 +52,8 @@ Config plugin provides a way to get or set variables, to list the available variables, and even to get help for certain variables. Take a moment now to read the help for - each of those commands: get, - set, list, and + each of those commands: config, + list, and help. If you don't know how to get help on those commands, go ahead and read our GETTING_STARTED document before this one. @@ -104,51 +109,26 @@ <jemfinch|lambda> @config list supybot -<supybot> jemfinch|lambda: nick, ident, user, server, password, - channels, prefixChars, defaultCapabilities, defaultAllow, defaultIgnore, - humanTimestampFormat, externalIP, pipeSyntax, - followIdentificationThroughNickChanges, alwaysJoinOnInvite, - showSimpleSyntax, maxHistoryLength, nickmods, throttleTime, - snarfThrottle, threadAllCommands, pingServer, pingInterval, - upkeepInterval, flush, httpPeekSize, and defaultSocketTimeout +<supybot> @capabilities, @commands, @databases, @debug, @directories, @drivers, + @log, @networks, @nick, @plugins, @protocols, @replies, @reply, + alwaysJoinOnInvite, channels, defaultIgnore, defaultSocketTimeout, + externalIP, flush, followIdentificationThroughNickChanges, + humanTimestampFormat, ident, pidFile, snarfThrottle, upkeepInterval, + and user - These are all the configuration values you can set which + These are all the configuration groups and values which are under the base supybot group. Actually, their full names would each have a “supybot.” appended on to the front of them, but it is omitted in the listing in order to shorten the - output. + output. The first entries in the output are the groups + (distinguished by the @ symbol in front of them), and the + rest are the configuration values. - - Now, to see all of the available configuration groups - under the base supybot - group, we simply use the --groups flag to - config list: - - -<jemfinch|lambda> @config list --groups supybot -<supybot> jemfinch|lambda: commands, databases, directories, drivers, - log, plugins, replies, and reply - - - These are all the subgroups of - supybot. Again, the full - name of these would have “supybot.” prepended - to them. So really, we have - supybot.commands, - supybot.databases, etc. - - - - An item can show up in both lists if it is a group - that itself has a value. For example, all plugins - fall under this category, as their value is a boolean - value determining whether or not that plugin is to be - loaded when the bot is started. - - + + Supybot's registry Dealing with registry values @@ -167,15 +147,15 @@ help string for any value or group, simply use the config help command. For example, to see what this - supybot.prefixChars + supybot.snarfThrottle configuration variable is all about, we'd do this: -<jemfinch|lambda> @config help supybot.prefixChars -<supybot> jemfinch|lambda: Determines what prefix characters the bot - will reply to. A prefix character is a single character that the bot will - use to determine what messages are addressed to it; when there are no - prefix characters set, it just uses its nick. +<jemfinch|lambda> @config help supybot.snarfThrottle +<supybot> jemfinch|lambda: A floating point number of seconds to throttle snarfed + URLs, in order to prevent loops between two bots snarfing the same URLs and + having the snarfed URL in the output of the snarf message. (Current value: + 10.0) Pretty simple, eh? @@ -191,7 +171,7 @@ value of: -<jemfinch|lambda> @config supybot.prefixChars +<jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars <supybot> jemfinch|lambda: '@' @@ -199,14 +179,14 @@ the name: -<jemfinch|lambda> @config supybot.prefixChars @$ +<jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars @$ <supybot> jemfinch|lambda: The operation succeeded. Now, check this out: -<jemfinch|lambda> $config supybot.prefixChars +<jemfinch|lambda> $config supybot.reply.whenAddressedBy.chars <supybot> jemfinch|lambda: '@$' @@ -225,7 +205,7 @@ I'll revert the change: -<jemfinch|lambda> $config supybot.prefixChars @ +<jemfinch|lambda> $config supybot.reply.whenAddressedBy.chars @ <supybot> jemfinch|lambda: The operation succeeded. <jemfinch|lambda> $note that this makes no response. @@ -235,7 +215,7 @@ default command: -<jemfinch|lambda> @config default supybot.prefixChars +<jemfinch|lambda> @config default supybot.reply.whenAddressedBy.chars <supybot> jemfinch|lambda: '' @@ -243,8 +223,8 @@ value, you can simply say: -<jemfinch|lambda> @config supybot.prefixChars [config default - supybot.prefixChars] +<jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars [config default + supybot.reply.whenAddressedBy.chars] <supybot> jemfinch|lambda: The operation succeeded. <jemfinch|lambda> @note that this does nothing @@ -263,11 +243,18 @@ <jemfinch|lambda> @config search op -<supybot> jemfinch|lambda: supybot.plugins.Enforcer.autoOp, - supybot.plugins.Enforcer.autoOp.#supybot, - supybot.plugins.Enforcer.autoHalfop, - supybot.plugins.Enforcer.cycleToGetOps, supybot.plugins.Topic, - supybot.plugins.Topic.separator, and supybot.plugins.Relay.topicSync +<supybot> jemfinch|lambda: + supybot.plugins.Enforcer.autoOp, + supybot.plugins.Enforcer.autoHalfop, + supybot.plugins.Enforcer.takeRevenge.onOps, + supybot.plugins.Enforcer.cycleToGetOps, + supybot.plugins.Topic, supybot.plugins.Topic.public, + supybot.plugins.Topic.separator, + supybot.plugins.Topic.format, + supybot.plugins.Topic.recognizeTopiclen, + supybot.plugins.Topic.default, + supybot.plugins.Topic.undo.maz, and + supybot.plugins.Relay.topicSync Sure, it showed up all the topic-related stuff in there, @@ -297,6 +284,24 @@ occur. + + Channel-specific configuration + + Many configuration variables can be specific to individual + channels. The Config plugin provides an + easy way to configure something for a specific channel; + for instance, in order to set the prefix chars for a + specific channel, do this in that channel: + + +config channel supybot.reply.whenAddressedBy.chars ! + + + That'll set the prefix chars in the channel that message + is sent in to !. Voila, + channel-specific values! + +