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

Merge pull request #12 from Mkaysi/configuration

Browse Source 
doc/use/configuration.rst: multiple changes
This commit is contained in:
Valentin Lorentz 2014-07-25 20:50:26 +02:00
commit e04fe4076a
1 changed files with 13 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
use/configuration.rst
View File

@ -22,8 +22,6 @@ Configuration Registry
---------------------- ----------------------
Now, if you're used to the Windows registry, don't worry, Supybot's Now, if you're used to the Windows registry, don't worry, Supybot's
registry is completely different. For one, it's completely plain text. registry is completely different. For one, it's completely plain text.
There's no binary database sensitive to corruption, it's not necessary
to use another program to edit it--all you need is a simple text editor.
But there is at least one good idea in Windows' registry: hierarchical But there is at least one good idea in Windows' registry: hierarchical
configuration. configuration.
@ -54,14 +52,8 @@ example, let's say you wanted to see what configuration values were
under the `supybot` (the base group) hierarchy. You would simply issue under the `supybot` (the base group) hierarchy. You would simply issue
this command:: this command::
<jemfinch|lambda> @config list supybot <Mikaela> @config list supybot
<supybot> jemfinch|lambda: @abuse, @capabilities, @commands, <Limnoria> #alwaysJoinOnInvite, @abuse, @capabilities, @commands, @databases, @debug, @directories, @drivers, @log, @networks, @nick, @plugins, @protocols, @replies, @reply, @servers, defaultIgnore, defaultSocketTimeout, externalIP, flush, followIdentificationThroughNickChanges, ident, language, pidFile, snarfThrottle, upkeepInterval, and user
@databases, @debug, @directories, @drivers, @log, @networks,
@nick, @plugins, @protocols, @replies, @reply,
alwaysJoinOnInvite, channels, defaultIgnore,
defaultSocketTimeout, externalIP, flush,
followIdentificationThroughNickChanges, ident, pidFile,
snarfThrottle, upkeepInterval, and user
These are all the configuration groups and values 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
@ -131,8 +123,7 @@ variable is, use the ``config default`` command::
Thus, to reset a configuration variable to its default value, you can Thus, to reset a configuration variable to its default value, you can
simply say:: simply say::
<jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars [config <jemfinch|lambda> @config setdefault supybot.reply.whenAddressedBy.chars
default supybot.reply.whenAddressedBy.chars]
<supybot> jemfinch|lambda: The operation succeeded. <supybot> jemfinch|lambda: The operation succeeded.
<jemfinch|lambda> @note that this does nothing <jemfinch|lambda> @note that this does nothing
@ -144,18 +135,11 @@ Now, let's say you want to find all configuration variables that might
be even remotely related to opping. For that, you'll want the ``config be even remotely related to opping. For that, you'll want the ``config
search`` command. Check this out:: search`` command. Check this out::
<jemfinch|lamda> @config search op <Mikaela> @config search op
<supybot> jemfinch|lambda: supybot.plugins.Enforcer.autoOp, <Limnoria> supybot.plugins.AutoMode.op, supybot.plugins.AutoMode.halfop, supybot.plugins.ChannelStatus.topic, supybot.plugins.LinkRelay.topicSync, supybot.plugins.NoLatin1.operator, supybot.plugins.Services.ChanServ.op, supybot.plugins.Services.ChanServ.halfop, supybot.plugins.Topic, supybot.plugins.Topic.public, supybot.plugins.Topic.separator, supybot.plugins.Topic.format, (1 more message)
supybot.plugins.Enforcer.autoHalfop, <Mikaela> @more
supybot.plugins.Enforcer.takeRevenge.onOps, <@Limnoria> supybot.plugins.Topic.recognizeTopiclen, supybot.plugins.Topic.default, supybot.plugins.Topic.alwaysSetOnJoin, supybot.plugins.Topic.undo, supybot.plugins.Topic.undo.max, and supybot.plugins.Topic.requireManageCapability
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.max,
supybot.plugins.Relay.topicSync
Sure, it showed all the topic-related stuff in there, but it also showed Sure, it showed all the topic-related stuff in there, but it also showed
you all the op-related stuff, too. Do note, however, that you can only you all the op-related stuff, too. Do note, however, that you can only
@ -179,8 +163,13 @@ using the `Config` plugin's ``list`` command, channel-specific values are
preceeded by a '#' character to indicate such (similar to how '@' is preceeded by a '#' character to indicate such (similar to how '@' is
used to indicate a group of values). used to indicate a group of values).
Editing the Configuration Values by Hand Editing the Configuration Values by Hand
---------------------------------------- ----------------------------------------
NOTE: **We don't recommend this and you shouln't ever do this, you should
do everything with the commands in the Config plugin.**
Some people might like editing their registry file directly rather than Some people might like editing their registry file directly rather than
manipulating all these things through the bot. For those people, we manipulating all these things through the bot. For those people, we
offer the ``config reload`` command, which reloads both registry offer the ``config reload`` command, which reloads both registry