summaryrefslogtreecommitdiff
path: root/docs/conf/modules.conf.example
diff options
context:
space:
mode:
Diffstat (limited to 'docs/conf/modules.conf.example')
-rw-r--r--docs/conf/modules.conf.example8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index 76563fbeb..84e3b26ab 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -943,6 +943,14 @@
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# Knock module: adds the /KNOCK command and +K channel mode
#<module name="m_knock.so">
+# This setting specifes what to do when someone successfully /KNOCKs.
+# If set to "notice", then a NOTICE will be sent to the channel.
+# This is the default and the compatible setting, as it requires no
+# special support from the clients.
+# If set to "numeric" then a 710 numeric will be sent to the channel.
+# This allows easier scripting but not all clients support it.
+# If set to "both" then (surprise!) both will be sent.
+#<knock notify="notice">
#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
# LDAP authentication module: Adds the ability to authenticate users #