Fix documentation for iauth I command.
[ircu2.10.12-pk.git] / doc / example.conf
index 5e20dcb98cb365aee0f562684c2c26666c414035..0a93c2a0be6a7df17110ac2991ed52f959bf6a73 100644 (file)
@@ -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;
@@ -369,6 +370,10 @@ Client {
 #  file = "path/to/motd/file";
 # };
 #
+# More than one host = "mask"; entry may be present in one block; this
+# has the same effect as one Motd block for each host entry, but makes
+# it easier to update the messages's filename.
+#
 # DPATH/net_com.motd contains a special MOTD where users are encouraged
 # to register their domains and get their own client{} lines if they're in
 # Europe, or move to US.UnderNet.org if they're in the USA.
@@ -565,6 +570,8 @@ Connect {
 #
 # For an advanced, real-time rule-based routing decision making system
 # you can use crule blocks. For more information, see doc/readme.crules.
+# If more than one server mask is present in a single crule, the rule
+# applies to all servers.
 # CRULE
 # {
 #  server = "servermask";
@@ -607,6 +614,11 @@ CRULE
 # is not not passed along to other servers. On Undernet, this prevents
 # them from using Uworld as well.
 #
+# More than one host = "mask"; entry may be present in one block; this
+# has the same effect as one Operator block for each host entry, but
+# makes it easier to update operator nicks, passwords, classes, and
+# privileges.
+#
 # Operator {
 #  host = "host/IP mask";
 #  name = "opername";
@@ -621,7 +633,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
@@ -662,11 +675,14 @@ Operator {
 # IANA says we should use port 194, but that requires us to run as root,
 # so we don't do that.
 #
+#
 # Port {
 #  port = [ipv4] [ipv6] number;
 #  mask = "ipmask";
 #  # Use this to control the interface you bind to.
 #  vhost = [ipv4] [ipv6] "virtualhostip";
+#  # You can specify both virtual host and port number in one entry.
+#  vhost = [ipv4] [ipv6] "virtualhostip" number;
 #  # Setting to yes makes this server only.
 #  server = yes;
 #  # Setting to yes makes the port "hidden" from stats.
@@ -719,6 +735,14 @@ Port {
  port = 7000;
 };
 
+# More than one vhost may be present in a single Port block; in this case,
+# we recommend listing the port number on the vhost line for clarity.
+Port {
+ vhost = "172.16.0.1" 6667;
+ vhost = "172.16.3.1" 6668;
+ hidden = no;
+};
+
 # Quarantine blocks disallow operators from using OPMODE and CLEARMODE
 # on certain channels.  Opers with the force_opmode (for local
 # channels, force_local_opmode) privilege may override the quarantine