Author: Jeannot Langlois

[ircu2.10.12-pk.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index d90e0c092dde3cace41ad3206df007a371944c73..a5d57bc67cfc89ec2c67ee9cfeb6b1373e6e8286 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -82,9 +82,9 @@ General {
 # This sets information that can be retrieved with the /ADMIN command.
 # It should contain at least an admin Email contact address.
 Admin {
+  # At most two location lines are allowed...
   Location = "The University of London";
-  # At most two contact lines are allowed...
-  Contact = "Undernet IRC server";
+  Location = "Undernet IRC server";
   Contact = "IRC Admins <irc@london.ac.uk>";
 };
 
@@ -202,6 +202,7 @@ Class {
  # local_gline (can set a G-line for this server only)
  # local_badchan (can set a Gchan for this server only)
  # see_chan (can see users in +s channels in /WHO)
+ # list_chan (can see +s channels with /LIST S)
  # wide_gline (can use ! to force a wide G-line)
  # see_opers (can see opers without DISPLAY privilege)
  # local_opmode (can use OPMODE/CLEARMODE on local channels)
@@ -236,7 +237,7 @@ Class {
 # Kill block".
 # Client {
 #  host = "user@host";
-#  ip = "ip@host";
+#  ip = "user@ip";
 #  password = "password";
 #  class = "classname";
 # };
@@ -511,6 +512,7 @@ Kill
 # Connect {
 #  name = "servername";
 #  host = "hostnameORip";
+#  vhost = "localIP";
 #  password = "passwd";
 #  port = portno;
 #  class = "classname";
@@ -526,6 +528,10 @@ Kill
 # You may tell ircu to not automatically connect to a server by adding
 # "autoconnect = no;"; the default is to autoconnect.
 #
+# If the vhost field is present, the server will use that IP as the
+# local end of connections that it initiates to this server.  This
+# overrides the vhost value from the General block.
+#
 # The maxhops field causes an SQUIT if a hub tries to introduce
 # servers farther away than that; the element 'leaf;' is an alias for
 # 'maxhops = 0;'.  The hub field limits the names of servers that may
@@ -644,16 +650,20 @@ Operator {
 # so we don't do that.
 #
 # Port {
-#  port = number;
+#  port = [ipv4] [ipv6] number;
 #  mask = "ipmask";
 #  # Use this to control the interface you bind to.
-#  vhost = "virtualhostip";
+#  vhost = [ipv4] [ipv6] "virtualhostip";
 #  # Setting to yes makes this server only.
 #  server = yes;
 #  # Setting to yes makes the port "hidden" from stats.
 #  hidden = yes;
 # };
 #
+# The port and vhost lines allow you to specify one or both of "ipv4"
+# and "ipv6" as address families to use for the port.  The default is
+# to listen on both IPv4 and IPv6.
+#
 # The mask setting allows you to specify a range of IP addresses that
 # you will allow connections from. This should only contain IP addresses
 # and '*' if used. This field only uses IP addresses. This does not use
@@ -673,11 +683,11 @@ Port {
  port = 4400;
 };
 
-# This is a Server port that is Hidden
+# This is an IPv4-only Server port that is Hidden
 Port {
  server = yes;
  hidden = yes;
- port = 4401;
+ port = ipv4 4401;
 };
 
 # The following are normal client ports
@@ -723,13 +733,9 @@ Pseudo "LOGIN" {
 };
 
 # You can ask a separate server whether to allow users to connect.
-# Uncomment this ONLY if you have an iauthd set up.
+# Uncomment this ONLY if you have an iauth helper program.
 # IAuth {
-#  pass = "ircd-iauth";
-#  host = "127.0.0.1";
-#  port = 7700;
-#  connectfreq = 30;
-#  timeout = 60;
+#  program = "../path/to/iauth" "-n" "options go here";
 # };
 
 # [features]
@@ -860,6 +866,7 @@ features
 #  "HIS_SERVERNAME" = "*.undernet.org";
 #  "HIS_SERVERINFO" = "The Undernet Underworld";
 #  "HIS_URLSERVERS" = "http://www.undernet.org/servers.php";
+#  "URLREG" = "http://cservice.undernet.org/live/";
 };
 
 # Well, you have now reached the end of this sample configuration