Add missing docs, thanks KT.

[user/henk/code/inspircd.git] / conf / modules.conf.example

diff --git a/conf/modules.conf.example b/conf/modules.conf.example
index 3cd8508fd7048d1507b304799fbd38da052b9ea4..16ec438b46b74a22a2f8be7cdb110dc9ab739187 100644 (file)
--- a/conf/modules.conf.example
+++ b/conf/modules.conf.example
@@ -910,6 +910,26 @@
 # need defining, otherwise they should be set similar to the examples #
 # above.                                                              #
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# 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
+# and run make install, then uncomment this module to enable it.      #
+#                                                                     #
+#<module name="m_ldapoper.so">
+#                                                                     #
+# Configuration:                                                      #
+#                                                                     #
+# <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
+#           server="ldap://brainwave.brainbox.cc"
+#           searchscope="subtree"
+#           binddn="cn=Manager,dc=brainbox,dc=cc"
+#           bindauth="mysecretpass">
+#                                                                     #
+# Available configuration items are identical to the same items in    #
+# m_ldapauth above.                                                   #
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
 # used to temporarily close/open for new connections to the server.   #
@@ -923,6 +943,12 @@
 #
 #<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.                                          #
+#<module name="m_maphide.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Msg flood module: Adds message/notice flood protection (+f)
 #<module name="m_messageflood.so">
@@ -992,6 +1018,11 @@
 # mask from changing their nick.
 #<module name="m_nonicks.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# 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
 #<module name="m_nonotice.so">
@@ -1044,6 +1075,15 @@
 # This module is oper-only.
 #<module name="m_operlog.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Oper prefixing module: Gives IRC operators a prefix status character
+# on all channels they are in.
+#
+#<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
@@ -1195,12 +1235,6 @@
 # alternative to /KICK
 #<module name="m_remove.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Restrict banned users module:
-# Disallows banned users on a channel from messaging the channel,
-# changing nick, or changing the topic, if loaded.
-#<module name="m_restrictbanned.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Restricted channels module: Allows only opers to create channels
 #<module name="m_restrictchans.so">
@@ -1293,6 +1327,12 @@
 # To use, SAQUIT must be in one of your oper class blocks.
 #<module name="m_saquit.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# SATOPIC module: Adds the oper /SATOPIC command
+# 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.
@@ -1334,30 +1374,21 @@
 # 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 user mode +r, which
-# is similar to the DALnet and dreamforge systems.
-#     
-# 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">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Services support module: Adds several usermodes such as +R and +M
 # this module implements the 'identified' state via account names (AC)
 # 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
+# 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 two extbans:
 # +b R: (stop matching account names from joining)
 # +b M: (stop matching account names from speaking)
 #                                                                       
-# N O T E!!
-#  >>  This CAN NOT be used at the same time as m_services <<
-# N O T E!!
 #<module name="m_services_account.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#