2.0 beta 4 release

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

diff --git a/docs/modules.conf.example b/docs/modules.conf.example
index db4b1db52fc8515f9c27e2063ec6f2c741481896..3e405dcd3c1e2b77b64afa69c6ec1d4a97073c1b 100644 (file)
--- a/docs/modules.conf.example
+++ b/docs/modules.conf.example
@@ -217,18 +217,17 @@
 #
 # Auditorium settings:
 #
-#<auditorium showops="no" operoverride="no">
+#<auditorium opvisible="no" opcansee="no" opercansee="yes">
 #
-# showops:
-#   Setting this value to yes makes m_auditorium behave like unrealircd
-#   +u channel mode, e.g. ops see users joining, parting, etc, and users
-#   joining the channel see the ops. Without this flag, the mode acts
-#   like ircnet's +a (anonymous channels), showing only the user in the
-#   names list, and not even showing the ops in the list, or showing the
-#   ops that the user has joined.
-# operoverride:
-#   Setting this value to yes makes m_auditorium affect the userlist for
-#   regular users only. Opers will view all users in the channel normally.
+# opvisible (auditorium-vis in exemptchanops):
+#   Show channel ops to all users
+# opcansee (auditorium-see in exemptchanops):
+#   Allow ops to see all joins/parts/kicks in the channel
+# opercansee:
+#   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.
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Autoop module: Adds basic channel access controls via the +w listmode.
@@ -631,6 +630,23 @@
 #<connflood seconds="30" maxconns="3" timeout="30"
 #   quitmsg="Throttled" bootwait="10">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Custom prefixes : allows for channel prefixes to be added. 
+# This replaces m_chanprotect and m_halfop
+#<module name="m_customprefix.so">
+#
+# 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
+# ranktoset  The numeric rank required to set/unset this mode. Defaults to rank.
+# depriv     Can you remove the mode from yourself? Defaults to yes.
+#<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
+#<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
+#<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
+<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Custom title module: Adds the /TITLE command which allows for trusted
 #                      users to gain a custom whois line and a optional
@@ -735,15 +751,6 @@
 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor,  #
 # filter, regmoderated, nonick, nonotice, and stripcolor.             #
 #<module name="m_exemptchanops.so">                                   #
-#                                                                     #
-#-#-#-#-#-#-#-#-#-#-  EXEMPTCHANOPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
-#  defaults - default exemptions. These can be added to or overridden #
-#             by the channel mode +X. Each item is of the form        #
-#             [mode]:[minstatus] where you must have [minstatus] in   #
-#             order to be able to bypass [mode].                      #
-#             Use "blockcolor:*" to override a default exemption      #
-#<exemptchanops defaults="nonick:v flood:o">
-
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Filter module: Provides message filtering, similar to SPAMFILTER.
@@ -821,10 +828,6 @@
 # Halfop module: Provides the +h (halfops) channel status mode.
 #<module name="m_halfop.so">
 
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Status prefix: Adds the channel status mode +V
-#<module name="m_halfvoice.so">
-
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # HELPOP module: Provides the /HELPOP command
 #<module name="m_helpop.so">
@@ -929,6 +932,8 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Invite except module: Adds support for channel invite exceptions (+I)
 #<module name="m_inviteexception.so">
+# Does a +I bypass channel +k in addition to +i?
+#<inviteexception bypasskey="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Invisible module - Adds support for usermode +Q (quiet) which lets an