Life would be interesting if we accepted host@ip syntax.. but we don't.

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

diff --git a/doc/example.conf b/doc/example.conf
index ae68ae080fcdabdd816b0f5b13528231be7e53f7..99ab66288a5e5b2c70ea23f66ea6122bc289b458 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>";
 };
 
@@ -92,9 +92,8 @@ 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, servers or Martians. (Note that ircd doesn't have direct support
+# clients or servers.
 # Recommended client classes:
-# for Martians (yet?); they will have to register as normal users. ;-)
 # Take the following class blocks only as a guide.
 # Class {
 #  name = "<class>";
@@ -159,11 +158,6 @@ Class {
  maxlinks = 100;
  usermode = "+iw";
 };
-Client
-{
- class = "Other";
- username = "*";
-};
 Class {
  name = "America";
  pingfreq = 1 minutes 30 seconds;
@@ -208,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)
@@ -221,8 +216,10 @@ Class {
  # apass_opmode (can use OPMODE/CLEARMODE on +A and +U keys)
  #
  # For global opers (with propagate = yes or local = no), the default
- # is to grant all of the above privileges EXCEPT apass_opmode.  For
- # local opers, the default is to grant ONLY the following privileges:
+ # is to grant all of the above privileges EXCEPT walk_lchan,
+ # unlimit_query, set, badchan, local_badchan and apass_opmode.
+ # For local opers, the default is to grant ONLY the following
+ # privileges:
  #  chan_limit, mode_lchan, show_invis, show_all_invis, local_kill,
  #  rehash, local_gline, local_jupe, local_opmode, whox, display,
  #  force_local_opmode
@@ -240,7 +237,7 @@ Class {
 # Kill block".
 # Client {
 #  host = "user@host";
-#  ip = "ip@host";
+#  ip = "user@ip";
 #  password = "password";
 #  class = "classname";
 # };
@@ -515,6 +512,7 @@ Kill
 # Connect {
 #  name = "servername";
 #  host = "hostnameORip";
+#  vhost = "localIP";
 #  password = "passwd";
 #  port = portno;
 #  class = "classname";
@@ -530,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
@@ -648,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
@@ -677,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
@@ -727,13 +733,10 @@ Pseudo "LOGIN" {
 };
 
 # You can ask a separate server whether to allow users to connect.
-IAuth {
- pass = "ircd-iauth";
- host = "127.0.0.1";
- port = 7700;
- connectfreq = 30;
- timeout = 60;
-};
+# Uncomment this ONLY if you have an iauth helper program.
+# IAuth {
+#  program = "../path/to/iauth" "-n" "options go here";
+# };
 
 # [features]
 # IRC servers have a large number of options and features.  Most of these
@@ -808,6 +811,7 @@ features
 # "CHANNELLEN" = "200";
 # "CONFIG_OPERCMDS" = "FALSE";
 # "OPLEVELS" = "TRUE";
+# "ZANNELS" = "TRUE";
 # "LOCAL_CHANNELS" = "TRUE";
 # "ANNOUNCE_INVITES" = "FALSE";
 #  These were introduced by Undernet CFV-165 to add "Head-In-Sand" (HIS)
@@ -847,11 +851,13 @@ features
 #  "HIS_STATS_x" = "TRUE";
 #  "HIS_STATS_y" = "TRUE";
 #  "HIS_STATS_z" = "TRUE";
+#  "HIS_STATS_IAUTH" = "TRUE";
 #  "HIS_WHOIS_SERVERNAME" = "TRUE";
 #  "HIS_WHOIS_IDLETIME" = "TRUE";
 #  "HIS_WHOIS_LOCALCHAN" = "TRUE";
 #  "HIS_WHO_SERVERNAME" = "TRUE";
 #  "HIS_WHO_HOPCOUNT" = "TRUE";
+#  "HIS_MODEWHO" = "TRUE";
 #  "HIS_BANWHO" = "TRUE";
 #  "HIS_KILLWHO" = "TRUE";
 #  "HIS_REWRITE" = "TRUE";