]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Fix small typo found by Tyler.
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 9d5434f1b68a0c28503c4ddc998c801584a87bc7..63c05188f3676edaf1c310fe89e52153b777b887 100644 (file)
 #                  new TS values in the timestamp. If you think this  #
 #                  is just pointless noise, define the value to 0.    #
 #                                                                     #
+#  ircumsgprefix - Use undernet style message prefix for channel      #
+#                  NOTICE and PRIVMSG adding the prefix to the line   #
+#                  of text sent out. Eg. NOTICE @#test :@ testing     #
+#                  vs off: NOTICE @#test :testing                     #
+#
 #  notimesync    - If this value is 'yes', 'true', or '1', time       #
 #                  synchronization is disabled on this server. This   #
 #                  means any servers you are linked to will not       #
          nouserdns="no"
          syntaxhints="no"
          cyclehosts="yes"
+         ircumsgprefix="no"
          announcets="yes"
          notimesync="no"
          allowhalfop="yes">
 # 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 #
+# text        -      The text to detect as the actual command line,   #
+#                    Cant contain spaces, but case insensitive.       #
+#                    You may have multiple aliases with the same      #
+#                    command name (text="" value), however the first  #
+#                    found will be executed if its format value is    #
+#                    matched, or it has no format value. Aliases are  #
+#                    read from the top of the file to the bottom.     #
+#                                                                     #
+# format      -      If this is defined, the parameters of the alias  #
+#                    must match this glob pattern. For example if you #
+#                    want the first parameter to start with a # for   #
+#                    the alias to be executed, set format="#*" in the #
+#                    alias definition. Note that the :'s which are    #
+#                    part of IRC formatted lines will be preserved    #
+#                    for matching of this text. This value is         #
+#                    optional.                                        #
+#                                                                     #
 # replace     -      The text to replace 'text' with. Usually this    #
 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
 #                    You may use the variables $1 through $9 in the   #
 #                    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   #
 #                    the user receives a 'no such nick' 401 numeric.  #
+#                                                                     #
 # uline       -      Defining this value with 'yes', 'true' or '1'    #
 #                    will ensure that the user given in 'requires'    #
 #                    must also be on a u-lined server, as well as     #
 #                    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   #
 #<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">
+#
+# An example of using the format value to create an alias with two
+# different behaviours depending on the format of the parameters.
+#
+#<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
+#  requires="ChanServ" uline="yes">
+#
+#<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
+#  requires="NickServ" uline="yes">
+#
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Alltime module: Shows time on all connected servers at once
 #
 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If ypu specify the m_cloaking.so module as above, you    #
+# Optional - If you specify the m_cloaking.so module as above, you    #
 # must define cloak keys, and optionally a cloak prefix as shown      #
 # below. When using cloaking, the cloak keys are MANDITORY and must   #
 # be included. However, if prefix is not included, it will default    #
 
 <exception host="*@ircop.host.com" reason="Opers hostname">
 
+#-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# This optional tag allows you to specify how wide a gline, eline,    #
+# kline, zline or qline can be before it is forbidden from being      #
+# set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
+# no matter how many users the ban would cover. This is not           #
+# recommended! By setting ipmasks="yes", you can allow all Z lines,   #
+# no matter how many users these cover too. Needless to say we        #
+# don't recommend you do this, or, set nickmasks="yes", which will    #
+# allow any qline.                                                    #
+#                                                                     #
+# The trigger value indicates how wide any mask will be before it is  #
+# prevented from being set. The default value is 95.5% if this tag is #
+# not defined in your configuration file, meaning that if your        #
+# network has 1000 users, a gline matching over 955 of them will be   #
+# prevented from being added.                                         #
+#                                                                     #
+# Please note that remote servers (and services) are exempt from      #
+# these restrictions and expected to enforce their own policies       #
+# locally!                                                            #
+#                                                                     #
+
+<insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #   You should already know what to do here :)                        #