]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Document m_delayjoin
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 88427a943f45d0aea301625f1b830c9e2185321c..55b6e2359f208a1e9ea22115a85f699d76f6b741 100644 (file)
 #                                                                     #
 #  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">         #
 #                                                                     #
 #   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   #
 #   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">
 
          sendq="262144"
          recvq="8192"
          localmax="3"
-         globalmax="3">
+         globalmax="3"
+        limit="5000">
 
 <connect deny="69.254.*">
 <connect deny="3ffe::0/32">
 #                  actual server the user is on.                      #
 #                                                                     #
 #  flatlinks     - When you are using m_spanningtree.so, and this     #
-#                  value is set to true, yes or 1, /MAP and /LINKS    #
-#                  will be flattened when shown to a non-oper       #
+#                  value is set to yes, true or 1, /MAP and /LINKS    #
+#                  will be flattened when shown to a non-opers.       #
 #                                                                     #
 #  hideulines    - When you are using m_spanningtree.so, and this     #
-#                  value is set to true, yes or 1, then U-lined       #
-#                  servers will be hidden in /LINKS and /MAP. For non #
+#                  value is set to yes, true or 1, then U-lined       #
+#                  servers will be hidden in /LINKS and /MAP for non  #
 #                  opers. Please be aware that this will also hide    #
 #                  any leaf servers of a U-lined server, e.g. jupes.  #
 #                                                                     #
-#  nouserdns     - If set to 'yes', 'true' or '1', no user dns        #
-#                  lookups will be performed for connecting users.    #
-#                  this can save a lot of resources on very busy irc  #
-#                  servers.                                           #
+#  nouserdns     - If set to yes, true or 1, no user DNS lookups      #
+#                  will be performed for connecting users. This can   #
+#                  save a lot of resources on very busy IRC servers.  #
 #                                                                     #
-#  syntaxhints   - If set to 'yes', 'true' or '1', when a user does   #
-#                  not give enough parameters for a command, a syntax #
+#  syntaxhints   - If set to yes, true or 1, when a user does not     #
+#                  give enough parameters for a command, a syntax     #
 #                  hint will be given (using the RPL_TEXT numeric)    #
 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
 #                                                                     #
-#  announcets    - If this value is defined to 'yes', 'true' or '1',  #
-#                  then if a channel's timestamp is updated the users #
-#                  on the channel will be informed of the change via  #
+#  announcets    - If this value is defined to yes, true or 1, then   #
+#                  a channel's timestamp is updated, the users on     #
+#                  the channel will be informed of the change via     #
 #                  a server notice to the channel with the old and    #
 #                  new TS values in the timestamp. If you think this  #
 #                  is just pointless noise, define the value to 0.    #
         exemptchanops="">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
-# Time synchronisation options for m_spanningtree linking.             #
+# Time synchronisation options for m_spanningtree linking.            #
 #                                                                     #
 # Because IRC is very time and clock dependent, InspIRCd provides its #
-# own methods for synchronisation of time between servers as shown     #
+# own methods for synchronisation of time between servers as shown    #
 # in the example below, for servers that don't have ntpd running.     #
 #                                                                     #
 #  enable    -     If this value is 'yes', 'true', or '1', time       #
 # 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">