Update documentation to reflect impending release.
[ircu2.10.12-pk.git] / doc / example.conf
index e8e6612d1c0b69b8f552e97b4df781489e4a2edf..ae68ae080fcdabdd816b0f5b13528231be7e53f7 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
@@ -396,6 +396,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 +415,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 +461,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 +520,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
@@ -628,7 +621,7 @@ Operator {
 };
 Operator {
  host = "*@*.uu.net";
- password = "notencryptedpass";
+ password = "$PLAIN$notencryptedpass";
  name = "Niels";
  class = "Opers";
 };
@@ -707,6 +700,16 @@ Port {
  port = 7000;
 };
 
+# Quarantine blocks disallow operators from using OPMODE and CLEARMODE
+# on certain channels.  Opers with the force_opmode (for local
+# channels, force_local_opmode) privilege may override the quarantine
+# by prefixing the channel name with an exclamation point ('!').
+# Wildcards are NOT supported; the channel name must match exactly.
+Quarantine {
+  "#shells" = "Thou shalt not support the h4><0rz";
+  "&kiddies" = "They can take care of themselves";
+};
+
 # This is a server-implemented alias to send a message to a service.
 # The string after Pseudo is the command name; the name entry inside
 # is the service name, used for error messages.  More than one nick
@@ -802,6 +805,7 @@ features
 # "IPCHECK_CLONE_LIMIT" = "4";
 # "IPCHECK_CLONE_PERIOD" = "40";
 # "IPCHECK_CLONE_DELAY" = "600";
+# "CHANNELLEN" = "200";
 # "CONFIG_OPERCMDS" = "FALSE";
 # "OPLEVELS" = "TRUE";
 # "LOCAL_CHANNELS" = "TRUE";