Add documentation for "RequireAuthPing" configuration option

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index fee3570ef2780c2590812306d1977180ec5f1371..6e02048ffd93774bbe955f1490e05c43aaed80a9 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -154,11 +154,18 @@
        # maximum nick name length!
        ;MaxNickLength = 9
 
-       # Set this hostname for every client instead of the real one
-       ;ClientHost = irc.example.net
+       # Let ngIRCd send an "authentication PING" when a new client connects,
+       # and register this client only after receiving the corresponding
+       # "PONG" reply.
+       ;RequireAuthPing = no
+
+       # 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
-       ;ClientUserNick = yes
+       ;CloakUserToNick = yes
 
 [Features]
        # Do any DNS lookups when a client connects to the server.