From e82d9c3dffa4b8fc1d2a3017f6be16504da5eda1 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Fri, 28 Jul 2023 18:55:27 +0200 Subject: [PATCH] Document network-specific configuration values --- use/configuration.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/use/configuration.rst b/use/configuration.rst index 04c364e..026f02e 100644 --- a/use/configuration.rst +++ b/use/configuration.rst @@ -147,8 +147,10 @@ see configuration variables for plugins that are currently loaded or that you loaded in the past; if you've never loaded a plugin there's no way for the bot to know what configuration variables it registers. -Channel-Specific Configuration ------------------------------- +.. _channel-specific-configuration: + +Network- and 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 @@ -163,6 +165,16 @@ using the `Config` plugin's ``list`` command, channel-specific values are preceeded by a '#' character to indicate such (similar to how '@' is used to indicate a group of values). +Similarly, many configuration variables can be specific to individual +networks. This works similarly by substituting ``channel`` with network:: + + @config network supybot.reply.whenAddressedBy.chars ! + jemfinch|lambda: The operation succeeded. + +Network-specific configuration values are preceeded by a ':' character. +As most (if not all) channel-specific values are also network-specific, +they are preceeded by '#:'. + Editing the Configuration Values by Hand ----------------------------------------