summaryrefslogtreecommitdiff
path: root/conf
diff options
context:
space:
mode:
Diffstat (limited to 'conf')
-rw-r--r--conf/inspircd.conf.example5
-rw-r--r--conf/modules.conf.example4
2 files changed, 8 insertions, 1 deletions
diff --git a/conf/inspircd.conf.example b/conf/inspircd.conf.example
index d5c9874df..47ecd5889 100644
--- a/conf/inspircd.conf.example
+++ b/conf/inspircd.conf.example
@@ -71,6 +71,10 @@
# Variables may be redefined and may reference other variables. #
# Value expansion happens at the time the tag is read. #
# #
+# Using variable definitions REQUIRES that the config format be #
+# changed to "xml" from the default "compat" that uses escape #
+# sequences such as "\"" and "\n", and does not support <define> #
+<config format="xml">
<define name="bindip" value="1.2.2.3">
<define name="localips" value="&bindip;/24">
@@ -478,6 +482,7 @@
# prefixpart: What (if anything) a users' part message
# should be prefixed with.
prefixpart="&quot;"
+ # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
# suffixpart: What (if anything) a users' part message
# should be suffixed with.
diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index e9a306e3f..91e45eb91 100644
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -126,7 +126,9 @@
# "baz qux quz" and $2 will contain "bar". You may #
# also use the special variables: $nick, $ident, #
# $host and $vhost, and you may separate multiple #
-# commands with a newline (&nl;). #
+# commands with a newline (which can be written in #
+# the file literally, or encoded as &nl; or \n #
+# depending on the config format setting). #
# #
# requires - If you provide a value for 'requires' this means #
# the given nickname MUST be online for the alias #