X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=docs%2Fconf%2Fmodules.conf.example;h=97d69da90477b77dac16bae68e3d2419d1bc0c5a;hb=748b3a0d89e7ecc9a766471b79fb78f63a5ca2bb;hp=5552d33f8b98afc6855933a6304bbc3a11dc90cb;hpb=9fc6f1eac580c9114e0f6ed83233683fb16a5e3f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index 5552d33f8..97d69da90 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -22,11 +22,12 @@ # To link servers to InspIRCd, you MUST load the m_spanningtree # # module. If you don't do this, server links will NOT work at all. # # This is by design, to allow for the implementation of other linking # -# protocols in modules in the future. # +# protocols in modules in the future. This module is at the bottom of # +# this file. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# MD5 Module - Allows other modules to generate MD5 hashes, usually for +# MD5 module: Allows other modules to generate MD5 hashes, usually for # cryptographic uses and security. # # IMPORTANT: @@ -36,7 +37,7 @@ # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SHA256 Module - Allows other modules to generate SHA256 hashes, +# SHA256 module: Allows other modules to generate SHA256 hashes, # usually for cryptographic uses and security. # # IMPORTANT: @@ -47,33 +48,28 @@ # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes, +# RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes, # usually for cryptographic uses and security. -# +# # IMPORTANT: # Other modules may rely on this module being loaded to function. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Abbreviation module: Provides the ability to abbreviate commands a-la +# Abbreviation module: Provides the ability to abbreviate commands a-la # BBC BASIC keywords. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Alias module: Allows you to define server-side command aliases +# Alias module: Allows you to define server-side command aliases. # # -# Fantasy settings: -# +# Set the 'prefix' for in-channel aliases (fantasy commands) to the +# specified character. If not set, the default is "!". +# If 'allowbots' is disabled, +B clients will not be able to use +# fantasy commands. If not set, the default is no. # # -# prefix: -# Set the prefix for in-channel aliases (fantasy commands) to the -# specified character. If not set, the default is "!". -# allowbots: -# If this is set to no, +B clients will not be able to use fantasy -# commands. If not set, the default is no. -# #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_alias.so module loaded, you may also define # @@ -81,8 +77,8 @@ # 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 as the actual command line, # -# Cant contain spaces, but case insensitive. # +# text - The text to detect as the actual command line. # +# Can't 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 # @@ -127,18 +123,17 @@ # 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 # -# actually being on the network. If the user is # -# 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. # +# uline - Setting this to true will ensure that the user # +# given in 'requires' is also on a u-lined server, # +# as well as actually being on the network. If the # +# user is online, but not on a u-lined server, # +# then an oper alert is sent out as this is # +# possibly a sign 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. # +# operonly - If true, this will make the alias oper only. # +# If a non-oper attempts to use the alias, it will # +# appear to not exist. # # # # # @@ -184,12 +179,12 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Allowinvite module: Gives channel mode +A to allow all users to use -# /invite, and extban A to deny invite from specific masks +# /INVITE, and extban A to deny invite from specific masks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Alltime module: Shows time on all connected servers at once. -# This module is oper-only and provides /alltime. +# This module is oper-only and provides /ALLTIME. # To use, ALLTIME must be in one of your oper class blocks. # @@ -210,16 +205,20 @@ # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel # # Exemptchanops can be used to adjust the level at which users become visible or -# the level at which they can see the full membe list of the channel. +# the level at which they can see the full member list of the channel. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Autoop module: Adds basic channel access controls via the +w listmode. -# For example, +w o:R:Brain will op anyone identified to the account "Brain" -# on join. +# For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask +# on join. This can be combined with extbans, for example +w o:R:Brain +# will op anyone identified to the account "Brain". +# Another useful combination is with SSL client certificate +# fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will +# give halfop to the user(s) having the given certificate. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ban except module: Adds support for channel ban exceptions (+e) +# Ban except module: Adds support for channel ban exceptions (+e). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -228,7 +227,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block amsg module: Attempt to block all usage of /amsg and /ame +# Block amsg module: Attempt to block all usage of /amsg and /ame. # # #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -245,9 +244,9 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block CAPS module: Blocking all-CAPS messages with cmode +B +# Block CAPS module: Adds channel mode +B, blocks all-CAPS messages. # -# # +# #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # percent - How many percent of text must be caps before text # @@ -256,31 +255,32 @@ # minlen - The minimum length a line must be for the block # # percent to have any effect. # # # -# capsmap - A list of chars to be considered CAPS, this was # -# you can add CAPS for your language. Also you can # -# add things like ! and space to further lock down # -# on caps usage. # +# capsmap - A list of chars to be considered CAPS. Can be used # +# to add CAPS characters for your language. Also you # +# can add things like ! and space to further lock # +# down on caps usage. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Block color module: Blocking color-coded messages with cmode +c +# Block color module: Blocking color-coded messages with chan mode +c. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Botmode module: Adds the user mode +B +# Botmode module: Adds the user mode +B. If set on a user, it will +# show that the user is a bot in /WHOIS. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CallerID module: Adds usermode +g which activates hybrid-style -# callerid (== block all private messages unless you /accept first) +# CallerID module: Adds usermode +g which activates hybrid-style +# callerid: block all private messages unless you /ACCEPT first. # -# +# #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# -# maxaccepts - Maximum number of entires a user can add to his # -# /accept list. Default is 16 entries. # -# operoverride - Can opers (note: ALL opers) ignore callerid mode? # +# maxaccepts - Maximum number of entries a user can add to his # +# /ACCEPT list. Default is 16 entries. # +# operoverride - Can opers (note: ALL opers) override callerid? # # Default is no. # # tracknick - Preserve /accept entries when a user changes nick? # # If no (the default), the user is removed from # @@ -294,18 +294,19 @@ # cooldown="60"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CAP module: Provides the CAP negotiation mechanism seen in -# ratbox-derived ircds +# CAP module: Provides the CAP negotiation mechanism required by the +# m_sasl, m_namesx, m_uhnames, and m_ircv3 modules. +# It is also recommended for the STARTTLS support in m_ssl_gnutls. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CBAN module: Lets you disallow channels from being used at runtime. -# This module is oper-only and provides /cban. +# This module is oper-only and provides /CBAN. # To use, CBAN must be in one of your oper class blocks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Censor module: Adds channel and user mode +G +# Censor module: Adds channel and user mode +G. # # #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# @@ -314,7 +315,7 @@ # specify some censor tags. See also: # # http://wiki.inspircd.org/Modules/censor # # -# +# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # CGI:IRC module: Adds support for automatic host changing in CGI:IRC @@ -328,7 +329,7 @@ # will be connecting to your network, and an optional cgiirc tag. # For more information see: http://wiki.inspircd.org/Modules/cgiirc # -# Set to yes if you want to notice opers when CGI clients connect +# Set to yes if you want to notice opers when CGI:IRC clients connect. # # # The type field indicates where the module should get the real @@ -336,27 +337,25 @@ # CGI:IRC documentation. # # Old style: -# # Get IP from PASS -# # Get IP from ident -# # See the docs +# # Get IP from PASS +# # Get IP from ident +# # See the docs # New style: # # Get IP from WEBIRC +# mask="somebox.example.com"> # Get IP from WEBIRC # # IMPORTANT NOTE: # --------------- # # When you connect CGI:IRC clients, there are two connect classes which # apply to these clients. When the client initially connects, the connect -# class which matches the cgi:irc site's host is checked. Therefore you +# class which matches the CGI:IRC site's host is checked. Therefore you # must raise the maximum local/global clients for this ip as high as you # want to allow cgi clients. After the client has connected and is # determined to be a cgi:irc client, the class which matches the client's # real IP is then checked. You may set this class to a lower value, so that # the real IP of the client can still be restricted to, for example, 3 # sessions maximum. -# - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Channel create module: Adds snomask +j, which will notify opers of @@ -365,8 +364,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel filter module: Allows channel-op defined message -# filtering using simple string matches (channel mode +g) +# Channel filter module: Allows channel-op defined message filtering +# using simple string matches (channel mode +g). # # # If hidemask is set to yes, the user will not be shown the mask when @@ -374,7 +373,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel History module: Displays the last 'X' lines of chat to a user +# Channel history module: Displays the last 'X' lines of chat to a user # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep # lines in the history buffer. Designed so that the new user knows what # the current topic of conversation is when joining the channel. @@ -387,7 +386,7 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel logging module: used to send snotice output to channels, to +# Channel logging module: Used to send snotice output to channels, to # allow staff to centrally monitor and discuss network activity. # # The "channel" field is where you want the messages to go, "snomasks" @@ -397,8 +396,8 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel Names module: Allows disabling channels which have certain -# characters in the channel name such as bold, colorcodes, etc which +# Channel names module: Allows disabling channels which have certain +# characters in the channel name such as bold, colorcodes, etc. which # can be quite annoying and allow users to on occasion have a channel # that looks like the name of another channel on the network. # @@ -413,16 +412,19 @@ allowrange=""> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channelban: Implements extended ban j:, which stops anyone in already -# in a channel matching a mask like +b j:#channel*mask from joining. +# Channelban: Implements extended ban j:, which stops anyone already +# in a channel matching a ban like +b j:#channel*mask from joining. +# Note that by default wildcard characters * and ? are allowed in +# channel names. To disallow them, load m_channames and add characters +# 42 and 63 to denyrange (see above). # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Chanprotect module: gives +q and +a channel modes +# Chanprotect module: Gives +q and +a channel modes. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CHGHOST module: Adds the /CHGHOST command +# CHGHOST module: Adds the /CHGHOST command. # This module is oper-only. # To use, CHGHOST must be in one of your oper class blocks. # NOTE: Services will not be able to set vhosts on users if this module @@ -465,35 +467,35 @@ # specify your own custom list of chars with the tag: # # # # charmap - A list of chars accepted as valid by the /CHGHOST # -# and /SETHOST commands. Also note that the list is # +# and /SETHOST commands. Also note that the list is # # case-sensitive. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CHGIDENT module: Adds the /CHGIDENT command +# CHGIDENT module: Adds the /CHGIDENT command. # This module is oper-only. # To use, CHGIDENT must be in one of your oper class blocks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# CHGNAME module: Adds the /CHGNAME command +# CHGNAME module: Adds the /CHGNAME command. # This module is oper-only. # To use, CHGNAME must be in one of your oper class blocks. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Cloaking module: Adds usermode +x and cloaking support. -# Relies on the module m_md5.so being loaded before m_cloaking.so in -# the configuration file. -# To use, you should enable m_conn_umodes and add +x as -# an enabled mode. See the m_conn_umodes module for more information. +# Relies on the module m_md5.so being loaded. +# To cloak users when they connect, load m_conn_umodes and set +# to include the +x mode. The example tag +# shows this. See the m_conn_umodes module for more information. # # #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# If you specify the m_cloaking.so module as above, you must define # -# cloak keys, and optionally a cloak prefix as shown below. The cloak # -# keys must be shared across the network for correct cloaking. # +# To use m_cloaking, you must define a cloak key, and optionally a # +# cloak prefix as shown below. The cloak key must be shared across # +# the network for correct cloaking. # # # # There are four methods of cloaking: # # # @@ -502,22 +504,21 @@ # or /48 subnet of the IPv6 address. # # # # full Cloak the users completely, using three slices for # -# common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) # +# common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). # # # # These methods use a single key that can be any length of text. # # An optional prefix may be specified to mark cloaked hosts. # # # # The following methods are maintained for backwards compatibility; # -# they are slightly less secure, and always hide unresolved IPs # +# they are slightly less secure, and always hide unresolved IPs. # # # -# compat-host InspIRCd 1.2-compatible host-based cloaking # -# compat-ip InspIRCd 1.2-compatible ip-always cloaking # +# compat-host InspIRCd 1.2-compatible host-based cloaking. # +# compat-ip InspIRCd 1.2-compatible ip-always cloaking. # # # -# You must specify key1, key2, key3, key4 for the compat cloaking # -# modes; the values must be less than 0x80000000 and should be picked # -# at random. Prefix is mandatory, will default to network name if not # -# specified, and will always have a "-" appended. # -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# If you use a compat cloaking mode then you must specify key1, key2, # +# key3, key4; the values must be less than 0x80000000 and should be # +# picked at random. Prefix is mandatory, will default to network name # +# if not specified, and will always have a "-" appended. # # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Clones module: Adds an oper command /CLONES for detecting cloned -# users. Warning: This module may be resource intensive when its -# command is issued, use with care. +# users. Warning: This command may be resource intensive when it is +# issued, use with care. # This module is oper-only. # To use, CLONES must be in one of your oper class blocks. # @@ -544,26 +545,27 @@ # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Join: Allows you to force users to join one or more channels -# automatically upon connecting to the server. +# Auto join on connect module: Allows you to force users to join one +# or more channels automatically upon connecting to the server. # # #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # If you have m_conn_join.so loaded, you can configure it using the -# follow values: +# following values, or set autojoin="#chat,#help" in blocks. # # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Usermodes: Set modes on users when they connect -# When this module is loaded tags may have an optional -# modes="" value, which contains modes to add or remove from users -# when they connect to the server. +# Set modes on connect module: When this module is loaded +# blocks may have an optional modes="" value, which contains modes to +# add or remove from users when they connect to the server. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Conn-Wait-for-Pong: Don't let a user connect until they PONG +# Wait for PONG on connect module: Send a PING to all connecting users +# and don't let them connect until they reply with a PONG. +# This is useful to stop certain kinds of bots and proxies. # # #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -571,38 +573,40 @@ # If you have the m_conn_waitpong.so module loaded, configure it with # # the tag: # # # -# sendsnotice - Whether to send a snotice on connect, like other # -# older ircds # +# sendsnotice - Whether to send a helpful notice to users on # +# connect telling them how to connect, should # +# their client not reply PONG automatically. # # # # killonbadreply - Whether to kill the user if they send the wrong # # PONG reply. # # # # - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Channel cycle module. Server side /hop, with +ilk etc bypass. +# Channel cycle module: Adds the /CYCLE command which is a server-side +# /HOP that bypasses restrictive modes. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Connectban: Provides IP connection throttling. Any IP range that connects -# too many times (configurable) in an hour is zlined for a (configurable) -# duration, and their count resets to 0. +# Connectban: Provides IP connection throttling. Any IP range that +# connects too many times (configurable) in an hour is Z-Lined for a +# (configurable) duration, and their count resets to 0. +# # -# ipv4cidr and ipv6cidr allow you to turn the comparison from individual -# IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling -# over whole ISPs/blocks of IPs, which may be needed to prevent attacks. +# ipv4cidr and ipv6cidr allow you to turn the comparison from +# individual IP addresses (32 and 128 bits) into CIDR masks, to allow +# for throttling over whole ISPs/blocks of IPs, which may be needed to +# prevent attacks. # +# This allows for 10 connections in an hour with a 10 minute ban if +# that is exceeded. # -# This allows for 10 connections in an hour with a 10 minute ban if that is exceeded. -# -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Connection throttle module. Configuration: +# Connection throttle module. # # -#-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +#-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # seconds, maxconns - Amount of connections per . # # timeout - Time to wait after the throttle was activated @@ -619,66 +623,69 @@ # quitmsg="Throttled" bootwait="10"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Custom prefixes : allows for channel prefixes to be added. -# This can replace m_chanprotect and m_halfop, except for services that -# recognise those modules by name +# Custom prefixes: Allows for channel prefixes to be added. +# This replaces m_chanprotect and m_halfop. # # -# name The name of the mode, must be unique from other modes +# name The name of the mode, must be unique from other modes. # letter The letter used for this mode. Required. # prefix The prefix used for nicks with this mode. Not required. -# rank A numeric rank for this prefix, defining what permissions it gives -# VOICE_VALUE is 10000, HALFOP_VALUE is 20000, OP_VALUE is 30000 +# rank A numeric rank for this prefix, defining what permissions it gives. +# The rank of voice, halfop and op is 10000, 20000, and 30000, +# respectively. # ranktoset The numeric rank required to set/unset this mode. Defaults to rank. # depriv Can you remove the mode from yourself? Defaults to yes. # -# +# # # +# +# Do /RELOADMODULE m_customprefix.so after changing the settings of this module. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Custom title module: Adds the /TITLE command which allows for trusted -# users to gain a custom whois line and a optional -# vhost can be specified. +# users to gain a custom whois line and an optional vhost can be +# specified. # # #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-# -# name - The username used to identify -# password - The password used to identify -# hash - The hash for the specific user's password (optional) -# m_password_hash.so and a hashing module must be loaded for this to work -# host - Allowed hostmask [optional] -# title - Title shown in whois -# vhost - Displayed host [optional] +# name - The username used to identify. +# password - The password used to identify. +# hash - The hash for the specific user's password (optional). +# m_password_hash.so and a hashing module must be loaded +# for this to work. +# host - Allowed hostmask (optional). +# title - Title shown in whois. +# vhost - Displayed host (optional). # # -#<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat"> +#<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org"> #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# DCCALLOW module: Adds the /DCCALLOW command +# 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' +# 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'. +# maxentries - Max number of nicks to allow on a DCCALLOW list. # # File configuration: -# pattern - The glob pattern to match against +# 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' +# that matches this pattern, can be 'block' or +# 'allow'. # -#<dccallow blockchat="yes" length="5m" action="block"> +#<dccallow blockchat="yes" length="5m" action="block" maxentries="20"> #<banfile pattern="*.exe" action="block"> #<banfile pattern="*.txt" action="allow"> -# -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Deaf module: adds support for ircu style usermode +d - deaf to -# channel messages and channel notices. +# Deaf module: Adds support for the usermode +d - deaf to channel +# messages and channel notices. #<module name="m_deaf.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -692,42 +699,41 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Delay message module: Adds the channel mode +d which disallows a user # from talking in the channel unless they've been joined for X seconds. -# Settable a la: /mode +d 30 +# Settable using /MODE #chan +d 30 #<module name="m_delaymsg.so"> +# Set allownotice to no to disallow NOTICEs too. Defaults to yes. +#<delaymsg allownotice="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Deny Channels: Deny Channels from being used by users -#<module name="m_denychans.so"> +# Deny channels module: Deny channels from being used by users. +#<module name="m_denychans.so"> # #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-# # # # If you have the m_denychans.so module loaded, you need to specify # # the channels to deny: # # # -# name - The channel name to deny. (glob masks are ok) # -# # +# name - The channel name to deny (glob masks are ok). # # allowopers - If operators are allowed to override the deny. # -# # # reason - Reason given for the deny. # -# # -# redirect - Redirect the user to a different channel # +# redirect - Redirect the user to a different channel. # # # #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> # -#<badchan name="#heaven" redirect="#hell" reason="Nice try!"> # +#<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> # # # # Redirects will not work if the target channel is set +L. # # # # Additionally, you may specify channels which are allowed, even if # # a badchan tag specifies it would be denied: # -#<goodchan name="#godsleeps"> # -# Glob masks are accepted here also. +#<goodchan name="#funtimes"> # +# Glob masks are accepted here also. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Devoice Module: Let users devoice themselves. +# Devoice module: Let users devoice themselves using /DEVOICE #chan. #<module name="m_devoice.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# DNS Blacklist Module: Provides support for looking up IPs on one or # +# DNS blacklist module: Provides support for looking up IPs on one or # # more blacklists. # #<module name="m_dnsbl.so"> # # # @@ -735,14 +741,14 @@ # http://wiki.inspircd.org/Modules/dnsbl # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Exempt Channel Operators Module: Provides support for allowing # +# Exempt channel operators module: Provides support for allowing # # channel operators to be exempt from some channel modes. Supported # # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, # # filter, regmoderated, nonick, nonotice, and stripcolor. # #<module name="m_exemptchanops.so"> # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Filter module: Provides message filtering, similar to SPAMFILTER. +# Filter module: Provides message filtering, similar to SPAMFILTER. # #<module name="m_filter.so"> # # # This module depends upon a regex provider such as m_regex_pcre or # @@ -751,11 +757,13 @@ # # # Valid engines are: # # # -# glob - Glob patterns, provided via m_regex_glob.so # -# pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre # -# tre - TRE regexps, provided via m_regex_tre.so, requires libtre # -# posix - POSIX regexps, provided via m_regex_posix.so, not availale # -# on windows, no dependencies on other operating systems. # +# glob - Glob patterns, provided via m_regex_glob. # +# pcre - PCRE regexps, provided via m_regex_pcre, needs libpcre. # +# tre - TRE regexps, provided via m_regex_tre, requires libtre. # +# posix - POSIX regexps, provided via m_regex_posix, not available # +# on Windows, no dependencies on other operating systems. # +# stdlib - stdlib regexps, provided via m_regex_stdlib, see comment # +# at the <module> tag for info on availability. # # # #<filteropts engine="glob"> # # # @@ -767,19 +775,20 @@ #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_filter module, then # -# specfiy below the path to the filter.conf file, or define some # +# specify below the path to the filter.conf file, or define some # # <filter> tags. # # # -#<include file="conf/filter.conf"> +#<include file="conf/examples/filter.conf.example"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Gecosban: Implements extended ban r:, which stops anyone matching +# Gecos ban: Implements extended ban 'r', which stops anyone matching # a mask like +b r:*realname?here* from joining a channel. #<module name="m_gecosban.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # GeoIP module: Allows the server admin to match users by country code. -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_geoip.cpp # and run make install, then uncomment this module to enable it. # This module requires GeoIP to be installed on your system, # use your package manager to find the appropriate packages @@ -799,7 +808,7 @@ # classes for them to match. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Globops module: gives /GLOBOPS and SNOMASK +g +# Globops module: Provides the /GLOBOPS command and snomask +g. # This module is oper-only. # To use, GLOBOPS must be in one of your oper class blocks. #<module name="m_globops.so"> @@ -807,8 +816,8 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Global load module: Allows loading and unloading of modules network- # wide (USE WITH EXTREME CAUTION!) -# This module is oper-only and provides /gloadmodule, /gunloadmodule -# and /greloadmodule. +# This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE +# and /GRELOADMODULE. # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE # must be in one of your oper class blocks. #<module name="m_globalload.so"> @@ -818,50 +827,47 @@ #<module name="m_halfop.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# HELPOP module: Provides the /HELPOP command +# HELPOP module: Provides the /HELPOP command. #<module name="m_helpop.so"> # #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # -# Optional - If you specify to use the m_helpop.so module, then # -# specify below the path to the helpop.conf file, or if you like to # -# make a mess, define your helpop tags in this conf. # -# # -#<include file="conf/inspircd.helpop-full.example"> +# If you specify to use the m_helpop.so module, then specify below # +# the path to the helpop.conf file. # +#<include file="conf/examples/inspircd.helpop-full.example"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# HIDECHANS module: Allows opers to hide their channels list from non- +# Hide chans module: Allows users to hide their channels list from non- # opers by setting user mode +I on themselves. #<module name="m_hidechans.so"> # -# HIDECHANS can optionally prevent opers from seeing channels on a +I +# This mode can optionally prevent opers from seeing channels on a +I # user, for more privacy if set to true. # This setting is not recommended for most mainstream networks. #<hidechans affectsopers="false"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# HIDEOPER module: Allows opers to hide their oper status from non- +# Hide oper module: Allows opers to hide their oper status from non- # opers by setting user mode +H on themselves. # This module is oper-only. #<module name="m_hideoper.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Hostchange module: Allows a different style of cloaking +# Hostchange module: Allows a different style of cloaking. #<module name="m_hostchange.so"> # #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-# # # -# Optional - If you choose to use the m_hostchange.so module. # -# Config Help - See http://wiki.inspircd.org/Modules/hostchange # +# See http://wiki.inspircd.org/Modules/hostchange for help. # # # -#<host suffix="polarbears.org" separator="." prefix=""> -#<hostchange mask="*@fbi.gov" action="addnick"> -#<hostchange mask="*r00t@*" action="suffix"> -#<hostchange mask="a@b.com" action="set" value="blah.blah.blah"> +#<host suffix="invalid.org" separator="." prefix=""> +#<hostchange mask="*@42.theanswer.example.org" action="addnick"> +#<hostchange mask="*root@*" action="suffix"> +#<hostchange mask="a@example.com" action="set" value="foo.bar.baz"> #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# httpd module: Provides http server support for InspIRCd +# httpd module: Provides HTTP server support for InspIRCd. #<module name="m_httpd.so"> # #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# @@ -870,39 +876,38 @@ # a <bind> tag with type "httpd", and load at least one of the other # m_httpd_* modules to provide pages to display. # +# You can adjust the timeout for HTTP connections below. All HTTP +# connections will be closed after (roughly) this many seconds. +#<httpd timeout="20"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# http ACL module: Provides access control lists for m_httpd dependent +# HTTP ACL module: Provides access control lists for m_httpd dependent # modules. Use this module to restrict pages by IP address and by # password. -# #<module name="m_httpd_acl.so"> # #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # Restrict access to the m_httpd_stats module to all but the local # network and when the correct password is specified: -# # <httpdacl path="/stats*" types="password,whitelist" -# username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*"> -# -# Deny all connections to all but the main index page: +# username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*"> # +# Deny all connections to all but the main index page: # <httpdacl path="/*" types="blacklist" blacklist="*"> -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# http config module: Allows the server's configuration to be viewed -# over HTTP. Requires m_httpd.so to be loaded for it to function. +# HTTP config module: Allows the configuration of the server to be +# viewed over HTTP. Requires m_httpd.so to be loaded for it to function. #<module name="m_httpd_config.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# http stats module: Provides basic stats pages over HTTP +# HTTP stats module: Provides basic stats pages over HTTP. # Requires m_httpd.so to be loaded for it to function. #<module name="m_httpd_stats.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ident: Provides RFC 1413 ident lookup support +# Ident: Provides RFC 1413 ident lookup support. # When this module is loaded <connect:allow> tags may have an optional # useident="yes|no" boolean value, determining whether or not to lookup # ident on users matching that connect tag. @@ -912,24 +917,43 @@ # # # Optional - If you are using the m_ident.so module, then you can # # specify the timeout for ident lookups here. If not defined, it will # -# default to one second. This is a non-blocking timeout which holds # +# default to 5 seconds. This is a non-blocking timeout which holds # # the user in a 'connecting' state until the lookup is complete. # # The bind value indicates which IP to bind outbound requests to. # -# # +# #<ident timeout="5"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Invite except module: Adds support for channel invite exceptions (+I) +# Invite exception module: Adds support for channel invite exceptions +# (+I). #<module name="m_inviteexception.so"> -# Does a +I bypass channel +k in addition to +i? +# bypasskey: If this is enabled, exceptions will bypass +k as well as +i #<inviteexception bypasskey="yes"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Join flood module: Adds support for join flood protection (+j) +# IRCv3 module: Provides the following IRCv3.1 extensions: +# extended-join, away-notify and account-notify. These are optional +# enhancements to the client-to-server protocol. An extension is only +# active for a client when the client specifically requests it, so this +# module needs m_cap to work. +# +# Further information on these extensions can be found at the IRCv3 +# working group website: +# http://ircv3.org/extensions/ +# +#<module name="m_ircv3.so"> +# The following block can be used to control which extensions are +# enabled. Note that extended-join can be incompatible with m_delayjoin +# and host cycling. +#<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on"> + +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Join flood module: Adds support for join flood protection +j X:Y. +# Closes the channel for 60 seconds if X users join in Y seconds. #<module name="m_joinflood.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Jump Server module: Adds support for the RPL_REDIR numeric +# Jump server module: Adds support for the RPL_REDIR numeric. # This module is oper-only. # To use, JUMPSERVER must be in one of your oper class blocks. # If your server is redirecting new clients and you get disconnected, @@ -937,13 +961,16 @@ #<module name="m_jumpserver.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J) +# Anti auto rejoin: Adds support for prevention of auto-rejoin (+J). #<module name="m_kicknorejoin.so"> +# Set the maximum time that is accepted as a parameter for +J here. +#<kicknorejoin maxtime="1m"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Knock module: adds the /KNOCK command and +K channel mode +# Knock module: Adds the /KNOCK command and channel mode +K. #<module name="m_knock.so"> -# This setting specifes what to do when someone successfully /KNOCKs. +# +# This setting specifies what to do when someone successfully /KNOCKs. # If set to "notice", then a NOTICE will be sent to the channel. # This is the default and the compatible setting, as it requires no # special support from the clients. @@ -956,10 +983,10 @@ # LDAP authentication module: Adds the ability to authenticate users # # via LDAP. This is an extra module which must be enabled explicitly # # by symlinking it from modules/extra, and requires the OpenLDAP libs # -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp -# and run make install, then uncomment this module to enable it. # -# # -#<module name="m_ldapauth.so"> # +# This module is in extras. To enable it, Re-run configure with: # +# ./configure --enable-extras=m_ldapauth.cpp # +# and run make install, then uncomment this module. # +#<module name="m_ldapauth.so"> # # # Configuration: # # # @@ -971,10 +998,13 @@ # searchscope="subtree" # # binddn="cn=Manager,dc=brainbox,dc=cc" # # bindauth="mysecretpass" # -# verbose="yes"> # +# verbose="yes" # +# host="$uid.$ou.inspircd.org"> # # # # <ldapwhitelist cidr="10.42.0.0/16"> # # # +# <ldaprequire attribute="attr" value="val"> # +# # # The baserdn indicates the base DN to search in for users. Usually # # this is 'ou=People,dc=yourdomain,dc=yourtld'. # # # @@ -982,7 +1012,7 @@ # a user account by name. On POSIX systems this is usually 'uid'. # # # # The server parameter indicates the LDAP server to connect to. The # -# ldap:// style scheme before the hostname proper is MANDITORY. # +# ldap:// style scheme before the hostname proper is MANDATORY. # # # # The allowpattern value allows you to specify a wildcard mask which # # will always be allowed to connect regardless of if they have an # @@ -1006,14 +1036,27 @@ # ldapwhitelist indicates that clients connecting from an IP in the # # provided CIDR do not need to authenticate against LDAP. It can be # # repeated to whitelist multiple CIDRs. # +# # +# ldaprequire allows further filtering on the LDAP user, by requiring # +# certain LDAP attibutes to have a given value. It can be repeated, # +# in which case the list will act as an OR list, that is, the # +# authentication will succeed if any of the requirements in the list # +# is satisfied. # +# # +# host allows you to change the displayed host of users connecting # +# from ldap. The string supplied takes formatters which are replaced # +# from the DN. For instance, if your DN looks like: # +# uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou # +# and dc will be available to you. If a key is given multiple times # +# in the DN, the last appearance will take precedence. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # LDAP oper configuration module: Adds the ability to authenticate # # opers via LDAP. This is an extra module which must be enabled # # explicitly by symlinking it from modules/extra, and requires the # -# OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp +# OpenLDAP libs. Re-run configure with: # +# ./configure --enable-extras=m_ldapoper.cpp # and run make install, then uncomment this module to enable it. # -# # #<module name="m_ldapoper.so"> # # # Configuration: # @@ -1022,47 +1065,50 @@ # server="ldap://brainwave.brainbox.cc" # searchscope="subtree" # binddn="cn=Manager,dc=brainbox,dc=cc" -# bindauth="mysecretpass"> +# bindauth="mysecretpass" +# attribute="uid"> # # # Available configuration items are identical to the same items in # -# m_ldapauth above. # +# m_ldapauth above (except for the verbose setting, that is only # +# supported in m_ldapauth). # +# Please always specify a password in your <oper> tags even if the # +# opers are to be authenticated via LDAP, so in case this module is # +# not loaded the oper accounts are still protected by a password. # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is # -# used to temporarily close/open for new connections to the server. # -# These commands require OPER status and that the LOCKSERV UNLOCKSERV # +# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that # +# are used to temporarily close/open the server for new connections. # +# These commands require that the /LOCKSERV and /UNLOCKSERV commands # # are specified in a <class> tag that the oper is part of. This is so # # you can control who has access to this possible dangerous command. # # If your server is locked and you get disconnected, do a REHASH from # -# shell to open up again. -# +# shell to open up again. # # This module is oper-only. -# #<module name="m_lockserv.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Map hiding module: replaces /MAP and /LINKS output to users with a # -# message to see a website, set by maphide="http://link.to/site" in # -# the security tag, instead. # +# message to see a website, set by maphide="http://test.org/map" in # +# the <security> tag, instead. # #<module name="m_maphide.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Msg flood module: Adds message/notice flood protection (+f) +# Message flood module: Adds message/notice flood protection via +# channel mode +f. #<module name="m_messageflood.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MLOCK module: Adds support for server-side enforcement of services -# side MLOCKs. Basically, this module suppresses any mode change that +# side MLOCKs. Basically, this module suppresses any mode change that # would likely be immediately bounced by services. #<module name="m_mlock.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# MsSQL module: Allows other SQL modules to access MS SQL Server -# through a unified API. You must copy the source for this module -# from the directory src/modules/extra, plus the file m_sqlv2.h -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp +# MsSQL module: Allows other SQL modules to access MS SQL Server +# through a unified API. +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_mssql.cpp # and run make install, then uncomment this module to enable it. -# #<module name="m_mssql.so"> # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1074,11 +1120,10 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # MySQL module: Allows other SQL modules to access MySQL databases -# through a unified API. You must copy the source for this module -# from the directory src/modules/extra, plus the file m_sqlv2.h -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp +# through a unified API. +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_mysql.cpp # and run make install, then uncomment this module to enable it. -# #<module name="m_mysql.so"> # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1089,13 +1134,10 @@ #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Named Modes module: This module allows for the display and set/unset -# of channel settings and modes via long-form mode names in channels with -# channelmode +Z set. For example, to set a channelban with named modes: -# /mode #channel +Z ban=foo!bar@baz . Currently this doesn't serve much -# purpose outside of making channel administration a bit easier in some -# cases, but eventually modules will start using named modes only because -# we're running out of channelmodes. :D +# Named modes module: Allows for the display and set/unset of channel +# modes via long-form mode names via +Z and the /PROP command. +# For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or +# /PROP #channel ban=foo!bar@baz #<module name="m_namedmodes.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1108,28 +1150,32 @@ # National characters module: # 1) Allows using national characters in nicknames. # 2) Allows using custom (national) casemapping over the network. -# file -- filename of existing file in "locales" directory -# casemapping -- custom value for 005 numeric (if you want it to be -# different from the filename. +#<module name="m_nationalchars.so"> # +# file - Location of the file which contains casemapping rules. If this +# is a relative path then it is relative to "<PWD>/../locales" +# on UNIX and "<PWD>/locales" on Windows. +# casemapping - The name of the casemapping sent to clients in the 005 +# numeric. If this is not set then it defaults to the name +# of the casemapping file unless the file name contains a +# space in which case you will have to specify it manually. #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink"> -#<module name="m_nationalchars.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Nickchange flood protection module: Allows up to X nick changes in Y seconds. -# Provides channel mode +F. +# Nickchange flood protection module: Provides channel mode +F X:Y +# which allows up to X nick changes in Y seconds. #<module name="m_nickflood.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Nicklock module: Let opers change a user's nick and then stop that -# user from changing their nick again. +# user from changing their nick again until unlocked. # This module is oper-only. # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks. #<module name="m_nicklock.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No ctcp module: Adds the channel mode +C to block CTCPs and extban C -# to block CTCPs sent by specific users. +# No CTCP module: Adds the channel mode +C to block CTCPs and extban +# 'C' to block CTCPs sent by specific users. #<module name="m_noctcp.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1138,47 +1184,45 @@ #<module name="m_nokicks.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No nicks module: Adds the +N channel mode, as well as the +b N: -# extended bantype. +N stops all users from changing their nick, -# the +b N: extban stops anyone from matching a +b N:nick!user@host -# mask from changing their nick. +# No nicks module: Adds the +N channel mode, as well as the 'N' extban. +# +N stops all users from changing their nick, the N extban stops +# anyone from matching a +b N:nick!user@host mask from changing their +# nick. #<module name="m_nonicks.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No part message module: adds extban 'p' to block part messages from # +# No part message module: Adds extban 'p' to block part messages from # # matching users. # #<module name="m_nopartmsg.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# No Notice module: adds the channel mode +T and the extban T to block -# specific users from noticing the channel. +# No notice module: Adds the channel mode +T and the extban 'T' to +# block specific users from noticing the channel. #<module name="m_nonotice.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Network buisness join module +# Network business join module: # Allows an oper to join a channel using /OJOIN, giving them +Y on the # channel which makes them immune to kick/deop/etc. #<module name="m_ojoin.so"> # +# Specify the prefix that +Y will grant here. +# Leave 'prefix' empty if you do not wish +Y to grant a prefix. +# If 'notice' is set to on, upon /OJOIN, the server will notice the +# channel saying that the oper is joining on network business. +# If 'op' is set to on, it will give them +o along with +Y. #<ojoin prefix="!" notice="yes" op="yes"> -# Specify the prefix that +Y will grant here -# Leave prefix empty if you do not wish +Y to grant a prefix -# If notice is set to on, upon ojoin, the server will notice -# the channel saying that the oper is joining on network business -# If op is set to on, it will give them +o along with +Y - #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper channels mode: Adds the +O channel mode and +beI type O:<mask> -# to ban, exempt, and invex given oper type masks. -# e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you -# may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins. -# +be work in a similar fashion. -# +# Oper channels mode: Adds the +O channel mode and extban O:<mask> +# to ban, except, etc. specific oper types. For example +# /mode #channel +iI O:* is equivalent to channel mode +O, but you +# may also set +iI O:AdminTypeOnly to only allow admins. +# Modes +I and +e work in a similar fashion. #<module name="m_operchans.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper Join module: Auto-joins opers to a channel upon oper-up +# Oper join module: Auto-joins opers to a channel upon oper-up. # This module is oper-only. For the user equivalent, see m_conn_join. #<module name="m_operjoin.so"> # @@ -1187,10 +1231,10 @@ # If you are using the m_operjoin.so module, specify options here: # # # # channel - The channel name to join, can also be a comma # -# seperated list eg. "#channel1,#channel2". # +# separated list e.g. "#channel1,#channel2". # # # -# override - Lets the oper join walking thru any modes that # -# might be set, even bans. Use "yes" or "no". # +# override - If on, lets the oper join walking thru any modes # +# that might be set, even bans. # # # #<operjoin channel="#channel" override="no"> # @@ -1200,37 +1244,50 @@ #<type name="Helper" autojoin="#help" classes="..."> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper log module: Logs all oper commands to the ircd log at default -# loglevel. +# Oper log module: Logs all oper commands to the server log (with log +# type "m_operlog" at default loglevel), and optionally to the 'r' +# snomask. # This module is oper-only. #<module name="m_operlog.so"> +# +# If the following option is on then all oper commands will be sent to +# the snomask 'r'. The default is off. +#<operlog tosnomask="off"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper prefixing module: Gives IRC operators a prefix status character -# on all channels they are in. +# Oper prefixing module: Adds a channel prefix mode +y which is given +# to all IRC operators automatically on all channels they are in. +# This prefix mode is more powerful than channel op and other regular +# prefix modes. # +# Load this module if you want all your IRC operators to have channel +# operator powers. #<module name="m_operprefix.so"> # # You may additionally customise the prefix character. #<operprefix prefix="!"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper MOTD module: Provides support for seperate message of the day -# on oper-up +# Oper MOTD module: Provides support for separate message of the day +# on oper-up. # This module is oper-only. #<module name="m_opermotd.so"> # #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # -# If you are using the m_opermotd.so module, specify the motd here # +# If you are using the m_opermotd.so module, specify the motd here. # +# # +# onoper - If on, the message is sent on /OPER, otherwise it's # +# only sent when /OPERMOTD is used. # # # -# onoper - Should the message be sent on /OPER or only when # -# /OPERMOTD is used. Use "yes" or "no". # +# processcolors - Allow color codes to be processed in the opermotd. # +# Read the comment above <connect:allowmotdcolors> in # +# inspircd.conf.example for details. # # # -#<opermotd file="oper.motd" onoper="yes"> +#<opermotd file="conf/examples/opermotd.txt.example" onoper="yes" processcolors="false"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Override module: Adds support for oper override +# Override module: Adds support for oper override. # This module is oper-only. #<module name="m_override.so"> # @@ -1240,24 +1297,24 @@ # http://wiki.inspircd.org/Modules/override # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper levels module: Gives each oper a level and prevents -# actions being taken against higher level opers -# Specify the level as the 'level' parameter of the <type> tag -# # This module is oper-only. +# Oper levels module: Gives each oper a level and prevents actions +# being taken by lower level opers against higher level opers. +# Specify the level as the 'level' parameter of the <type> tag. +# This module is oper-only. #<module name="m_operlevels.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Oper modes module: Allows you to specify modes to add/remove on oper +# Oper modes module: Allows you to specify modes to add/remove on oper. # Specify the modes as the 'modes' parameter of the <type> tag # and/or as the 'modes' parameter of the <oper> tag. -# This module is oper-only. For the user equivalent, see m_conn_umodes +# This module is oper-only. For the user equivalent, see m_conn_umodes. #<module name="m_opermodes.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Password forwarding module: Forwards a password users can send on connect -# to the specified client below. The client is usually nickserv and this -# module is usually used to authenticate users with nickserv using their -# connect password. +# Password forwarding module: Forwards a password users can send on +# connect to the specified client below. The client is usually NickServ +# and this module is usually used to authenticate users with NickServ +# using their connect password. #<module name="m_passforward.so"> <passforward @@ -1270,14 +1327,13 @@ # You can also use $user for the user ident string. forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired" - # cmd: Command for the nick to run when it recieves a connect - # password. + # cmd: Command for the user to run when it receives a connect + # password. cmd="PRIVMSG $nickrequired :IDENTIFY $pass"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Password hash module: Allows hashed passwords to be used. # To be useful, a hashing module like m_sha256.so also needs to be loaded. -# #<module name="m_password_hash.so"> # #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-# @@ -1286,20 +1342,20 @@ # password you want to hash. For example: # # <oper name="Brain" -# host="ident@dialup15.isp.com" +# host="ident@dialup15.isp.test.com" # hash="sha256" # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b" # type="NetAdmin"> -# +# # Starting from 2.0, you can use a more secure salted hash that prevents simply # looking up the hash's value in a rainbow table built for the hash. # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg" # -# Generate hashes using the /MKPASSWD command on the server. Don't run it on a -# server you don't trust with your password. +# Generate hashes using the /MKPASSWD command on the server. +# Don't run it on a server you don't trust with your password. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Permanent Channels module: Channels with the permanent channels mode +# Permanent channels module: Channels with the permanent channel mode # will remain open even after everyone else has left the channel, and # therefore keep things like modes, ban lists and topic. Permanent # channels -may- need support from your Services package to function @@ -1311,7 +1367,9 @@ # whenever +P is set, unset, or the topic/modes on a +P channel is changed. # If you want to do this, set the filename below, and uncomment the include. # -#<permchanneldb filename="data/permchannels.conf"> +# If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be +# saved. Defaults to false. +#<permchanneldb filename="data/permchannels.conf" listmodes="true"> #<include file="data/permchannels.conf"> # # You may also create channels on startup by using the <permchannels> block. @@ -1320,11 +1378,10 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # PostgreSQL module: Allows other SQL modules to access PgSQL databases -# through a unified API. You must copy the source for this module -# from the directory src/modules/extra, plus the file m_sqlv2.h -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp +# through a unified API. +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_pgsql.cpp # and run make install, then uncomment this module to enable it. -# #<module name="m_pgsql.so"> # #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1335,26 +1392,25 @@ #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Muteban: Implements extended ban m:, which stops anyone matching +# Muteban: Implements extended ban 'm', which stops anyone matching # a mask like +b m:nick!user@host from speaking on channel. #<module name="m_muteban.so"> -# #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Random Quote module: provides a random quote on connect. -# NOTE: Some of these may mimic fatal errors and confuse users and -# opers alike! - BEWARE! +# Random quote module: Provides a random quote on connect. +# NOTE: Some of these may mimic fatal errors and confuse users and +# opers alike - BEWARE! #<module name="m_randquote.so"> # #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# # # # Optional - If you specify to use the m_randquote.so module, then # -# specify below the path to the randquotes.conf file. # +# specify below the path to the quotes file. # # # -#<randquote file="randquotes.conf"> +#<randquote file="quotes.txt"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Redirect module: Adds channel redirection (mode +L) # +# Redirect module: Adds channel redirection mode +L. # # Optional: <redirect:antiredirect> to add usermode +L to stop forced # # redirection and instead print an error. # # # @@ -1367,53 +1423,53 @@ #<redirect antiredirect="true"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Regular Expression Provider for Glob or wildcard (?/*) matching. +# Regular expression provider for glob or wildcard (?/*) matching. # You must have at least 1 provider loaded to use m_filter or m_rline # modules. This module has no additional requirements, as it uses the # matching already present in InspIRCd core. #<module name="m_regex_glob.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Regular Expression Provider for PCRE (Perl-Compatible Regular +# Regular expression provider for PCRE (Perl-Compatible Regular # Expressions). You need libpcre installed to compile and load this # module. You must have at least 1 provider loaded to use m_filter or # m_rline. #<module name="m_regex_pcre.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Regular Expression Provider for POSIX Regular Expressions. +# Regular expression provider for POSIX regular expressions. # You shouldn't need any additional libraries on a POSIX-compatible -# system (ie: any Linux, BSD, but not Windows). You must have at least -# 1 provider loaded to use m_filter or m_rline. +# system (i.e.: any Linux, BSD, but not Windows). You must have at +# least 1 provider loaded to use m_filter or m_rline. # On POSIX-compliant systems, regex syntax can be found by using the # command: 'man 7 regex'. #<module name="m_regex_posix.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Regular Expression Provider for C++11 std::regex Regular Expressions. +# Regular expression provider for C++11 std::regex regular expressions. # This module works on any fully compliant implementation of the C++11 # std::regex container. Examples for such are Visual C++ 2010 and newer -# but not libstdc++ (which GCC uses) +# but not libstdc++ (which GCC uses). # You should verify that std::regex is supported by your setup before # using this module, as it may compile normally but won't do anything # on some implementations. #<module name="m_regex_stdlib.so"> - -# Specify the Regular Expression engine to use here. Valid settings are -# bre, ere, awk, grep, egrep, ecmascript (default if not specified) +# +# Specify the regular expression engine to use here. Valid settings are +# bre, ere, awk, grep, egrep, ecmascript (default if not specified). #<stdregex type="ecmascript"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Regular Expression Provider for TRE Regular Expressions. +# Regular expression provider for TRE regular expressions. # This is the same regular expression engine used by UnrealIRCd, so -# if you are most familiar with the syntax of /spamfilter from there, +# if you are most familiar with the syntax of /SPAMFILTER from there, # this is the provider you want. You need libtre installed in order # to compile and load this module. #<module name="m_regex_tre.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Registered users only channel creation -# Allows only registered users and opers to create new channels. +# Registered users only channel creation module. If enabled, only +# registered users and opers can create new channels. # # You probably *DO NOT* want to load this module on a public network. # @@ -1421,7 +1477,7 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Remove module: Adds the /REMOVE command which is a peaceful -# alternative to /KICK +# alternative to /KICK. #<module name="m_remove.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1437,77 +1493,88 @@ # You probably *DO NOT* want to load this module on a public network. # #<module name="m_restrictmsg.so"> +# +# Uncomment this to allow users to message ulines (e.g. services): +#<restrictmsg uline="yes"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Ban users through regular expression patterns +# R-Line module: Ban users through regular expression patterns. #<module name="m_rline.so"> # #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # If you wish to re-check a user when they change nickname (can be # useful under some situations, but *can* also use CPU with more users -# on a server) then set the following configuration value: +# on a server) then set 'matchonnickchange' to yes. # Also, this is where you set what Regular Expression engine is to be -# used. If you ever change it while running, all of your R-Lines will be -# wiped. This is the regex engine used by all R-Lines set, and -# m_regex_<engine>.so must be loaded, or rline will be nonfunctional +# used. If you ever change it while running, all of your R-Lines will +# be wiped. This is the regex engine used by all R-Lines set, and +# m_regex_<engine>.so must be loaded, or rline will be non-functional # until you load it or change the engine to one that is loaded. # #<rline matchonnickchange="yes" engine="pcre"> # # Generally, you will NOT want to use 'glob' here, as this turns # rline into just another gline. The exceptions are that rline will -# always use the full nick!user@host realname string, rather than only +# always use the full "nick!user@host realname" string, rather than only # user@host, but beware that only the ? and * wildcards are available, # and are the only way to specify where the space can occur if you do # use glob. For this reason, is recommended to use a real regex engine # so that at least \s or [[:space:]] is available. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAJOIN module: Adds the /SAJOIN command +# SAJOIN module: Adds the /SAJOIN command which forcibly joins a user +# to the given channel. # This module is oper-only. # To use, SAJOIN must be in one of your oper class blocks. #<module name="m_sajoin.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAKICK module: Adds the /SAKICK command +# SAKICK module: Adds the /SAKICK command which kicks a user from the +# given channel. # This module is oper-only. # To use, SAKICK must be in one of your oper class blocks. #<module name="m_sakick.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAMODE module: Adds the oper /SAMODE command +# SAMODE module: Adds the /SAMODE command which allows server operators +# to change modes on a channel without requiring them to have any +# channel priviliges. Also allows changing user modes for any user. # This module is oper-only. # To use, SAMODE must be in one of your oper class blocks. #<module name="m_samode.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SANICK module: Allows opers to change user's nicks +# SANICK module: Adds the /SANICK command which allows opers to change +# users' nicks. # This module is oper-only. # To use, SANICK must be in one of your oper class blocks. #<module name="m_sanick.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAPART module: Adds the oper /SAPART command +# SAPART module: Adds the /SAPART command which forcibly parts a user +# from a channel. # This module is oper-only. # To use, SAPART must be in one of your oper class blocks. #<module name="m_sapart.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SAQUIT module: Adds the oper /SAQUIT command (abusable!!!) +# SAQUIT module: Adds the /SAQUIT command which forcibly quits a user. # This module is oper-only. # To use, SAQUIT must be in one of your oper class blocks. #<module name="m_saquit.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SATOPIC module: Adds the oper /SATOPIC command +# SATOPIC module: Adds the /SATOPIC command which allows changing the +# topic on a channel without requiring any channel priviliges. # This module is oper-only. # To use, SATOPIC must be in one of your oper class blocks. #<module name="m_satopic.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SASL authentication module: Provides support for IRC Authentication -# Layer (aka: atheme SASL) via AUTHENTICATE. +# SASL authentication module: Provides support for IRC Authentication +# Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded +# for SASL to work. #<module name="m_sasl.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1517,13 +1584,13 @@ # #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-# # # -# Securelist can be harmful to some irc search engines such as # +# Securelist can be harmful to some IRC search engines such as # # netsplit.de and searchirc.com. To prevent securelist blocking these # # sites from listing, define exception tags as shown below: # -<securehost exception="*@*.searchirc.org"> -<securehost exception="*@*.netsplit.de"> -<securehost exception="*@echo940.server4you.de"> -<securehost exception="*@*.ircdriven.com"> +#<securehost exception="*@*.searchirc.org"> +#<securehost exception="*@*.netsplit.de"> +#<securehost exception="*@echo940.server4you.de"> +#<securehost exception="*@*.ircdriven.com"> # # # Define the following variable to change how long a user must wait # # before issuing a LIST. If not defined, defaults to 60 seconds. # @@ -1532,78 +1599,72 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Servprotect module: Provides support for Austhex style +k / -# UnrealIRCD +S services mode +# UnrealIRCD +S services mode. #<module name="m_servprotect.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# See nicks module: Allow for SNOMASK +N which shows nick changes. +# See nicks module: Adds snomask +n and +N which show local and remote +# nick changes. # This module is oper-only. #<module name="m_seenicks.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Set Idle module: Adds a command for opers to change their -# idle time (mainly a toy) +# Set idle module: Adds a command for opers to change their idle time. # This module is oper-only. # To use, SETIDLE must be in one of your oper class blocks. #<module name="m_setidle.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Services support module: Adds several usermodes such as +R and +M -# this module implements the 'identified' state via account names (AC) +# Services support module: Adds several usermodes such as +R and +M. +# This module implements the 'identified' state via account names, # and is similar in operation to the way asuka and ircu handle services. # # At the same time, this offers +r for users and channels to mark them -# as identified seperately from the idea of a master account, which +# as identified separately from the idea of a master account, which # can be useful for services which are heavily nick-as-account centric. # -# This replaces m_services from 1.1 and earlier. -# -# Also of note is that this module implements three extbans: +# Also of note is that this module implements two extbans: # +b R: (stop matching account names from joining) -# +b M: (stop matching account names from speaking) # +b U:n!u@h (blocks matching unregistered users) -# +# #<module name="m_services_account.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Sethost module: Adds the /SETHOST command +# Sethost module: Adds the /SETHOST command. # This module is oper-only. # To use, SETHOST must be in one of your oper class blocks. -# See m_chghost for how to customise valid chars for hostnames +# See m_chghost for how to customise valid chars for hostnames. #<module name="m_sethost.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Setident module: Adds the /SETIDENT command +# Setident module: Adds the /SETIDENT command. # This module is oper-only. # To use, SETIDENT must be in one of your oper class blocks. #<module name="m_setident.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SETNAME module: Adds the /SETNAME command -# This module is oper-only. -# To use, SETNAME must be in one of your oper class blocks. +# SETNAME module: Adds the /SETNAME command. #<module name="m_setname.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Serverban: Implements extended ban s:, which stops anyone connected +# Serverban: Implements extended ban 's', which stops anyone connected # to a server matching a mask like +b s:server.mask.here from joining. #<module name="m_serverban.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Show Whois module: Adds the +W usermode which allows opers -# to see when they are whois'ed (can be annoying). -# This module is oper-only. +# Show whois module: Adds the +W usermode which allows opers to see +# when they are /WHOIS'd. +# This module is oper-only by default. #<module name="m_showwhois.so"> # # If you wish, you may also let users set this mode. Only opers with the # users/auspex priv will see real hosts of people, though. This setting -# is not reloadable via /rehash, and will require /reloadmodule, as -# it directly affects the mode object itself. +# is not reloadable via /REHASH, changing it requires /RELOADMODULE. #<showwhois opersonly="yes" # -# You may also set whether or not users should recieve whois notices, should -# they be /whois'd by an oper. -# showfromopers="yes"> +# You may also set whether or not users should receive whois notices, +# should they be /WHOIS'd by an oper. +#showfromopers="yes"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Shun module: Provides the /SHUN command, which stops a user from @@ -1613,86 +1674,79 @@ #<module name="m_shun.so"> # # You may also configure which commands you wish a user to be able to -# perform. It should be noted that if a shunned user issues QUIT or PART -# then their message will be removed, as if they did not issue one. +# perform when shunned. It should be noted that if a shunned user +# issues QUIT or PART then their message will be removed, as if they +# did not issue one. # -# You can (optionally) let the user know that their command was blocked. +# You can optionally let the user know that their command was blocked. # # You may also let SHUN affect opers (defaults to no). #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SSL channel mode module: Adds support for SSL-only channels (+z). -# does not do anything useful without a working SSL module (see below) +# SSL channel mode module: Adds support for SSL-only channels via +# channel mode +z and the 'z' extban which matches SSL client +# certificate fingerprints. +# Does not do anything useful without a working SSL module (see below). #<module name="m_sslmodes.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# GnuTLS ssl module: Adds support for client-server SSL using GnuTLS, -# if enabled. You must copy the source for this module from the directory -# src/modules/extra, or answer 'yes' in ./configure when asked if you -# want to enable this, or it will not load. +# GnuTLS SSL module: Adds support for SSL connections using GnuTLS, +# if enabled. You must answer 'yes' in ./configure when asked or +# manually symlink the source for this module from the directory +# src/modules/extra, if you want to enable this, or it will not load. #<module name="m_ssl_gnutls.so"> # #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_gnutls.so is too complex it describe here, see the wiki: # +# m_ssl_gnutls.so is too complex to describe here, see the wiki: # # http://wiki.inspircd.org/Modules/ssl_gnutls # -# # -# NOTE: If you want to use this module to encrypt and sign your # -# server to server traffic, you MUST load it before m_spanningtree in # -# your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SSL Info module: Allows users to retrieve information about other -# user's peer SSL certificates and keys. This can be used by client +# SSL info module: Allows users to retrieve information about other +# users' peer SSL certificates and keys. This can be used by client # scripts to validate users. For this to work, one of m_ssl_gnutls.so -# or m_ssl_openssl.so must be loaded. This module also adds the +# or m_ssl_openssl.so must be loaded. This module also adds the # "* <user> is using a secure connection" whois line, the ability for -# opers to use SSL fingerprints to verify their identity and the ability -# to force opers to use SSL connections in order to oper up. -# It is highly recommended to load this module especially if -# you use SSL on your network. +# opers to use SSL fingerprints to verify their identity and the +# ability to force opers to use SSL connections in order to oper up. +# It is highly recommended to load this module if you use SSL on your +# network. # For how to use the oper features, please see the first example <oper> tag # in opers.conf.example. # #<module name="m_sslinfo.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# OpenSSL ssl module: Adds support for client-server SSL using OpenSSL, -# if enabled. You must copy the source for this module from the directory -# src/modules/extra, or answer 'yes' in ./configure when asked if you -# want to enable this, or it will not load. +# OpenSSL SSL module: Adds support for SSL connections using OpenSSL, +# if enabled. You must answer 'yes' in ./configure when asked or symlink +# the source for this module from the directory src/modules/extra, if +# you want to enable this, or it will not load. #<module name="m_ssl_openssl.so"> # #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_ssl_openssl.so is too complex it describe here, see the wiki: # +# m_ssl_openssl.so is too complex to describe here, see the wiki: # # http://wiki.inspircd.org/Modules/ssl_openssl # -# # -# NOTE: If you want to use this module to encrypt and sign your # -# server to server traffic, you MUST load it before m_spanningtree in # -# your configuration file! # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Strip color module: Adds the channel mode +S +# Strip color module: Adds channel mode +S that strips mIRC color +# codes from all messages sent to the channel. #<module name="m_stripcolor.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SILENCE module: Adds support for /SILENCE +# Silence module: Adds support for the /SILENCE command, which allows +# users to have a server-side ignore list for their client. #<module name="m_silence.so"> # -# Configuration tags: -# +# Set the maximum number of entries allowed on a user's silence list. #<silence maxentries="32"> -# -# Sets the maximum number of entries on a users silence list. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQLite3 module: Allows other SQL modules to access SQLite3 # -# databases through a unified API. You must link the source for this # -# module from the directory src/modules/extra to src/modules, plus # -# the file m_sqlv2.h # -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp +# databases through a unified API. # +# This module is in extras. Re-run configure with: # +# ./configure --enable-extras=m_sqlite.cpp # and run make install, then uncomment this module to enable it. # # #<module name="m_sqlite3.so"> @@ -1706,32 +1760,30 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL authentication module: Allows IRCd connections to be tied into -# a database table (for example a forum). You must copy the source for -# this module from the directory src/modules/extra -# Depends on the SQLutils module being loaded first. -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp +# a database table (for example a forum). +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_sqlauth.cpp # and run make install, then uncomment this module to enable it. # #<module name="m_sqlauth.so"> # #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# m_sqlauth.so is too complex it describe here, see the wiki: # +# m_sqlauth.so is too complex to describe here, see the wiki: # # http://wiki.inspircd.org/Modules/sqlauth # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # SQL oper module: Allows you to store oper credentials in an SQL table -# You must copy the source for this module from the directory src/modules/extra -# Depends on the SQLutils module being loaded first. -# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp +# This module is in extras. Re-run configure with: +# ./configure --enable-extras=m_sqloper.cpp # and run make install, then uncomment this module to enable it. # #<module name="m_sqloper.so"> # #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-# # # -# dbid - Database ID to use (see m_sql) # -# hash - Hashing provider to use for password hashing # +# dbid - Database ID to use (see SQL modules). # +# hash - Hashing provider to use for password hashing. # # # # See also: http://wiki.inspircd.org/Modules/sqloper # # # @@ -1741,26 +1793,28 @@ # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be # # added/removed by Services. # #<module name="m_svshold.so"> +# If silent is true no snotices will be generated by SVSHOLD. +#<svshold silent="false"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# SWHOIS module: Allows you to add arbitary lines to user WHOIS. +# SWHOIS module: Allows you to add arbitrary lines to user WHOIS. # This module is oper-only. # To use, SWHOIS must be in one of your oper class blocks. #<module name="m_swhois.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Test module: enable this to create a command useful in testing +# Test module: Enable this to create a command useful in testing # flood control. To avoid accidental use on live networks, the server # name must contain ".test" to load the module #<module name="m_testnet.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Timed bans module: Adds timed channel bans and the /TBAN command +# Timed bans module: Adds timed channel bans with the /TBAN command. #<module name="m_timedbans.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Test line module: Adds the /TLINE command, used to test how many -# users a /GLINE or /ZLINE etc would match. +# users a /GLINE or /ZLINE etc. would match. # This module is oper-only. # To use, TLINE must be in one of your oper class blocks. #<module name="m_tline.so"> @@ -1773,10 +1827,9 @@ #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # UHNAMES support module: Adds support for the IRCX style UHNAMES # extension, which displays ident and hostname in the names list for -# each user, saving clients from doing a WHO on the channel. Note that -# this module is not widely supported yet. If a client does not support -# UHNAMES it will not enable it, this will not break incompatible -# clients. +# each user, saving clients from doing a WHO on the channel. +# If a client does not support UHNAMES it will not enable it, this will +# not break incompatible clients. #<module name="m_uhnames.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1785,9 +1838,9 @@ #<module name="m_uninvite.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Userip module: Adds the /USERIP command -# This module is oper-only. -# To use, USERIP must be in one of your oper class blocks. +# Userip module: Adds the /USERIP command. +# Allows users to query their own IP, also allows opers to query the IP +# of anyone else. #<module name="m_userip.so"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1807,29 +1860,26 @@ # # # host - Vhost to set. # # -#<vhost user="some_username" pass="some_password" host="some.host"> -#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host"> +#<vhost user="some_username" pass="some_password" host="some.host.test.cc"> +#<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Watch module: Adds the WATCH command, which is used by clients to +# Watch module: Adds the WATCH command, which is used by clients to # maintain notify lists. #<module name="m_watch.so"> # -# Configuration tags: -# +# Set the maximum number of entries on a user's watch list below. #<watch maxentries="32"> -# -# Sets the maximum number of entries on a user's watch list. #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules) -# in a file "xline.db" which can be re-loaded on restart. This is useful +# in a file which is re-loaded on restart. This is useful # for two reasons: it keeps bans so users may not evade them, and on # bigger networks, server connections will take less time as there will # be a lot less bans to apply - as most of them will already be there. #<module name="m_xline_db.so"> -# Specify the filename for the xline database here +# Specify the filename for the xline database here. #<xlinedb filename="data/xline.db"> #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# @@ -1843,13 +1893,10 @@ # module. If you don't do this, server links will NOT work at all. # # This is by design, to allow for the implementation of other linking # # protocols in modules in the future. # -# # #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# -# Spanning Tree module - allows linking of servers using the spanning +# Spanning tree module: Allows linking of servers using the spanning # tree protocol (see the READ THIS BIT section above). # You will almost always want to load this. # #<module name="m_spanningtree.so"> - -