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

Fixed a few out of date things in CONFIGURATION and updated the DocBook

Browse Source 
translation of it.
This commit is contained in:
Daniel DiPaolo 2004-09-05 04:51:57 +00:00
parent 06ce162bd4
commit 6a4567df32
2 changed files with 78 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/CONFIGURATION
View File

@ -44,33 +44,19 @@ under the "supybot" (the base group) hierarchy. You would simply
issue this command: issue this command:
<jemfinch|lambda> @config list supybot <jemfinch|lambda> @config list supybot
<supybot> jemfinch|lambda: alwaysJoinOnInvite, capabilities, channels, <supybot> @capabilities, @commands, @databases, @debug, @directories, @drivers,
defaultIgnore, defaultSocketTimeout, externalIP, flush, @log, @networks, @nick, @plugins, @protocols, @replies, @reply,
followIdentificationThroughNickChanges, alwaysJoinOnInvite, channels, defaultIgnore, defaultSocketTimeout,
humanTimestampFormat, ident, networks, nick, pidFile, externalIP, flush, followIdentificationThroughNickChanges,
snarfThrottle, upkeepInterval, and user 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 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 "supybot." appended on to the front of them, but it is omitted in the
listing in order to shorten the output. 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
Now, to see all of the available configuration groups under the base the configuration values.
"supybot" group, we simply use the "--groups" flag to config list:
<jemfinch|lambda> @config list --groups supybot
<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.
Okay, now that you've used the Config plugin to list configuration Okay, now that you've used the Config plugin to list configuration
variables, it's time that we start looking at individual variables and 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 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 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 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: do this:
<jemfinch|lambda> @config help supybot.reply.whenAddressedBy.chars <jemfinch|lambda> @config help supybot.snarfThrottle
<supybot> jemfinch|lambda: A floating point number of seconds to throttle snarfed
<supybot> jemfinch|lambda: Determines what prefix characters the bot URLs, in order to prevent loops between two bots snarfing the same URLs and
will reply to. A prefix character is a single character that having the snarfed URL in the output of the snarf message. (Current value:
the bot will use to determine what messages are addressed to 10.0)
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:
@)
Pretty simple, eh? Pretty simple, eh?

117
docs/DocBook/configuration.sgml
View File

