Make the maximum /list reply length a configurable limit.

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 26103a759b938ef9fdc1739522b64462de5baaae..77948af09cb01b84330ed258e9488b8eab8f8c5c 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -100,6 +100,10 @@
        # maximum nick name length!
        ;MaxNickLength = 9
 
+       # Maximum number of channels returned in response to a /list
+       # command (0: unlimited):
+       ;MaxListSize = 100
+
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120
@@ -125,9 +129,17 @@
        ;ChrootDir = /var/empty
 
        # Set this hostname for every client instead of the real one.
-       # Please note: don't use the percentage sign ("%"), it is reserved for
-       # future extensions!
-       ;CloakHost = irc.example.net
+       # Use %x to add the hashed value of the original hostname.
+       ;CloakHost = cloaked.host
+
+       # Use this hostname for hostname cloaking on clients that have the
+       # user mode "+x" set, instead of the name of the server.
+       # Use %x to add the hashed value of the original hostname.
+       ;CloakHostModeX = cloaked.user
+
+       # The Salt for cloaked hostname hashing. When undefined a random
+       # hash is generated after each server start.
+       ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
 
        # Set every clients' user name to their nick name
        ;CloakUserToNick = yes
@@ -140,6 +152,8 @@
        ;DNS = yes
 
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
+       # Users identified using IDENT are registered without the "~" character
+       # prepended to their user name.
        ;Ident = yes
 
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
@@ -155,13 +169,31 @@
        # they are not(!) channel-operators?
        ;OperCanUseMode = no
 
+       # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+       ;OperChanPAutoOp = yes
+
        # Mask IRC Operator mode requests as if they were coming from the
        # server? (This is a compatibility hack for ircd-irc2 servers)
        ;OperServerMode = no
 
        # Use PAM if ngIRCd has been compiled with support for it.
+       # Users identified using PAM are registered without the "~" character
+       # prepended to their user name.
        ;PAM = yes
 
+       # When PAM is enabled, all clients are required to be authenticated
+       # using PAM; connecting to the server without successful PAM
+       # authentication isn't possible.
+       # If this option is set, clients not sending a password are still
+       # allowed to connect: they won't become "identified" and keep the "~"
+       # character prepended to their supplied user name.
+       # Please note: To make some use of this behavior, it most probably
+       # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
+       # same time, because you wouldn't be able to distinguish between
+       # Ident'ified and PAM-authenticated users: both don't have a "~"
+       # character prepended to their respective user names!
+       ;PAMIsOptional = no
+
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
 
@@ -272,15 +304,16 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
-       # Define a (case insensitive) mask matching nick names that should be
-       # treated as IRC services when introduced via this remote server.
+       # Define a (case insensitive) list of masks matching nick names that
+       # should be treated as IRC services when introduced via this remote
+       # server, separated by commas (",").
        # 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
+       # something like "*Serv" or "NickServ,ChanServ,XyzServ".
+       ;ServiceMask = *Serv,Global
 
 [Server]
        # More [Server] sections, if you like ...