Fix for bug #186 reported by peavey

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

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index 6f9c32d7034f3b427c32d46186071aa2435ad7ba..25cd59a01a8444dd6a523db3b7acc0427d30918c 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -211,7 +211,7 @@
 #   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   #
-#   not be disabled, however it can be set to exremely high values,   #
+#   not be disabled, however it can be set to extremely 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      #
@@ -231,7 +231,7 @@
 #   The optional recvq value is the maximum size which users in this  #
 #   group may grow their receive queue to. This is recommended to be  #
 #   kept pretty low compared to the sendq, as users will always       #
-#   recieve more than they send in normal circumstances. The default  #
+#   receive more than they send in normal circumstances. The default  #
 #   if not specified is 4096.                                         #
 #                                                                     #
 #   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
@@ -308,7 +308,7 @@
 #               what commands. Class names are case sensitive,        #
 #               seperate multiple class names with spaces.            #
 #                                                                     #
-#  host       - optional hostmask operators will recieve on oper-up.  #
+#  host       - optional hostmask operators will receive on oper-up.  #
 #                                                                     #
 #  Syntax is as follows:                                              #
 #                                                                     #
@@ -985,6 +985,16 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block CAPS module: Blocking all-CAPS messages with cmode +P
 #<module name="m_blockcaps.so">
+#                                                                     #
+#-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# percent        - How many percent of text must be caps before text  #
+#                  will be blocked.                                   #
+#                                                                     #
+# minlen         - The minimum length a line must be for the block    #
+#                  percent to have any effect.                        #
+#                                                                     #
+#<blockcaps percent="95" minlen="5">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block colour module: Blocking colour-coded messages with cmode +c
@@ -1041,15 +1051,17 @@
 # be included. However, if prefix is not included, it will default    #
 # to your networks name from the <server> tag.                        #
 #                                                                     #
-# <cloak key1="543241423"                                             #
-#        key2="5378410432"                                            #
-#        key3="1143242382"                                            #
-#        key4="9504324581"                                            #
+# <cloak key1="0x2AF39F40"                                            #
+#        key2="0x78E10B32"                                            #
+#        key3="0x4F2D2E82"                                            #
+#        key4="0x043A4C81"                                            #
 #        prefix="mynet">                                              #
 #                                                                     #
 # Please note that the key values will accept any number, and should  #
 # be large numbers. Using small numbers such as "7" or "1924" will    #
-# seriously weaken the security of your cloak.                        #
+# seriously weaken the security of your cloak. It is recommended you  #
+# use hexdecimal numbers prefixed by "0x", as shown in this example,  #
+# with each key eight hex digits long.                                #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Conn-Lusers: Shows the LUSERS output on connect
@@ -1146,6 +1158,14 @@
 # Devoice Module: Let users devoice themselves.
 #<module name="m_devoice.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# DNS Blacklist Module: Provides support for looking up IPs on one or #
+# more blacklists.                                                    #
+#<module name="m_dnsbl.so">                                           #
+#                                                                     #
+# For configuration options please see the wiki page for m_dnsbl at   #
+# http://inspircd.org/wiki/DNS_Blacklist_Module                       #
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Filter module: Provides glob-based message filtering
 #<module name="m_filter.so">
@@ -1268,6 +1288,16 @@
 # Knock module: adds the /KNOCK command and +K channel mode
 #<module name="m_knock.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
+# used to temporarily close/open for new connections to the server.   #
+# These commands require OPER status and that the LOCKSERV UNLOCKSERV #
+# are specified in a <class> tag that the oper is part of. This is so #
+# you can control who has access to this possible dangerous command.  #
+# If your server is locked and you got disconnected, do a REHASH from #
+# shell to open up again.
+#<module name="m_lockserv.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Msg flood module: Adds message/notice flood protection (+f)
 #<module name="m_messageflood.so">