Document m_delayjoin

[user/henk/code/inspircd.git] / docs / inspircd.conf.example

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index e37c07b8a07d4534ada1da4e3a6d62b09626f07b..55b6e2359f208a1e9ea22115a85f699d76f6b741 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -211,11 +211,11 @@
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                                                                     #
-#       <connect name="myallow" allow="1.2.3.0/24"                    #
+#       <connect name="myallow" allow="1.2.3.0/24" limit="5"          #
 #                password="blahblah" timeout="10" timeout="blah"      #
 #                flood="5" threshold="8" pingfreq="120" sendq="99999" #
 #                revcq="696969" localmax="3" globalmax="3"            #
-#                port="6660" maxchans="50">                           #
+#                port="6660" maxchans="50" limit="999">               #
 #                                                                     #
 #       <connect name="blocked" deny="127.0.0.1" port="6667">         #
 #                                                                     #
@@ -241,6 +241,10 @@
 #   specifies the amount of time given before an unknown connection   #
 #   is closed if USER/NICK/PASS are not given. This value is in secs. #
 #                                                                     #
+#   You may optionally limit the number of clients that are matched   #
+#   by a single <connect> tag by specifying the maximum in the limit  #
+#   parameter. If set to 0, there is no limit, which is the default.  #
+#                                                                     #
 #   You should also include a flood="x" line which indicates          #
 #   the number of lines a user may place into their buffer at once    #
 #   before they are disconnected for excess flood. This feature can   #
@@ -288,6 +292,11 @@
 #   only incoming connections on the specified port will match. Port  #
 #   tags may be used on connect allow and connect deny tags.          #
 #                                                                     #
+#   The limit value determines the maximum number of users which may  #
+#   be in this class. Combine this with CIDR masks for various ISP    #
+#   subnets to limit the number of users which may connect at any one #
+#   time from a certain ISP. Omit this value to not limit the tag.    #
+#                                                                     #
 
 <connect allow="196.12.*"  password="secret" port="6667">
 
@@ -299,7 +308,8 @@
          sendq="262144"
          recvq="8192"
          localmax="3"
-         globalmax="3">
+         globalmax="3"
+        limit="5000">
 
 <connect deny="69.254.*">
 <connect deny="3ffe::0/32">
@@ -1504,6 +1514,14 @@
 # channel messages and channel notices.
 #<module name="m_deaf.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Delay join module: Adds the channel mode +D which delays all JOIN
+# messages from users until they speak. If they quit or part before
+# speaking, their quit or part message will not be shown to the channel
+# which helps cut down noise on large channels in a more friendly way
+# than the auditorium mode. Only channel ops may set the +D mode.
+#<module name="m_delayjoin.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Deny Channels: Deny Channels from being used by users
 #<module name="m_denychans.so">