From: Peter Powell <petpow@saberuk.com>
Date: Thu, 24 Jan 2019 15:23:17 +0000 (+0000)
Subject: Merge the censor module example config into modules.conf.example.
X-Git-Url: https://git.netwichtig.de/gitweb/?a=commitdiff_plain;h=1ab93cf7026d690f47dcd4af068049838ae92533;p=user%2Fhenk%2Fcode%2Finspircd.git

Merge the censor module example config into modules.conf.example.
---

diff --git a/docs/conf/censor.conf.example b/docs/conf/censor.conf.example
deleted file mode 100644
index 23924d14b..000000000
--- a/docs/conf/censor.conf.example
+++ /dev/null
@@ -1,12 +0,0 @@
-# Configuration file for the censor module
-
-# The tags for this module are formatted as follows:
-#
-# <badword text="simple word"
-#          replace="text to replace with">
-#
-# You can specify <badword text="simple word" replace="">
-# to block lines containing the word
-
-<badword text="shit" replace="poo">
-<badword text="fuck" replace="(censored)">
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 980d0d6a5..ba674d2bd 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -312,16 +312,21 @@
 #<module name="cban">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Censor module: Adds channel and user mode +G.
+# Censor module: Adds channel and user mode +G which block phrases that
+# are listed in the server bad words list.
 #<module name="censor">
 #
 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If you specify to use the censor module, then you must   #
-# specify some censor tags. See also:                                 #
-# https://wiki.inspircd.org/Modules/3.0/censor                        #
-#
-#<include file="examples/censor.conf.example">
+# If you have the censor module loaded you should specify one or more #
+# phrases to replace/block in user messages. The config for this is   #
+# formatted as follows:                                               #
+#                                                                     #
+# Replaces "eggplant" with "aubergine" within messages:               #
+# <badword text="eggplant" replace="aubergine">                       #
+#                                                                     #
+# Blocks messages that contain "fluffy capybaras":                    #
+#<badword text="fluffy capybaras">                                    #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CGI:IRC module: Enables forwarding the real IP address of a user from