@ -29,6 +29,11 @@
<date>26 Feb 2004</date> <date>26 Feb 2004</date>
<revremark>Conversion to Supybot DTD</revremark> <revremark>Conversion to Supybot DTD</revremark>
</revision> </revision>
<revision>
<revnumber>0.3</revnumber>
<date>4 Sep 2004</date>
<revremark>Update Docbook translation</revremark>
</revision>
</revhistory> </revhistory>
</articleinfo> </articleinfo>
<sect1> <sect1>
@ -47,8 +52,8 @@
<plugin>Config</plugin> plugin provides a way to get or set <plugin>Config</plugin> plugin provides a way to get or set
variables, to list the available variables, and even to get help variables, to list the available variables, and even to get help
for certain variables. Take a moment now to read the help for for certain variables. Take a moment now to read the help for
each of those commands: <botcommand>get</botcommand>, each of those commands: <botcommand>config</botcommand>,
<botcommand>set</botcommand>, <botcommand>list</botcommand>, and <botcommand>list</botcommand>, and
<botcommand>help</botcommand>. If you don't know how to get help on <botcommand>help</botcommand>. If you don't know how to get help on
those commands, go ahead and read our those commands, go ahead and read our
<filename>GETTING_STARTED</filename> document before this one. <filename>GETTING_STARTED</filename> document before this one.
@ -104,51 +109,26 @@
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config list supybot &lt;jemfinch|lambda&gt; @config list supybot
&lt;supybot&gt; jemfinch|lambda: nick, ident, user, server, password, &lt;supybot&gt; @capabilities, @commands, @databases, @debug, @directories, @drivers,
channels, prefixChars, defaultCapabilities, defaultAllow, defaultIgnore, @log, @networks, @nick, @plugins, @protocols, @replies, @reply,
humanTimestampFormat, externalIP, pipeSyntax, alwaysJoinOnInvite, channels, defaultIgnore, defaultSocketTimeout,
followIdentificationThroughNickChanges, alwaysJoinOnInvite, externalIP, flush, followIdentificationThroughNickChanges,
showSimpleSyntax, maxHistoryLength, nickmods, throttleTime, humanTimestampFormat, ident, pidFile, snarfThrottle, upkeepInterval,
snarfThrottle, threadAllCommands, pingServer, pingInterval, and user
upkeepInterval, flush, httpPeekSize, and defaultSocketTimeout
</ircsession> </ircsession>
<para> <para>
These are all the configuration values you can set which These are all the configuration groups and values which
are under the base <registrygroup>supybot</registrygroup> are under the base <registrygroup>supybot</registrygroup>
group. Actually, their full names would each have a group. Actually, their full names would each have a
&ldquo;supybot.&rdquo; appended on to the front of them, &ldquo;supybot.&rdquo; appended on to the front of them,
but it is omitted in the listing in order to shorten the 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.
</para> </para>
<para>
Now, to see all of the available configuration groups
under the base <registrygroup>supybot</registrygroup>
group, we simply use the <flag>--groups</flag> flag to
<botcommand>config list</botcommand>:
</para>
<ircsession>
&lt;jemfinch|lambda&gt; @config list --groups supybot
&lt;supybot&gt; jemfinch|lambda: commands, databases, directories, drivers,
log, plugins, replies, and reply
</ircsession>
<para>
These are all the subgroups of
<registrygroup>supybot</registrygroup>. Again, the full
name of these would have &ldquo;supybot.&rdquo; prepended
to them. So really, we have
<registrygroup>supybot.commands</registrygroup>,
<registrygroup>supybot.databases</registrygroup>, etc.
</para>
<note>
<para>
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.
</para>
</note>
</sect3> </sect3>
<sect2>
<title>Supybot's registry</title>
<sect3> <sect3>
<title>Dealing with registry values</title> <title>Dealing with registry values</title>
<para> <para>
@ -167,15 +147,15 @@
help string for any value or group, simply use the help string for any value or group, simply use the
<botcommand>config help</botcommand> command. For <botcommand>config help</botcommand> command. For
example, to see what this example, to see what this
<registrygroup>supybot.prefixChars</registrygroup> <registrygroup>supybot.snarfThrottle</registrygroup>
configuration variable is all about, we'd do this: configuration variable is all about, we'd do this:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config help supybot.prefixChars &lt;jemfinch|lambda&gt; @config help supybot.snarfThrottle
&lt;supybot&gt; jemfinch|lambda: Determines what prefix characters the bot &lt;supybot&gt; jemfinch|lambda: A floating point number of seconds to throttle snarfed
will reply to. A prefix character is a single character that the bot will URLs, in order to prevent loops between two bots snarfing the same URLs and
use to determine what messages are addressed to it; when there are no having the snarfed URL in the output of the snarf message. (Current value:
prefix characters set, it just uses its nick. 10.0)
</ircsession> </ircsession>
<para> <para>
Pretty simple, eh? Pretty simple, eh?
@ -191,7 +171,7 @@
value of: value of:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config supybot.prefixChars &lt;jemfinch|lambda&gt; @config supybot.reply.whenAddressedBy.chars
&lt;supybot&gt; jemfinch|lambda: '@' &lt;supybot&gt; jemfinch|lambda: '@'
</ircsession> </ircsession>
<para> <para>
@ -199,14 +179,14 @@
the name: the name:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config supybot.prefixChars @$ &lt;jemfinch|lambda&gt; @config supybot.reply.whenAddressedBy.chars @$
&lt;supybot&gt; jemfinch|lambda: The operation succeeded. &lt;supybot&gt; jemfinch|lambda: The operation succeeded.
</ircsession> </ircsession>
<para> <para>
Now, check this out: Now, check this out:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; $config supybot.prefixChars &lt;jemfinch|lambda&gt; $config supybot.reply.whenAddressedBy.chars
&lt;supybot&gt; jemfinch|lambda: '@$' &lt;supybot&gt; jemfinch|lambda: '@$'
</ircsession> </ircsession>
<para> <para>
@ -225,7 +205,7 @@
I'll revert the change: I'll revert the change:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; $config supybot.prefixChars @ &lt;jemfinch|lambda&gt; $config supybot.reply.whenAddressedBy.chars @
&lt;supybot&gt; jemfinch|lambda: The operation succeeded. &lt;supybot&gt; jemfinch|lambda: The operation succeeded.
&lt;jemfinch|lambda&gt; $note that this makes no response. &lt;jemfinch|lambda&gt; $note that this makes no response.
</ircsession> </ircsession>
@ -235,7 +215,7 @@
default</botcommand> command: default</botcommand> command:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config default supybot.prefixChars &lt;jemfinch|lambda&gt; @config default supybot.reply.whenAddressedBy.chars
&lt;supybot&gt; jemfinch|lambda: '' &lt;supybot&gt; jemfinch|lambda: ''
</ircsession> </ircsession>
<para> <para>
@ -243,8 +223,8 @@
value, you can simply say: value, you can simply say:
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config supybot.prefixChars [config default &lt;jemfinch|lambda&gt; @config supybot.reply.whenAddressedBy.chars [config default
supybot.prefixChars] supybot.reply.whenAddressedBy.chars]
&lt;supybot&gt; jemfinch|lambda: The operation succeeded. &lt;supybot&gt; jemfinch|lambda: The operation succeeded.
&lt;jemfinch|lambda&gt; @note that this does nothing &lt;jemfinch|lambda&gt; @note that this does nothing
</ircsession> </ircsession>
@ -263,11 +243,18 @@
</para> </para>
<ircsession> <ircsession>
&lt;jemfinch|lambda&gt; @config search op &lt;jemfinch|lambda&gt; @config search op
&lt;supybot&gt; jemfinch|lambda: supybot.plugins.Enforcer.autoOp, &lt;supybot&gt; jemfinch|lambda:
supybot.plugins.Enforcer.autoOp.#supybot, supybot.plugins.Enforcer.autoOp,
supybot.plugins.Enforcer.autoHalfop, supybot.plugins.Enforcer.autoHalfop,
supybot.plugins.Enforcer.cycleToGetOps, supybot.plugins.Topic, supybot.plugins.Enforcer.takeRevenge.onOps,
supybot.plugins.Topic.separator, and supybot.plugins.Relay.topicSync 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
</ircsession> </ircsession>
<para> <para>
Sure, it showed up all the topic-related stuff in there, Sure, it showed up all the topic-related stuff in there,
@ -297,6 +284,24 @@
occur. occur.
</para> </para>
</sect3> </sect3>
<sect3>
<title>Channel-specific configuration</title>
<para>
Many configuration variables can be specific to individual
channels. The <plugin>Config</plugin> 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:
</para>
<ircsession>
config channel supybot.reply.whenAddressedBy.chars !
</ircsession>
<para>
That'll set the prefix chars in the channel that message
is sent in to <literal>!</literal>. Voila,
channel-specific values!
</para>
</sect3>
</sect2> </sect2>
</sect1> </sect1>
<sect1> <sect1>