Added support for module-defined chanmodes with no parameters

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

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index 3402a2c6053963a4304cf2ea73d96dea9a282f1a..00de3d415ce95dd41c3710d36a1a79906766cea7 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -55,15 +55,28 @@
 #                                                                    #
 #  bind address - specifies which the address which ports bind       # 
 #  port                - opens an unused port                                #
+#  type         - can be 'clients' or 'servers'. The clients type is  #
+#                 a standard tcp based socket, the servers type is a  #
+#                 UDP based connection.                               #
+#  default      - if the port type is 'servers' then this can be      #
+#                 specified. If set to 'yes', it indicates that this  #
+#                 port is the default route for all /connect commands.#
+#                 if you do not bind your default route to an         #
+#                 external ip, or all ip's, you may have connection   #
+#                 problems.                                           #
 #                                                                    #
 #  Leaving address empty binds to all available interfaces            #
 #                                                                    #
 #  Syntax is as follows:                                              #
-#      <bind address="ip number" port="port number">                 #
+#                                                                     #
+# <bind address="ip number" port="port" type="clients">                      #
+# <bind address="ip number" port="port" type="servers">                      #
+# <bind address="ip number" port="port" type="servers" default="yes"> #
 #                                                                    #
 
-<bind address="" port="6667">
-<bind address="" port="7000">
+<bind address="" port="6660" type="clients">
+<bind address="" port="7000" type="servers" default="yes">
+<bind address="" port="7001" type="servers">
 
 
 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
@@ -73,7 +86,7 @@
 #   need this ability should know the die and restart password.       #
 #                                                                     #
 #  Syntax is as follows:                                              #
-#       <power diepass="die password" restartpass="restart password"
+#       <power diepass="die password" restartpass="restart password"  #
 #       pause="secs before dying">                                   #
 #                                                                     #
 
@@ -164,7 +177,31 @@
         type="NetAdmin">
 
 
-#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION   -#-#-#-#-#-#-#-#-#-
+#-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# Defines which servers can link to this one, and which servers this  #
+# server may create outbound links to.                                #
+#                                                                     #
+# name      - The name is the canocial name of the server, it does    #
+#             not have to resolve - but it is expected to be sent in  #
+#             the remote servers connection info.                     #
+# ipaddr    - Valid ip address for remote server.                     #
+# port      - Valid listening UDP port for remote server.             #
+# sendpass  - Password to send to create an outbound connection to    #
+#             this server.                                            #
+# recvpass  - Password to receive to accept an inbound connection     #
+#             from this server.                                       #
+#                                                                     #
+
+<link name="hub.penguin.org"
+       ipaddr="12.34.56.78"
+       port="7000"
+       sendpass="outgoing!password"
+       recvpass="incoming!password">
+
+
+
+#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                    #
 #   These options let you define the path to your motd and rules      #
 #   files.                                                           #
@@ -189,15 +226,16 @@
 #   Settings to define which features are useable on your server.     #
 #                                                                    #
 #  prefixquit   - a prefix for a client's quit message                #
-#  debug        - provides an in-depth log file,                      #
-#                 this should not need to be enabled                  #
+#  loglevel     - specifies what detail of messages to log in the     #
+#                 log file. You may select from debug, verbose,       #
+#                 default, sparse and none.                           #
 #  allowhalfop  - allows the +h channel mode                         #
 #  allowprotect - allows the +a channel mode                         #
 #  allowfounder - allows the +q channel mode                         #
 #                                                                    #
 
 <options prefixquit="Quit: "
-        debug="off"
+        loglevel="default"
         allowhalfop="yes"
         allowprotect="yes"
         allowfounder="yes">