]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
GACK! you cannot ConfigReader::ReadValue to a const char*! you need to read to a...
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index 2e204b6534392289ff945b40e8bd88333d88cc94..3945a2ece945bb9941bab1a76f524fd40e7e93d0 100644 (file)
 #                  if defined sets a soft maxconnections value, has   #
 #                  to be less than the ./configure maxclients         #
 #                                                                     #
-#  operonlystats - The operonlystats field is optional and specifies  #
-#                  which stats characters in /STATS may only be       #
-#                  requested by an IRC operator. Stats characters in  #
-#                  this field are case sensitive and enforced as      #
-#                  oper-only independent of if they are in a module   #
-#                  or the core.                                       #
+#  userstats     - The userstats field is optional and specifies      #
+#                  which stats characters in /STATS may be requested  #
+#                  by non-operators. Stats characters in this field   #
+#                  are case sensitive and are allowed to users        #
+#                  independent of if they are in a module or the core #
 #                                                                     #
 #  operspywhois  - If this is set then when an IRC operator uses      #
 #                  /WHOIS on a user they will see all channels, even  #
 #                  this can save a lot of resources on very busy irc  #
 #                  servers.                                           #
 #                                                                     #
-#  syntaxhints   - If set to 'yes', 'true' or '1', when a user does    #
+#  syntaxhints   - If set to 'yes', 'true' or '1', when a user does   #
 #                  not give enough parameters for a command, a syntax #
 #                  hint will be given (using the RPL_TEXT numeric)    #
 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
 #                                                                     #
+#  announcets    - If this value is defined to 'yes', 'true' or '1',  #
+#                  then if a channel's timestamp is updated the users #
+#                  on the channel will be informed of the change via  #
+#                  a server notice to the channel with the old and    #
+#                  new TS values in the timestamp. If you think this  #
+#                  is just pointless noise, define the value to 0.    #
+#                                                                     #
 
 <options prefixquit="Quit: "
          loglevel="default"
          noservices="0"
          qaprefixes="0"
          somaxconn="128"
-         softlimit="128"
-         operonlystats="oclgkz"
+         softlimit="12800"
+         userstats="Pu"
          operspywhois="no"
          customversion=""
          maxtargets="20"
         nouserdns="no"
         syntaxhints="no"
         cyclehosts="yes"
+        announcets="yes"
          allowhalfop="yes">
 
 
 #                                                                     #
 # 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
 #<connflood seconds="30" maxconns="3" timeout="30"
 #   quitmsg="Throttled" bootwait="10">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# DCCALLOW module: Adds the /DCCALLOW command
+#<module name="m_dccallow.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
+#  blockchat         - Whether to block DCC CHAT as well as DCC SEND
+#  length            - Default duration of entries in DCCALLOW list
+#  action            - Default action to take if no action is specified
+#                      can be 'block' or 'allow'
+#
+# File configuration:
+#  pattern           - The glob pattern to match against
+#  action            - Action to take if a user attempts to send a file
+#                      that matches this pattern, can be 'block' or 'allow'
+#
+#<dccallow blockchat="yes" length="5m" action="block">
+#<banfile pattern="*.exe" action="block">
+#<banfile pattern="*.txt" action="allow">
+#
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Deny Channels: Deny Channels from being used by users
 #<module name="m_denychans.so"> 
 #<http ip="192.168.1.10" host="brainwave" port="32006"
 #      index="/home/brain/inspircd/http/index.html">
 #
+# You may have as many of these tags as you wish, each with a different
+# IP, port, host or index file. Each one will act as an independent
+# HTTP server.
+#
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # http stats module: Provides basic stats pages over HTTP
 # Requires m_httpd.so to be loaded for it to function.
-#<module name="m_http_stats.so">
+#<module name="m_httpd_stats.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
 #