add support for predefined-channel configuration of k and l modes

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 022e77811c2e1609505914b23d38f0d1cd650b3a..6bed77b253cb52c689f07fbc3b2ea80897d3ac71 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.34 2005/09/01 18:16:29 fw Exp $
+# $Id: sample-ngircd.conf,v 1.39 2006/12/29 14:09:48 fw Exp $
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
@@ -7,25 +7,25 @@
 # Comments are started with "#" or ";".
 #
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
-# server interpreted the configuration file as expected!
+# server interprets the configuration file as expected!
 #
 
 [Global]
        # The [Global] section of this file is used to define the main
        # configuration of the server, like the server name and the ports
        # on which the server should be listening.
-       
+
        # Server name in the IRC network, must contain at least one dot
        # (".") and be unique in the IRC network. Required!
        Name = irc.the.net
-       
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
 
        # Global password for all users needed to connect to the server
        ;Password = abc
-       
+
        # Information about the server and the administrator, used by the
        # ADMIN command. Not required by server but by RFC!
        ;AdminInfo1 = Description
@@ -39,7 +39,7 @@
        # IP address on which the server should listen. (Default: empty,
        # so the server listens on all IP addresses of the system)
        ;Listen = 1.2.3.4
-       
+
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
        ;MotdFile = /usr/local/etc/ngircd.motd
@@ -92,11 +92,14 @@
        # Mask IRC Operator mode requests as if they were coming from the
        # server? (This is a compatibility hack for ircd-irc2 servers)
        ;OperServerMode = no
-       
+
+       # Allow Pre-Defined Channels only (see Section [Channels])
+       ;PredefChannelsOnly = no
+
        # Maximum number of simultaneous connection the server is allowed
        # to accept (<=0: unlimited):
        ;MaxConnections = -1
-       
+
        # Maximum number of simultaneous connections from a single IP address
        # the server will accept (<=0: unlimited):
        ;MaxConnectionsIP = 5
@@ -107,7 +110,7 @@
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
-       
+
        # ID of the operator (may be different of the nick name)
        ;Name = TheOper
 
@@ -125,7 +128,7 @@
        # configure a port for the connection, then this ngircd tries to
        # connect to to the other server on the given port; if not it waits
        # for the other server to connect.
-       # There may be more than one server block.
+       # There may be more than one server block, one for each server.
        #
        # Server Groups:
        # The ngIRCd allows "server groups": You can assign an "ID" to every
@@ -133,26 +136,27 @@
        # group won't answer, the ngIRCd tries to connect to the next server
        # in the given group. But the ngircd never tries to connect to two
        # servers with the same group ID.
-       
-       # IRC name of the server
+
+       # 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
-   
-       # Internet host name of the peer
+  
+       # Internet host name or IP address of the peer (only required when
+       # this server should establish the connection).
        ;Host = connect-to-host.the.net
 
        # Port of the server to which the ngIRCd should connect. If you
        # assign no port the ngIRCd waits for incoming connections.
-       ;Port = 6666
+       ;Port = 6667
 
        # Own password for the connection. This password has to be configured
-       # as "PeerPassword" on the other server. Password should be Alphanumeric!
-       # For instance, a leading ':' will _NOT_ work!
+       # as "PeerPassword" on the other server.
        ;MyPassword = MySecret
 
        # Foreign password for this connection. This password has to be
        # configured as "MyPassword" on the other server.
        ;PeerPassword = PeerSecret
-       
+
        # Group of this server (optional)
        ;Group = 123
 
@@ -165,16 +169,22 @@
        # persist when there are no more members left.
        # Persistent channels are marked with the mode 'P', which can be set
        # and unset by IRC operators like other modes on the fly.
-       # There may be more than one [Channel] block.
-       
+       # There may be more than one [Channel] block, one for each channel.
+
        # Name of the channel
        ;Name = #TheName
 
        # Topic for this channel
        ;Topic = a great topic
-       
+
        # Initial channel modes
-       ;Modes = tn
+       ;Modes = tnk
+
+       # initial channel password (mode k)
+       ;Key = Secret
+
+       # maximum users per channel (mode l)
+       ;MaxUsers = 23
 
 [Channel]
        # More [Channel] sections, if you like ...