- Minor documentation updates here, someone really needs to sit down and rework it...

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

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index a1ae0bbe9f33483f96a2b356c49466f2ec2948e3..f20f0c255a995d2a4f89ea0e619833789397c67c 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -37,7 +37,10 @@
 #   something new or different to this version and you SHOULD READ IT. #
 #                                                                      #
 ########################################################################
-
+#                                                                      #
+#         Unalphabeticalise the modules list at your own risk          #
+#                                                                      #
+########################################################################
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
@@ -160,12 +163,14 @@
 #                                                                     #
 #   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. The default is to  #
-#   DISABLE this feature. A recommended value is 10. A counter is     #
-#   maintained for each user which is reset every 'threshold' seconds #
-#   and specifying this threshold value with threshold="X" indicates  #
-#   how often the counter is reset. For example, with flood="5" and   #
-#   threshold="8", the user may not send more than 5 lines in 8 secs. #
+#   before they are disconnected for excess flood. This feature can   #
+#   not be disabled, however it can be set to exremely high values,   #
+#   rendering it effectively disabled. A recommended value is 10.     #
+#   A counter is maintained for each user which is reset every        #
+#   'threshold' seconds and specifying this threshold value with      #
+#   threshold="X" indicates how often the counter is reset. For       #
+#   example, with flood="5" and threshold="8", the user may not send  #
+#   more than 5 lines in 8 secs.                                      #
 #                                                                     #
 #   You may optionally specify the sendq size and ping frequency of   #
 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
@@ -189,7 +194,7 @@
 #   that of the user... Just to clear up any confusion or complaints  #
 #   that these are backwards :p                                       #
 #                                                                     #
-#   The maxlocal and maxglobal values can be used to enforce local    #
+#   The localmax and globalmax values can be used to enforce local    #
 #   and global session limits on connections. The session limits are  #
 #   counted against all users, but applied only to users within the   #
 #   class. For example, if you had a class 'A' which has a session    #
@@ -201,7 +206,7 @@
 #                                                                     #
 
 <connect allow="196.12.*"  password="secret">
-<connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096" maxlocal="3" maxglobal="3">
+<connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096" localmax="3" globalmax="3">
 
 <connect deny="69.254.*">
 
@@ -381,8 +386,8 @@
 #   files.                                                            #
 #                                                                     #
 
-<files  motd="/home/cc/inspircd/conf/inspire.motd"
-        rules="/home/cc/inspircd/conf/inspire.rules">
+<files  motd="/home/cc/inspircd/conf/inspircd.motd"
+        rules="/home/cc/inspircd/conf/inspircd.rules">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
@@ -640,6 +645,23 @@
 # Ban except module: Adds support for channel ban exceptions (+e)
 #<module name="m_banexception.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Block amsg module: Attempt to block all usage of /amsg and /ame
+#<module name="m_blockamsg.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# If you have the m_blockamsg.so module loaded, you can configure it  #
+# with the <blockamsg> tag:                                           #
+#                                                                     #
+# delay          -   How many seconds between two messages to force   #
+#                    them to be recognised as unrelated.              #
+# action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
+#                    or 'killopers'. Define how to take action when   #
+#                    a user uses /amsg or /ame.                       #
+#
+#<blockamsg delay="3" action="killopers">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block colour module: Blocking colour-coded messages with cmode +c
 #<module name="m_blockcolor.so">