From 883f6db55b6cccf4a03f389559ef642054f597e0 Mon Sep 17 00:00:00 2001
From: Attila Molnar <attilamolnar@hush.com>
Date: Wed, 19 Mar 2014 15:52:07 +0100
Subject: Major example configuration and helpop update

Big thanks to @m4z (#621) and @Robby- (#630) who contributed a lot to this
---
 docs/conf/modules/charybdis.conf.example  | 29 ++++++++----------
 docs/conf/modules/unrealircd.conf.example | 49 +++++++++++--------------------
 2 files changed, 29 insertions(+), 49 deletions(-)

(limited to 'docs/conf/modules')

diff --git a/docs/conf/modules/charybdis.conf.example b/docs/conf/modules/charybdis.conf.example
index b456278bb..bd99f7dc2 100644
--- a/docs/conf/modules/charybdis.conf.example
+++ b/docs/conf/modules/charybdis.conf.example
@@ -70,8 +70,8 @@
 
 <module name="m_chancreate.so">
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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.
 <module name="m_channames.so">
@@ -144,7 +144,7 @@
 #<module name="m_connectban.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connection throttle module. Configuration:
+# Connection throttle module.
 #<module name="m_connflood.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
@@ -182,21 +182,21 @@
 <module name="m_redirect.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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.
@@ -246,14 +246,10 @@
 <showwhois opersonly="yes" showfromopers="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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">
-
-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -265,7 +261,7 @@
 #
 #-#-#-#-#-#-#-#-#-#-#-  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                         #
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -292,7 +288,7 @@
 #
 #-#-#-#-#-#-#-#-#-#-#- 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                        #
 
 <module name="m_stripcolor.so">
@@ -304,4 +300,3 @@
 <module name="m_xline_db.so">
 
 <module name="m_spanningtree.so">
-
diff --git a/docs/conf/modules/unrealircd.conf.example b/docs/conf/modules/unrealircd.conf.example
index 65896808f..9518822de 100644
--- a/docs/conf/modules/unrealircd.conf.example
+++ b/docs/conf/modules/unrealircd.conf.example
@@ -1,7 +1,7 @@
 <module name="m_md5.so">
 <module name="m_sha256.so">
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Alias module: Allows you to define server-side command aliases
+# Alias module: Allows you to define server-side command aliases.
 <module name="m_alias.so">
 <fantasy prefix="!" allowbots="no">
 # Aliases
@@ -118,8 +118,8 @@
 <module name="m_commonchans.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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.
 #<module name="m_conn_join.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
@@ -133,7 +133,7 @@
 <module name="m_cycle.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Connection throttle module. Configuration:
+# Connection throttle module.
 #<module name="m_connflood.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
@@ -153,7 +153,7 @@
 #   quitmsg="Throttled" bootwait="10">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# DCCALLOW module: Adds the /DCCALLOW command
+# DCCALLOW module: Adds the /DCCALLOW command.
 <module name="m_dccallow.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
@@ -239,7 +239,7 @@
 <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">
 #
@@ -264,7 +264,7 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Oper MOTD module: Provides support for separate message of the day
-# on oper-up
+# on oper-up.
 # This module is oper-only.
 #<module name="m_opermotd.so">
 #
@@ -272,15 +272,15 @@
 #                                                                     #
 # If you are using the m_opermotd.so module, specify the motd here    #
 #                                                                     #
-# onoper      -      Should the message be sent on /OPER or only when #
-#                    /OPERMOTD is used. Use "yes" or "no".            #
+# onoper        - If on, the message is sent on /OPER, otherwise it's #
+#                 only sent when /OPERMOTD is used.                   #
 #                                                                     #
 #<opermotd file="oper.motd" onoper="yes">
 
 <module name="m_override.so">
 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
-# m_override.so is too complex it describe here, see the wiki:        #
+# m_override.so is too complex to describe here, see the wiki:        #
 # http://wiki.inspircd.org/Modules/override                           #
 
 <module name="m_operlevels.so">
@@ -288,31 +288,18 @@
 <module name="m_password_hash.so">
 <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!
-#<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.                 #
-#                                                                     #
-#<randquote file="randquotes.conf">
-
 <module name="m_redirect.so">
 <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.
@@ -321,7 +308,7 @@
 #<module name="m_regex_posix.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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,
 # this is the provider you want. You need libtre installed in order
@@ -329,8 +316,8 @@
 #<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.
 #
@@ -370,7 +357,6 @@
 <module name="m_shun.so">
 <shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="no" affectopers="no">
 
-<module name="m_spy.so">
 <module name="m_sslmodes.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
@@ -382,7 +368,7 @@
 #
 #-#-#-#-#-#-#-#-#-#-#-  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                         #
 
 <module name="m_sslinfo.so">
@@ -396,7 +382,7 @@
 #
 #-#-#-#-#-#-#-#-#-#-#- 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                        #
 
 <module name="m_stripcolor.so">
@@ -409,4 +395,3 @@
 <watch maxentries="32">
 
 <module name="m_spanningtree.so">
-
-- 
cgit v1.2.3