Clarify example.conf maxlinks, example Class blocks and Operator password.

git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/branches/u2_10_12_branch@1777 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

diff --git a/ChangeLog b/ChangeLog
index aa8c8003c0f6f6333f2058abe9851806f851646b..5aa150b8781a2e677f177fa6166f634ae8c431ea 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2007-03-16  Michael Poole <mdpoole@troilus.org>
+
+       * doc/example.conf (Class): Move the "Recommended client classes"
+       comment to a better place (and stop recommending them).  Clarify
+       what maxlinks does.  Make it clear that Operator password entries
+       only support umkpasswd formats.
+       
 2007-03-16  Michael Poole <mdpoole@troilus.org>
 
        * ircd/ircd.c (parse_command_line): Emit a warning if using -x

diff --git a/doc/example.conf b/doc/example.conf
index 5e20dcb98cb365aee0f562684c2c26666c414035..ade236ec13beda91d6f781729129fed28497740d 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -106,8 +106,7 @@ Admin {
 # All connections to the server are associated with a certain "connection
 # class", be they incoming or outgoing (initiated by the server), be they
 # clients or servers.
-# Recommended client classes:
-# Take the following class blocks only as a guide.
+#
 # Class {
 #  name = "<class>";
 #  pingfreq = time;
@@ -117,8 +116,12 @@ Admin {
 #  usermode = "+i";
 # };
 #
-# maxlinks should be set at either 0 or 1.
-#
+# For connection classes used on server links, maxlinks should be set
+# to either 0 (for hubs) or 1 (for leaf servers).  Client connection
+# classes may use maxlinks between 0 and approximately 4,000,000,000.
+# maxlinks = 0 means there is no limit on the number of connections
+# using the class.
+# 
 # <connect freq> applies only to servers, and specifies the frequency 
 # that the server tries to autoconnect. setting this to 0 will cause
 # the server to attempt to connect repeatedly with no delay until the 
@@ -161,9 +164,7 @@ Class {
 # limits the number of matching clients allowed from a particular IP
 # address.
 #
-# Recommended client classes:
-# Client classes. 10 = locals; 2 = for all .net and .com that are not
-# in Europe; 1 = for everybody.
+# Take the following class blocks only as a guide.
 Class {
  name = "Local";
  pingfreq = 1 minutes 30 seconds;
@@ -621,7 +622,8 @@ CRULE
 # By default, the password is hashed using the system's native crypt()
 # function.  Other password mechanisms are available; the umkpasswd
 # utility from the ircd directory can hash passwords using those
-# mechanisms.
+# mechanisms.  If you use a password format that is NOT generated by
+# umkpasswd, ircu will not recognize the oper's password.
 #
 # All privileges are shown with their default values; if you wish to
 # override defaults, you should set only those privileges for the