Update example configuration files, fix typos and case

Mention m_regex_stdlib in the list of regex providers after m_filter

4 files changed, 48 insertions, 38 deletions

diff --git a/docs/conf/inspircd.conf.example b/docs/conf/inspircd.conf.example
index bd4629eca..551797f7b 100644
--- a/docs/conf/inspircd.conf.example
+++ b/docs/conf/inspircd.conf.example
@@ -148,10 +148,10 @@
       # to this bind section.
       type="clients"
 
-      # ssl: If you want this bind section to use SSL, define either
-      # gnutls or openssl here. The appropriate SSL modules must be loaded
-      # for ssl to work. If you do not want this bind section to support ssl,
-      # just remove or comment out this option.
+      # ssl: If you want the port(s) in this bind tag to use SSL, set this
+      # to either "gnutls" or "openssl". The appropriate SSL module must be
+      # loaded for SSL to work. If you do not want the port(s) in this bind
+      # tag to support SSL, just remove or comment out this option.
       ssl="gnutls"
 >
 
@@ -160,8 +160,8 @@
 # When linking servers, the OpenSSL and GnuTLS implementations are completely
 # link-compatible and can be used alongside each other
 # on each end of the link without any significant issues.
-# Supported ssl types are: "openssl" and "gnutls".
-# You must load, m_ssl_openssl for OpenSSL or m_ssl_gnutls for GnuTLS.
+# Supported SSL types are: "openssl" and "gnutls".
+# You must load m_ssl_openssl for OpenSSL or m_ssl_gnutls for GnuTLS.
 
 <bind address="" port="7000,7001" type="servers">
 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
@@ -450,7 +450,7 @@
      # server: DNS server to use to attempt to resolve IP's to hostnames.
      # in most cases, you won't need to change this, as inspircd will
      # automatically detect the nameserver depending on /etc/resolv.conf
-     # (or, on windows, your set nameservers in the registry.)
+     # (or, on Windows, your set nameservers in the registry.)
      # Note that this must be an IP address and not a hostname, because
      # there is no resolver to resolve the name until this is defined!
      #
@@ -628,7 +628,7 @@
              # somaxconn: The maximum number of connections that may be waiting
              # in the accept queue. This is *NOT* the total maximum number of
              # connections per server. Some systems may only allow this to be up
-             # to 5, while others (such as linux and *BSD) default to 128.
+             # to 5, while others (such as Linux and *BSD) default to 128.
              somaxconn="128"
 
              # limitsomaxconn: By default, somaxconn (see above) is limited to a
diff --git a/docs/conf/links.conf.example b/docs/conf/links.conf.example
index e4ebea556..591ebcac3 100644
--- a/docs/conf/links.conf.example
+++ b/docs/conf/links.conf.example
@@ -55,11 +55,11 @@
       bind="1.2.3.4"
 
       # statshidden: Defines if IP is shown to opers when
-      # /stats c is invoked.
+      # /STATS c is invoked.
       statshidden="no"
 
       # hidden: If this is set to yes, this server and its "child"
-      # servers will not be shown when users do a /map or /links
+      # servers will not be shown when users do a /MAP or /LINKS.
       hidden="no"
 
       # passwords: the passwords we send and receive.
diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example
index b4a5afab6..5b79fc2b6 100644
--- a/docs/conf/modules.conf.example
+++ b/docs/conf/modules.conf.example
@@ -243,7 +243,7 @@
 #<blockamsg delay="3" action="killopers">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Block CAPS module: Blocking all-CAPS messages with channel mode +B.
+# Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
 #<module name="m_blockcaps.so">
 #
 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
@@ -254,10 +254,10 @@
 # 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.                                #
 #<blockcaps percent="50"
 #           minlen="5"
 #           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
@@ -273,12 +273,12 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CallerID module: Adds usermode +g which activates hybrid-style
-# callerid: block all private messages unless you /accept first
+# callerid: block all private messages unless you /ACCEPT first.
 #<module name="m_callerid.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- CALLERID  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
 # maxaccepts     - Maximum number of entries a user can add to his    #
-#                  /accept list. Default is 16 entries.               #
+#                  /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? #
@@ -299,7 +299,7 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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.
 #<module name="m_cban.so">
 
@@ -473,7 +473,7 @@
 #<module name="m_chgident.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# 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.
 #<module name="m_chgname.so">
@@ -481,8 +481,9 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Cloaking module: Adds usermode +x and cloaking support.
 # Relies on the module m_md5.so being loaded.
-# To use, you should enable m_conn_umodes and add +x as
-# an enabled mode. See the m_conn_umodes module for more information.
+# To cloak users when they connect, load m_conn_umodes and set
+# <connect:modes> to include the +x mode. The example <connect> tag
+# shows this. See the m_conn_umodes module for more information.
 #<module name="m_cloaking.so">
 #
 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
@@ -748,11 +749,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">                                           #
 #                                                                     #
@@ -805,8 +808,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">
@@ -1153,7 +1156,7 @@
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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">
@@ -1240,8 +1243,13 @@
 #<operlog tosnomask="off">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
-# Oper prefixing module: Gives server 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.
@@ -1442,7 +1450,7 @@
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # 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">
@@ -1611,7 +1619,7 @@
 # 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">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
diff --git a/docs/conf/modules/unrealircd.conf.example b/docs/conf/modules/unrealircd.conf.example
index d195e6afd..58f36da23 100644
--- a/docs/conf/modules/unrealircd.conf.example
+++ b/docs/conf/modules/unrealircd.conf.example
@@ -190,11 +190,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">
 #                                                                     #