[svn] Clarify format of IPv6 addresses in auth{} and connect{}.

[irc/rqf/shadowircd.git] / doc / example.conf

diff --git a/doc/example.conf b/doc/example.conf
index c3d5e652e167ef22809104ebfbeaa26d78bfddd9..d68311da46448ba2cb0e310b1bee4053eb064e7a 100755 (executable)
--- a/doc/example.conf
+++ b/doc/example.conf
@@ -4,7 +4,7 @@
  * Copyright (C) 2002-2005 ircd-ratbox development team
  * Copyright (C) 2005-2006 charybdis development team
  *
- * $Id: example.conf 3550 2007-08-09 06:47:26Z nenolod $
+ * $Id: example.conf 3562 2007-08-29 22:04:45Z jilles $
  *
  * See reference.conf for more information.
  */
@@ -116,8 +116,11 @@ listen {
  * then general access, then restricted.
  */
 auth {
-       /* user: the user@host allowed to connect.  multiple IPv4/IPv6 user 
-        * lines are permitted per auth block.
+       /* user: the user@host allowed to connect.  Multiple IPv4/IPv6 user
+        * lines are permitted per auth block.  This is matched against the
+        * hostname and IP address (using :: shortening for IPv6 and
+        * prepending a 0 if it starts with a colon) and can also use CIDR
+        * masks.
         */
        user = "*@172.16.0.0/12";
        user = "*test@123D:B567:*";
@@ -242,7 +245,8 @@ connect "irc.uplink.com" {
        class = "server";
        flags = compressed, topicburst;
 
-       /* If the connection is IPv6, uncomment below */
+       /* If the connection is IPv6, uncomment below.
+        * Use 0::1, not ::1, for IPv6 localhost. */
        #aftype = ipv6;
 };