X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=conf%2Fmodules.conf.example;h=a37c412e4fc2bf30a1e67f5c646475ed5b8b4b5e;hb=3faec7ce70ac8becb834f087daa1ba2039c89ce9;hp=2aa027fd7dd2015d9b21db26361ce9cbec58b4fe;hpb=5f5c8f8b8966631ce8190844135eecd7c4f37909;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index 2aa027fd7..a37c412e4 100644
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -32,6 +32,7 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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">
 
@@ -162,7 +163,9 @@
 #<module name="m_allowinvite.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Alltime module: Shows time on all connected servers at once
+# Alltime module: Shows time on all connected servers at once.
+# This module is oper-only and provides /alltime.
+# To use, ALLTIME must be in one of your oper class blocks.
 #<module name="m_alltime.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -276,6 +279,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CBAN module: Lets you disallow channels from being used at runtime.
+# This module is oper-only and provides /cban.
+# To use, CBAN must be in one of your oper class blocks.
 #<module name="m_cban.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -334,7 +339,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Channel create module: Adds snomask +j, which will notify opers of
-# any new channels that are created
+# any new channels that are created.
+# This module is oper-only.
 #<module name="m_chancreate.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -365,10 +371,14 @@
 # Check module: gives /check
 # Check is useful for looking up information on channels,
 # users, IP addresses and hosts.
+# This module is oper-only.
+# To use, CHECK must be in one of your oper class blocks.
 #<module name="m_check.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGHOST module: Adds the /CHGHOST command
+# This module is oper-only.
+# To use, CHGHOST must be in one of your oper class blocks.
 #<module name="m_chghost.so">
 #
 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
@@ -382,16 +392,22 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGIDENT module: Adds the /CHGIDENT command
+# This module is oper-only.
+# To use, CHGIDENT must be in one of your oper class blocks.
 #<module name="m_chgident.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGNAME module: Adds the /CHGNAME command
+# This module is oper-only.
+# To use, CHGNAME must be in one of your oper class blocks.
 #<module name="m_chgname.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
 #<module name="m_cloaking.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
@@ -427,12 +443,16 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Close module: Allows an oper to close all unregistered connections.
+# This module is oper-only and provides /close.
+# To use, CLOSE must be in one of your oper class blocks.
 #<module name="m_close.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
+# This module is oper-only.
+# To use, CLONES must be in one of your oper class blocks.
 #<module name="m_clones.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -606,19 +626,30 @@
 # http://inspircd.org/wiki/DNS_Blacklist_Module                       #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Filter module: Provides glob-based message filtering
+# Filter module: Provides message filtering, similar to SPAMFILTER.
 #<module name="m_filter.so">
-# OR
-# PCRE filter module: Filters messages using regular expressions
-#<module name="m_filter_pcre.so">
-#
-# You may only use one or the other with these modules, network-wide.
+#                                                                     #
+# This module depends upon a regex provider such as m_regex_pcre or   #
+# m_regex_glob to function. You must specify which of these you want  #
+# m_filter to use via the tag below.                                  #
+#                                                                     #
+# 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.     #
+#                                                                     #
+#<filteropts engine="glob">                                           #
+#                                                                     #
+# Your choice of regex engine must match on all servers network-wide.
 #
 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# Optional - If you specify to use the m_filter or m_filter_pcre      #
-# modules, then specfiy below the path to the filter.conf file,       #
-# or define some <filter> tags.                                       #
+# Optional - If you specify to use the m_filter module, then          #
+# specfiy below the path to the filter.conf file, or define some      #
+# <filter> tags.                                                      #
 #                                                                     #
 #<include file="filter.conf">
 
@@ -633,6 +664,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # GeoIP module: Allows the server admin to ban users by country code.
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
+# and run make install, then uncomment this module to enable it.
 #<module name="m_geoip.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
@@ -650,11 +683,17 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Globops module: gives /GLOBOPS 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">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
+# To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
+# must be in one of your oper class blocks.
 #<module name="m_globalload.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -673,10 +712,16 @@
 # HIDECHANS module: Allows opers 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
+# 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-
 # opers by setting user mode +H on themselves.
+# This module is oper-only.
 # <module name="m_hideoper.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -776,6 +821,8 @@
 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
 # must first add the value canquiet="yes" to that oper's type tag.
 #
+# This module is oper-only.
+#
 #<module name="m_invisible.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -784,6 +831,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
 #<module name="m_jumpserver.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -798,6 +847,8 @@
 # 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">                                        #
 #                                                                     #
@@ -849,6 +900,9 @@
 # you can control who has access to this possible dangerous command.  #
 # If your server is locked and you got disconnected, do a REHASH from #
 # shell to open up again.
+#
+# This module is oper-only.
+#
 #<module name="m_lockserv.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -859,6 +913,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_mssql.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -872,6 +929,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_mysql.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -895,6 +955,8 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Nicklock module: Let opers change a user's nick and then stop that
 # user from changing their nick again.
+# This module is oper-only.
+# To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
 #<module name="m_nicklock.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -918,14 +980,27 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper channels mode: Adds the +O channel mode
+# This module is oper-only.
 #<module name="m_operchans.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper flood module: Removes flood limits from users upon opering up
+# This module is oper-only.
 #<module name="m_operflood.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Oper invex/extban module: Adds +beI type O, 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.
+# This module is oper-only.
+#
+#<module name="m_operinvex.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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">
 #
 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
@@ -948,11 +1023,13 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper log module: Logs all oper commands to the ircd log at default
 # loglevel.
+# This module is oper-only.
 #<module name="m_operlog.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper MOTD module: Provides support for seperate message of the day
 # on oper-up
+# This module is oper-only.
 #<module name="m_opermotd.so">
 #
 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
