sample-ngircd.conf & ngircd.conf(5): document "ServiceMask" option.

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index ba2d477b10d99d2f91753ae46c000bfe08b81adb..665edae72dbbb76cbfece09cd004e7749bc426ef 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -180,8 +180,8 @@
        # this server should establish the connection).
        ;Host = connect-to-host.the.net
 
-       # IP address to use as _source_ address for the connection. if unspecified,
-       # ngircd will let the operating system pick an address.
+       # IP address to use as _source_ address for the connection. if
+       # unspecified, ngircd will let the operating system pick an address.
        ;Bind = 10.0.0.1
 
        # Port of the server to which the ngIRCd should connect. If you
@@ -201,14 +201,24 @@
 
        # Set the "Passive" option to "yes" if you don't want this ngIRCd to
        # connect to the configured peer (same as leaving the "Port" variable
-       # empty). The advantage of this option is that you can actually configure
-       # a port an use the IRC command CONNECT more easily to manually connect
-       # this specific server later.
+       # empty). The advantage of this option is that you can actually
+       # configure a port an use the IRC command CONNECT more easily to
+       # manually connect this specific server later.
        ;Passive = no
 
        # Connect to the remote server using TLS/SSL (Default: false)
        ; SSLConnect = yes
 
+       # Define a (case insensitive) mask matching nick names that sould be
+       # treated as IRC services when introduced via this remote server.
+       # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
+       # (which is the default).
+       # When you are connecting IRC services which mask as a IRC server
+       # and which use "virtual users" to communicate with, for example
+       # "NickServ" amd "ChanServ", you should set this parameter to
+       # something like "*Serv".
+       ;ServiceMask = *Serv
+
 [Server]
        # More [Server] sections, if you like ...