summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/conf/modules.conf.example29
1 files changed, 22 insertions, 7 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 2e50977bd..12e2a9ebe 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -2117,15 +2117,30 @@
# To use, SHUN must be in one of your oper class blocks.
#<module name="shun">
#
-# You may also configure which commands you wish a user to be able to
-# perform when shunned. It should be noted that if a shunned user
-# issues QUIT or PART then their message will be removed, as if they
-# did not issue one.
+# Configuration:
#
-# You can optionally let the user know that their command was blocked.
+# affectsopers: Whether server operators are exempt from shuns. This
+# option is deprecated; you should instead give exempt
+# server operators the servers/ignore-shun privilege.
#
-# You may also let SHUN affect opers (defaults to no).
-#<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
+# allowtags: Whether to allow client tags to be attached to enabled
+# commands.
+#
+# cleanedcommands: The commands that, if enabled, should be cleaned
+# of any message content if a shunned user tries to
+# execute them.
+#
+# enabledcommands: The commands that a shunned user is allowed to
+# execute.
+#
+# notifyuser: Whether to notify shunned users that a command they tried
+# to execute has been blocked.
+#
+#<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN"
+# cleanedcommands="AWAY PART QUIT"
+# affectopers="no"
+# allowtags="no"
+# notifyuser="yes">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# SSL mode module: Adds support for TLS (SSL)-only channels via the '+z'