Fix Admin block documentation and behavior (SF bug#1477672).
[ircu2.10.12-pk.git] / doc / example.conf
index 28796d6b0e621c976f200d26a04ecb1e0292c6d3..2833ca09a4f93b4ba45d6c7ab3a3d843decf712c 100644 (file)
@@ -63,7 +63,7 @@
 # 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.
+# leave it out -- or use "*", which has the same meaning as no vhost.
 #
 # You may specify both an IPv4 virtual host and an IPv6 virtual host,
 # to indicate which address should be used for outbound connections
@@ -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;
@@ -221,8 +215,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
@@ -396,6 +392,8 @@ motd {
 #  name = "relservername";
 # };
 #
+# You may have have more than one name listed in each block.
+#
 # Note: (1) These lines are agreed on by every server admin on Undernet;
 # (2) These lines must be the same on every single server, or results
 # will be disasterous; (3) This is a useful feature, not something that
@@ -413,29 +411,13 @@ motd {
 
 UWorld {
  name = "uworld.eu.undernet.org";
-};
-UWorld {
  name = "uworld2.undernet.org";
-};
-UWorld {
  name = "uworld.undernet.org";
-};
-UWorld {
  name = "channels.undernet.org";
-};
-UWorld {
  name = "channels2.undernet.org";
-};
-UWorld {
  name = "channels3.undernet.org";
-};
-UWorld {
  name = "channels4.undernet.org";
-};
-UWorld {
  name = "channels5.undernet.org";
-};
-UWorld {
  name = "channels6.undernet.org";
 };
 
@@ -475,16 +457,20 @@ Jupe {
 #
 #
 # The default reason is: "You are banned from this server"
-# Note that K-lines are local to the server; if you ban a person or a
+# Note that Kill blocks are local to the server; if you ban a person or a
 # whole domain from your server, they can get on IRC via any other server
-# that doesn't have them K-lined (yet).
+# that doesn't have them Killed (yet).
 #
 # With a simple comment, using quotes:
 Kill { host = "*.au"; reason = "Please use a nearer server"; };
 Kill { host = "*.edu"; reason = "Please use a nearer server"; };
 
+# You can also kill based on username.
+Kill { username = "sub7"; realname = "s*7*"; reason = "You are infected with a Trojan"; };
+
 # The file can contain for example, a reason, a link to the
-# server rules and a contact address.
+# server rules and a contact address.  Note the combination
+# of username and host in the host field.
 Kill
 {
  host = "*luser@unixbox.flooder.co.uk";
@@ -530,12 +516,15 @@ Kill
 #  class = "classname";
 #  maxhops = 2;
 #  hub = "*.eu.undernet.org";
+#  autoconnect = no;
 # };
 #
 # The "port" field defines the default port the server tries to connect
 # to if an operator uses /connect without specifying a port. This is also
 # the port used when the server attempts to auto-connect to the remote
 # server. (See Class blocks for more informationa about auto-connects).
+# You may tell ircu to not automatically connect to a server by adding
+# "autoconnect = no;"; the default is to autoconnect.
 #
 # The maxhops field causes an SQUIT if a hub tries to introduce
 # servers farther away than that; the element 'leaf;' is an alias for
@@ -734,13 +723,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
@@ -812,8 +798,10 @@ features
 # "IPCHECK_CLONE_LIMIT" = "4";
 # "IPCHECK_CLONE_PERIOD" = "40";
 # "IPCHECK_CLONE_DELAY" = "600";
+# "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)
@@ -853,11 +841,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";