]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Fix bug#152 reported by smartys
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 2c31849e17553ee57fca84f98d452ad29557f77c..54d97375ff0fac6182771a1909252e38836eb65a 100644 (file)
 #                 into this value. If it is not defined, then only    #
 #                 the ipaddr field of the server shall be allowed.    #
 #                                                                     #
+# failover      - If you define this option, it must be the name of a #
+#                 different link tag in your configuration. This      #
+#                 option causes the ircd to attempt a connection to   #
+#                 the failover link in the event that the connection  #
+#                 to this server fails. For example, you could define #
+#                 two hub uplinks to a leaf server, and set an        #
+#                 american server to autoconnect, with a european     #
+#                 hub as its failover. In this situation, your ircd   #
+#                 will only try the link to the european hub if the   #
+#                 american hub is unreachable. NOTE that for the      #
+#                 intents and purposes of this option, an unreachable #
+#                 server is one which DOES NOT ANSWER THE CONNECTION. #
+#                 If the server answers the connection with accept(), #
+#                 EVEN IF THE CREDENTIALS ARE INVALID, the failover   #
+#                 link will not be tried! Failover settings will also #
+#                 apply to autoconnected servers as well as manually  #
+#                 connected ones.                                     #
+#                                                                     #
 # to u:line a server (give it extra privilages required for running   #
 # services, Q, etc) you must include the <uline server> tag as shown  #
 # in the example below. You can have as many of these as you like.    #
         port="7000"
        allowmask="69.58.44.0/24"
         autoconnect="300"
+       failover="hub.other.net"
         sendpass="outgoing!password"
         recvpass="incoming!password">
 
 #                                                                     #
 # If you have the m_alias.so module loaded, you may also define       #
 # aliases as shown below. They are commonly used to provide shortcut  #
-# commands to services, however they are not limited to jsut this use.#
+# commands to services, however they are not limited to just this use.#
 # An alias tag requires the following values to be defined in it:     #
 #                                                                     #
 # text        -      The text to detect at the start of the line,     #
 #                    must be at the start of the line to trigger the  #
 #                    alias. Cant contain spaces, but case insensitive #
 # replace     -      The text to replace 'text' with. Usually this    #
-#                    will be "PRIVMSG ServiceName" or similar.        #
+#                    will be "PRIVMSG ServiceName :$2-" or similar.   #
+#                    You may use the variables $1 through $9 in the   #
+#                    replace string, which refer to the first through #
+#                    ninth word in the original string typed by the   #
+#                    user. You may also use $1- through $9- which     #
+#                    refer to the first word onwards, through to the  #
+#                    ninth word onwards, e.g. if the user types the   #
+#                    command "foo bar baz qux quz" then $3- will hold #
+#                    "baz qux quz" and $2 will contain "bar". You may #
+#                    also use the special variables: $nick, $ident,   #
+#                    $host and $vhost, and you may seperate multiple  #
+#                    commands with \n. If you wish to use the ACTUAL  #
+#                    characters \ and n together in a line, you must  #
+#                    use the sequence "\\n".                          #
 # requires    -      If you provide a value for 'requires' this means #
 #                    the given nickname MUST be online for the alias  #
 #                    to successfully trigger. If they are not, then   #
 #                    online, but not on a u-lined server, then an     #
 #                    oper-alert is sent out as this is possibly signs #
 #                    of a user trying to impersonate a service.       #
+# operonly    -      Defining this value, with a value of 'yes', '1'  #
+#                    or true will make the alias oper only. If a non- #
+#                    oper attempts to use the alias, it will appear   #
+#                    to not exist.                                    #
 #                                                                     #
-#<alias text="NICKSERV" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
-#<alias text="CHANSERV" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
-#<alias text="NS" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
-#<alias text="CS" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
+#<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+#<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+#<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+#<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
+#<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
+#<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
+#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $3" requires="NickServ" uline="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Antibear security module: Prevents 'bear.txt' based trojans from
 # Conn-Lusers: Shows the LUSERS output on connect
 #<module name="m_conn_lusers.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Conn-Usermodes: Set modes on users when they connect
+# When this module is loaded <connect:allow> tags may have an optional
+# modes="" value, which contains modes to add or remove from users
+# when they connect to the server.
+#<module name="m_conn_umodes.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
 #<module name="m_conn_waitpong.so">
 # Specify the modes as the 'modes' parameter of the <type> tag
 #<module name="m_opermodes.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Parking module: Adds parking support via /PARK and /UNPARK
-#<module name="m_park.so">
-#
-#-#-#-#-#-#-#-#-#-#-#-#   PARK CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
-#                                                                     #
-# m_park.so is too complex it describe here, see the wiki:            #
-# http://www.inspircd.org/wiki/User_Parking_Module                    #
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
 # through a unified API. You must copy the source for this module