Mac OS X: fix test for packagemaker(1) tool in Makefile

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index ba2d477b10d99d2f91753ae46c000bfe08b81adb..0d0061bcba6bbc83c801f22bc14659830f074901 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,14 +1,13 @@
-# $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
-
 #
-# This is a sample configuration file for the ngIRCd, which must be adepted
-# to the local preferences and needs.
+# This is a sample configuration file for the ngIRCd IRC daemon, which must
+# be customized to the local preferences and needs.
 #
 # Comments are started with "#" or ";".
 #
 # A lot of configuration options in this file start with a ";". You have
 # to remove the ";" in front of each variable to actually set a value!
-# The disabled variables are shown with example values for completeness.
+# The disabled variables are shown with example values for completeness only
+# and the daemon is using compiled-in default settings.
 #
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
 # server interprets the configuration file as expected!
@@ -57,7 +56,7 @@
        # Diffie-Hellman parameters
        ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
 
-       # comma seperated list of IP addresses on which the server should
+       # comma separated list of IP addresses on which the server should
        # listen. Default values are:
        # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
        # so the server listens on all IP addresses of the system by default.
@@ -122,12 +121,16 @@
        # Don't do any DNS lookups when a client connects to the server.
        ;NoDNS = no
 
+       # Don't do any IDENT lookups, even if ngIRCd has been compiled
+       # with support for it.
+       ;NoIdent = no
+
        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
 
-       # Maximum number of simultaneous connection the server is allowed
-       # to accept (0: unlimited):
+       # Maximum number of simultaneous in- and outbound connections the
+       # server is allowed to accept (0: unlimited):
        ;MaxConnections = 0
 
        # Maximum number of simultaneous connections from a single IP address
@@ -180,8 +183,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,13 +204,23 @@
 
        # 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
+       ;SSLConnect = yes
+
+       # Define a (case insensitive) mask matching nick names that should 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" and "ChanServ", you should set this parameter to
+       # something like "*Serv".
+       ;ServiceMask = *Serv
 
 [Server]
        # More [Server] sections, if you like ...
@@ -232,6 +245,10 @@
        # initial channel password (mode k)
        ;Key = Secret
 
+       # Key file, syntax for each line: "<user>:<nick>:<key>".
+       # Default: none.
+       ;KeyFile = /etc/ngircd/#chan.key
+
        # maximum users per channel (mode l)
        ;MaxUsers = 23