Add a note not to use a percent sign ("%") in CloakHost variable

[ngircd-alex.git] / doc / sample-ngircd.conf.tmpl

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index bb9350160c337ea27aac70cba2852bd5c6d663f2..e07b520544c5599d44ed14d04dc22de3f92e1d47 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -22,10 +22,7 @@
 
        # Server name in the IRC network, must contain at least one dot
        # (".") and be unique in the IRC network. Required!
-       Name = irc.the.net
-
-       # Set this hostname for every client instead of the real one
-       ;ClientHost = irc.the.net
+       Name = irc.example.net
 
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
@@ -157,6 +154,14 @@
        # maximum nick name length!
        ;MaxNickLength = 9
 
+       # Set this hostname for every client instead of the real one.
+       # Please note: don't use the percentage sign ("%"), it is reserved for
+       # future extensions!
+       ;CloakHost = irc.example.net
+
+       # Set every clients' user name to their nick name
+       ;CloakUserToNick = yes
+
 [Features]
        # Do any DNS lookups when a client connects to the server.
        ;DNS = yes
@@ -199,11 +204,11 @@
 
        # IRC name of the remote server, must match the "Name" variable in
        # the [Global] section of the other server (when using ngIRCd).
-       ;Name = irc2.the.net
+       ;Name = irc2.example.net
 
        # Internet host name or IP address of the peer (only required when
        # this server should establish the connection).
-       ;Host = connect-to-host.the.net
+       ;Host = connect-to-host.example.net
 
        # IP address to use as _source_ address for the connection. if
        # unspecified, ngircd will let the operating system pick an address.