@@ -963,6 +1040,7 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Override module: Adds support for oper override
+# This module is oper-only.
 #<module name="m_override.so">
 #
 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
@@ -974,18 +1052,21 @@
 # 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.
 #<module name="m_operlevels.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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
 #<module name="m_opermodes.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper password hash module: Allows hashed oper passwords
 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
 # m_password_hash.so in the configuration file.
+# This module is oper-only.
 #<module name="m_password_hash.so">
 #
 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1010,6 +1091,7 @@
 # therefore keep things like modes, ban lists and topic. Permanent
 # channels -may- need support from your Services package to function
 # properly with them. This adds channel mode +P.
+# This module is oper-only.
 #<module name="m_permchannels.so">
 #
 # You may also create channels on startup by using the <permchannels> block.
@@ -1019,6 +1101,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_pgsql.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1028,10 +1113,6 @@
 #
 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Proxy scan module: Scans locally connecting clients for proxies.
-#<module name="m_proxyscan.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Muteban: Implements extended ban m:, which stops anyone matching
 # a mask like +b m:nick!user@host from speaking on channel.
@@ -1055,6 +1136,37 @@
 # Redirect module: Adds channel redirection (mode +L)
 #<module name="m_redirect.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# 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
+# 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.
+# 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.
+# 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 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,
+# 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.
@@ -1084,10 +1196,25 @@
 #<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:
-#<rline matchonnickchange="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
+# 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
+# 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.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
@@ -1120,22 +1247,32 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SAJOIN module: Adds the /SAJOIN command
+# This module is oper-only.
+# To use, SAJOIN must be in one of your oper class blocks.
 #<module name="m_sajoin.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SAMODE module: Adds the oper /SAMODE command
+# 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
+# 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
+# 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!!!)
+# This module is oper-only.
+# To use, SAQUIT must be in one of your oper class blocks.
 #<module name="m_saquit.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1169,11 +1306,14 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # See nicks module: Allow for SNOMASK +N which shows 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)
+# This module is oper-only.
+# To use, SETIDLE must be in one of your oper class blocks.
 #<module name="m_setidle.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1184,6 +1324,8 @@
 # N O T E!!
 #  >>  This CAN NOT be used at the same time as m_services_account <<
 # N O T E!!
+# *** This module DOES NOT support Atheme services, please use ***
+# *** m_services_account if you are planning on using Atheme.  ***
 #<module name="m_services.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1202,15 +1344,21 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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
 #<module name="m_sethost.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
 #<module name="m_setname.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1221,11 +1369,14 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
 #<module name="m_showwhois.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Shun module: Provides the /shun command, which stops a user executing 
 # most commands.
+# This module is oper-only.
+# To use, SHUN must be in one of your oper class blocks.
 #<module name="m_shun.so">
 #
 # You may also configure which commands you wish a user to be able to
@@ -1238,6 +1389,7 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Spy module: Provides the ability to see the complete names list of 
 # channels an oper is not a member of
+# This module is oper-only.
 #<module name="m_spy.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1274,6 +1426,9 @@
 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
 # or m_ssl_openssl.so must be loaded. You must symlink the source for
 # this module from the directory src/modules/extra.
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_sslinfo.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1299,6 +1454,7 @@
 # be loaded. An extra value should be added to enabled opers, which
 # is in the following format: fingerprint="<hash>". For more information,
 # see the example in the oper blocks.
+# This module is oper-only.
 #<module name="m_ssl_oper_cert.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1320,6 +1476,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.      #
+#
 #<module name="m_sqlite3.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1335,6 +1494,9 @@
 # for this module from the directory src/modules/extra/m_sqlutils.cpp
 # and src/modules/extra/m_sqlutils.h into /src/modules
 # Needed for, and loaded before: SQLauth and SQLoper
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_sqlutils.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1342,6 +1504,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_sqlauth.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
@@ -1353,6 +1518,9 @@
 # SQL logging module: Allows you to log network-wide data for your
 # network in a fully normalised set of SQL tables. You must copy the
 # source for this module from the directory src/modules/extra
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_sqllog.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
@@ -1367,6 +1535,9 @@
 # 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
+# and run make install, then uncomment this module to enable it.
+#
 #<module name="m_sqloper.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
@@ -1385,11 +1556,15 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SWHOIS module: Allows you to add arbitary 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">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Taxonomy module: Adds the /TAXONOMY command, used to view all
 #                  metadata attached to a user.
+# This module is oper-only.
+# To use, TAXONOMY must be in one of your oper class blocks.
 #<module name="m_taxonomy.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1398,11 +1573,15 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Timed bans module: Adds timed bans and the /TBAN command
+# This module is oper-only.
+# To use, TBAN must be in one of your oper class blocks.
 #<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.
+# This module is oper-only.
+# To use, TLINE must be in one of your oper class blocks.
 #<module name="m_tline.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1421,6 +1600,8 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Userip module: Adds the /USERIP command
+# This module is oper-only.
+# To use, USERIP must be in one of your oper class blocks.
 #<module name="m_userip.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -1457,18 +1638,11 @@
 # be a lot less bans to apply - as most of them will already be there.
 #<module name="m_xline_db.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# XMLSocket module: Adds support for connections using the shockwave
-# flash XMLSocket. Note that this does not work if the client you are
-# using has retarded ideas of the IRC protocol. Your client must still
-# send RFC-correct lines to the server, this module only changes the
-# line ending from newlines to null terminators.
-#
-#<module name="m_xmlsocket.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # ZipLinks module: Adds support for zlib deflate on server to server
 # connections. Both ends of the connection must load this module.
+# This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
+# and run make install, then uncomment this module to enable it.
 #
 #<module name="m_ziplink.so">
 #