Fixed false example info in config.

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

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index a470f1466558eb355cf57a4b65a5bcd2f931e7ea..ac48be1ee6db277afc30d5805f9a599c5c9077f5 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -11,7 +11,7 @@
 #         This is an example of the config file for InspIRCd.          #
 #             Change the options to suit your network                  #
 #                                                                     #
-#                 Last updated on : 05/29/2005                         #
+#                 Last updated on : 06/06/2005                         #
 #                 Written by      : CC  (cc@backchat.co.za)            #
 #                 Updated by      : katsklaw (katsklaw@gmail.com)      #
 ########################################################################
@@ -94,6 +94,21 @@
 <power diepass="diepass" restartpass="restartpass" pause="2">
 
 
+#-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# This optional tag allows you to include another config file         #
+# allowing you to keep your configuration tidy. The configuration     #
+# file you include will be treated as part of the configuration file  #
+# which includes it, in simple terms the inclusion is transparent.    #
+#                                                                     #
+# All paths to config files are relative to the directory of the main #
+# config file inspircd.conf, unless the filename starts with a forward#
+# slash (/) in which case it is treated as an absolute path.          #
+#                                                                     #
+# Syntax is as follows:                                               #
+#       <include file="file.conf">                                    #
+#                                                                     #
+
 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
 #                                                                    #
 #   This is where you can configure which connections are allowed     #
@@ -365,6 +380,10 @@
 #                  the location where modules are to be found. This   #
 #                  does not add a supplementary directory. There can  #
 #                  only be one module path.                           #
+#  softlimit     - This optional feature allows a defined softlimit.  #
+#                  if defined sets a soft maxconnections value, has   #
+#                  to be less than the ./configure maxclients         #
+#                                                                     #
 
 <options prefixquit="Quit: "
         loglevel="default"
@@ -372,7 +391,8 @@
          maxwho="128"
         noservices="0"
          somaxconn="128"
-        allowhalfop="yes">
+        softlimit="128"
+         allowhalfop="yes">
 
 
 
@@ -620,7 +640,7 @@
 # Optional - If you specify to use the m_filter.so module, then       #
 # specfiy below the path to the filter.conf file.                     #
 
-<filter file="/path/to/inspircd/filter.conf">
+#<filter file="/path/to/inspircd/filter.conf">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
@@ -628,7 +648,8 @@
 # Optional - If you specify to use the m_helpop.so module, then       #
 # specify below the path to the helpop.conf file.                     #
 
-<helpop file="/path/to/inspircd/helpop.conf">
+<die value="If you used the helpop include above then do *NOT* use this tag.">
+#<helpop file="/path/to/inspircd/helpop.conf">
 
 
 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
@@ -636,7 +657,7 @@
 # Optional - If you specify to use the m_randquotes.so module, then   #
 # specify below the path to the randquotes.conf file.                 #
 
-# <randquote file="/path/to/inspircd/randquotes.conf">
+#<randquote file="/path/to/inspircd/randquotes.conf">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #