Add '6' to server options when compiled with IPv6 support (and related

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

diff --git a/doc/example.conf b/doc/example.conf
index 3f389240006207c92a37d492ab53433eb4362bf2..8538096a88f5c63182795fb03ed281e147670564 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -52,18 +52,22 @@
 # First some information about the server.
 # General {
 #         name = "servername";
-#         vhost = "virtualhost";
+#         vhost = "ipv4vhost";
+#         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
 # };
 #
-# <virtual host> must contain either a * or a valid IPv4 address in
-# dotted quad notation. (127.0.0.1) The address MUST be the address
-# of a physical interface on the host. This address is used for outgoing
-# connections only, see Port{} for listener virtual hosting.
-# If in doubt put a * or the IP of your primary interface here.
-# The server must be compiled with virtual hosting turned on to get this
-# to work correctly.
+# If present, <virtual host> must contain a valid address in dotted
+# quad or IPv6 numeric notation (127.0.0.1 or ::1).  The address MUST
+# be the address of a physical interface on the host.  This address is
+# used for outgoing connections if the Connect{} block does not
+# override it.  See Port{} for listener virtual hosting.  If in doubt,
+# leave it out.
+#
+# You may specify both an IPv4 virtual host and an IPv6 virtual host,
+# to indicate which address should be used for outbound connections
+# of the respective type.
 #
 # Note that <server numeric> has to be unique on the network your server
 # is running on, must be between 0 and 4095, and is not updated on a rehash.
@@ -185,7 +189,7 @@ Class {
  # exist:
  #
  # local (or propagate, with the opposite sense)
- # whox  (can use x flag with /WHO)
+ # whox  (log oper's use of x flag with /WHO)
  # display (oper status visible to lusers)
  # chan_limit (can join local channels when in
  #                              MAXCHANNELSPERUSER channels)
@@ -197,14 +201,16 @@ Class {
  # unlimit_query (show more results from /WHO)
  # local_kill (can kill clients on this server)
  # rehash (can use /REHASH)
+ # restart (can use /RESTART)
  # die (can use /DIE)
- # local_jupe_server (not used)
+ # local_jupe (not used)
  # set (can use /SET)
  # 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)
  # 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)
  # force_local_opmode (can use OPMODE/CLEARMODE on quarantined local channels)
  # kill (can kill clients on other servers)
  # gline (can issue G-lines to other servers)
@@ -212,10 +218,11 @@ Class {
  # opmode (can use /OPMODE)
  # badchan (can issue Gchans to other servers)
  # force_opmode (can use OPMODE/CLEARMODE on quarantined global channels)
+ # 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.  For local opers, the
- # default is to grant ONLY the following privileges:
+ # is to grant all of the above privileges EXCEPT 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
@@ -433,17 +440,6 @@ UWorld {
 UWorld {
  name = "channels6.undernet.org";
 };
-Server {
- name = "Amsterdam.NL.Eu.UnderNet.org";
- mask = "*";
- hub = yes;
-};
-# An example just to make sure IRCnet doesn't get on undernet...
-Server {
- name = "*";
- mask = "eris.berkeley.edu";
- hub = yes;
-};
 
 # As of ircu2.10.05 is it possible to Jupe nicks. As per CFV-0095, the
 # following nicks must be juped, it is not allowed to jupe others as well.
@@ -505,7 +501,7 @@ Kill
 # The realname field lets you ban by realname...
 Kill
 {
- host = "*sub7*";
+ realname = "*sub7*";
  reason = "You are infected with a Trojan";
 };
 
@@ -552,7 +548,7 @@ Connect {
  host = "1.2.3.4";
  password = "passwd";
  port = 4400;
- class = "Servers";
+ class = "Server";
  hub;
 };
 
@@ -696,14 +692,14 @@ Port {
 Port { port = 6667; };
 Port { port = 6668; };
 Port {
+ # This only accepts clients with IPs like 192.168.*.
  mask = "192.168.*";
  port = 6666;
 };
 
-# This is a hidden client port, listening on the interface associated
-# with the IP address 168.8.21.107
+# This is a hidden client port, listening on 168.8.21.107.
 Port {
- mask = "168.8.21.107";
+ vhost = "168.8.21.107";
  hidden = yes;
  port = 7000;
 };
@@ -752,6 +748,11 @@ IAuth {
 #
 features
 {
+# These log features are the only way to get certain error messages
+# (such as when the server dies from being out of memory).  For more
+# explanation of how they work, see doc/readme.log.
+ "LOG" = "SYSTEM" "FILE" "ircd.log";
+ "LOG" = "SYSTEM" "LEVEL" "CRIT";
 #  "DOMAINNAME"="<obtained from /etc/resolv.conf by ./configure>";
 #  "RELIABLE_CLOCK"="FALSE";
 #  "BUFFERPOOL"="27000000";