Reed Loden's patch to add /stats J, listing nick jupes. (Plus documentation.)

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

diff --git a/doc/example.conf b/doc/example.conf
index b0b10f8d7d38e9586ed2251f4e353660111b3031..31cf5f4320b3386598fd41255a1a5e0846063142 100644 (file)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -52,8 +52,8 @@
 # First some information about the server.
 # General {
 #         name = "servername";
-#         vhost = "virtualhost";
-#         resolver = "ipaddress";
+#         vhost = "ipv4vhost";
+#         vhost = "ipv6vhost";
 #         description = "description";
 #         numeric = numericnumber;
 # };
@@ -65,8 +65,9 @@
 # override it.  See Port{} for listener virtual hosting.  If in doubt,
 # leave it out.
 #
-# You may need to specify the resolver address if your compile
-# defaults to using IPv6 but your resolvers are all IPv4 hosts.
+# 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.
@@ -188,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)
@@ -200,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)
@@ -215,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
@@ -405,9 +409,7 @@ motd {
 # assigned one or two uplinks to which your server can connect.
 # If your uplink(s) also connect to other servers than yours (which is
 # probable), you need to define your uplink as being allowed to "hub".
-# To do this, set "hub = yes;"
-# You can also force a server(even one that doesn't connect to you)
-# to be a leaf with "leaf = yes;"
+# See the Connect block documentation for details on how to do that.
 
 UWorld {
  name = "uworld.eu.undernet.org";
@@ -436,17 +438,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.
@@ -508,7 +499,7 @@ Kill
 # The realname field lets you ban by realname...
 Kill
 {
- host = "*sub7*";
+ realname = "*sub7*";
  reason = "You are infected with a Trojan";
 };
 
@@ -555,7 +546,7 @@ Connect {
  host = "1.2.3.4";
  password = "passwd";
  port = 4400;
- class = "Servers";
+ class = "Server";
  hub;
 };
 
@@ -616,9 +607,11 @@ CRULE
 #  # and the default setting.
 # };
 #
-# The encrypted password is optional.  If you wish to encrypt your
-# password, there is a utility in the ircd.  Please read the file
-# tools/README.
+# 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.
+#
 # All privileges are shown with their default values; if you wish to
 # override defaults, you should set only those privileges for the
 # operator.  Listing defaulted privileges just makes things harder to
@@ -699,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;
 };
@@ -755,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";
@@ -823,6 +821,7 @@ features
 #  "HIS_STATS_h" = "TRUE";
 #  "HIS_STATS_i" = "TRUE";
 #  "HIS_STATS_j" = "TRUE";
+#  "HIS_STATS_J" = "TRUE";
 #  "HIS_STATS_k" = "TRUE";
 #  "HIS_STATS_l" = "TRUE";
 #  "HIS_STATS_L" = "TRUE";