Handle commands in the read buffer before reading more data

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index b5db1d9e1edffa5af2070dfc27bf9fa990590ce6..5892557920f669985b413218e2f90de793ad66ad 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -51,7 +51,7 @@
        # be shown to all users connecting to the server:
        ;MotdFile = :ETCDIR:/ngircd.motd
 
-       # A simple Phrase (<256 chars) if you don't want to use a motd file.
+       # A simple Phrase (<127 chars) if you don't want to use a motd file.
        ;MotdPhrase = "Hello world!"
 
        # The name of the IRC network to which this server belongs. This name
@@ -117,6 +117,12 @@
        # maximum nickname length!
        ;MaxNickLength = 9
 
+       # Maximum penalty time increase in seconds, per penalty event. Set to -1
+       # for no limit (the default), 0 to disable penalties altogether. The
+       # daemon doesn't use penalty increases higher than 2 seconds during
+       # normal operation, so values greater than 1 rarely make sense.
+       ;MaxPenaltyTime = -1
+
        # Maximum number of channels returned in response to a /list
        # command (0: unlimited):
        ;MaxListSize = 100
@@ -193,9 +199,9 @@
        ;MorePrivacy = no
 
        # Normally ngIRCd doesn't send any messages to a client until it is
-       # registered. Enable this option to let the daemon send "NOTICE AUTH"
+       # registered. Enable this option to let the daemon send "NOTICE *"
        # messages to clients while connecting.
-       ;NoticeAuth = no
+       ;NoticeBeforeRegistration = no
 
        # Should IRC Operators be allowed to use the MODE command even if
        # they are not(!) channel-operators?
@@ -226,6 +232,15 @@
        # character prepended to their respective user names!
        ;PAMIsOptional = no
 
+       # When PAM is enabled, this value determines the used PAM
+       # configuration.
+       # This setting allows to run multiple ngIRCd instances with
+       # different PAM configurations on each instance.
+       # If you set it to "ngircd-foo", PAM will use
+       # /etc/pam.d/ngircd-foo instead of the default
+       # /etc/pam.d/ngircd.
+       ;PAMServiceName = ngircd
+
        # Let ngIRCd send an "authentication PING" when a new client connects,
        # and register this client only after receiving the corresponding
        # "PONG" reply.
@@ -294,7 +309,7 @@
 [Server]
        # Other servers are configured in [Server] sections. If you
        # 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
+       # connect 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, one for each server.
        #
@@ -370,19 +385,16 @@
        # Topic for this channel
        ;Topic = a great topic
 
-       # Initial channel modes
-       ;Modes = tnk
-
-       # initial channel password (mode k)
-       ;Key = Secret
+       # Initial channel modes, as used in "MODE" commands. Modifying lists
+       # (ban list, invite list, exception list) is supported.
+       # This option can be specified multiple times, evaluated top to bottom.
+       ;Modes = +tnk mykey +l 5
+       ;Modes = +b nick!~user@bad.host.example.com
 
        # Key file, syntax for each line: "<user>:<nick>:<key>".
        # Default: none.
        ;KeyFile = :ETCDIR:/#chan.key
 
-       # maximum users per channel (mode l)
-       ;MaxUsers = 23
-
 [Channel]
        # More [Channel] sections, if you like ...