Introduce option to configure the maximum nick name lenth in ngircd.conf

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 19c3f43e0c8f6f83dca6c819ffb62e98074b1ede..924f0595450939600f516516f97bf5b063bca401 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.37 2006/04/09 12:27:23 alex Exp $
+# $Id: sample-ngircd.conf,v 1.42 2007/11/21 12:16:35 alex Exp $
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
@@ -6,6 +6,10 @@
 #
 # 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.
+#
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
 # server interprets the configuration file as expected!
 #
@@ -93,17 +97,25 @@
        # 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
+       # to accept (0: unlimited):
+       ;MaxConnections = 0
 
        # Maximum number of simultaneous connections from a single IP address
-       # the server will accept (<=0: unlimited):
+       # the server will accept (0: unlimited):
        ;MaxConnectionsIP = 5
 
-       # Maximum number of channels a user can be member of (<=0: no limit):
+       # Maximum number of channels a user can be member of (0: no limit):
        ;MaxJoins = 10
 
+       # Maximum length of an user nick name (Default: 9, as in RFC 2812).
+       # Please note that all servers in an IRC network MUST use the same
+       # maximum nick name length!
+       ;MaxNickLength = 9
+
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
@@ -157,6 +169,13 @@
        # Group of this server (optional)
        ;Group = 123
 
+       # 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.
+       ;Passive = no
+
 [Server]
        # More [Server] sections, if you like ...
 
@@ -175,7 +194,13 @@
        ;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 ...