New configuration option "IdleTimeout": exit daemon when idle

[ngircd-alex.git] / man / ngircd.conf.5.tmpl

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index aff11a67bf86ec6c79d0daae9cfadeff345662f2..e5485dbf10edddc2c7c0532b79902bd696fedbc4 100644 (file)
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -1,7 +1,7 @@
 .\"
 .\" ngircd.conf(5) manual page template
 .\"
-.TH ngircd.conf 5 "Mar 2012" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "Feb 2013" ngIRCd "ngIRCd Manual"
 .SH NAME
 ngircd.conf \- configuration file of ngIRCd
 .SH SYNOPSIS
@@ -101,6 +101,12 @@ IRC network and must contain at least one dot (".") character.
 Information about the server and the administrator, used by the ADMIN
 command. This information is not required by the server but by RFC!
 .TP
+\fBHelpFile\fR (string)
+Text file which contains the ngIRCd help text. This file is required
+to display help texts when using the "HELP <cmd>" command.
+Please note: Changes made to this file take effect when ngircd starts up
+or is instructed to re-read its configuration file.
+.TP
 \fBInfo\fR (string)
 Info text of the server. This will be shown by WHOIS and LINKS requests for
 example.
@@ -164,6 +170,12 @@ should be safe, but it is wise to double-check :-)
 The server tries every <ConnectRetry> seconds to establish a link to not yet
 (or no longer) connected servers. Default: 60.
 .TP
+\fBIdleTimeout\fR (number)
+Number of seconds after which the whole daemon should shutdown when no
+connections are left active after handling at least one client (0: never). This
+can be useful for testing or when ngIRCd is started using "socket activation"
+with systemd(8), for example. Default: 0.
+.TP
 \fBMaxConnections\fR (number)
 Maximum number of simultaneous in- and outbound connections the server is
 allowed to accept (0: unlimited). Default: 0.
@@ -178,10 +190,13 @@ Maximum number of channels a user can be member of (0: no limit).
 Default: 10.
 .TP
 \fBMaxNickLength\fR (number)
-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
+Maximum length of an user nickname (Default: 9, as in RFC 2812). Please
+note that all servers in an IRC network MUST use the same maximum nickname
 length!
 .TP
+\fBMaxListSize\fR (number)
+Maximum number of channels returned in response to a LIST command. Default: 100.
+.TP
 \fBPingTimeout\fR (number)
 After <PingTimeout> seconds of inactivity the server will send a PING to
 the peer to test whether it is alive or not. Default: 120.
@@ -224,7 +239,7 @@ The Salt for cloaked hostname hashing. When undefined a random hash is
 generated after each server start.
 .TP
 \fBCloakUserToNick\fR (boolean)
-Set every clients' user name to their nick name and hide the one supplied
+Set every clients' user name to their nickname and hide the one supplied
 by the IRC client. Default: no.
 .TP
 \fBConnectIPv4\fR (boolean)
@@ -268,6 +283,10 @@ while connecting. Default: no.
 Should IRC Operators be allowed to use the MODE command even if they are
 not(!) channel-operators? Default: no.
 .TP
+\fBOperChanPAutoOp\fR (boolean)
+Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+Default: yes.
+.TP
 \fBOperServerMode\fR (boolean)
 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems
 with Servers that run the ircd-irc2 Software. This Option "masks" mode
@@ -362,7 +381,7 @@ sections are used to define IRC Operators. There may be more than one
 block, one for each local operator.
 .TP
 \fBName\fR (string)
-ID of the operator (may be different of the nick name).
+ID of the operator (may be different of the nickname).
 .TP
 \fBPassword\fR (string)
 Password of the IRC operator.
@@ -422,7 +441,7 @@ You can use the IRC Operator command CONNECT later on to create the link.
 Connect to the remote server using TLS/SSL. Default: false.
 .TP
 \fBServiceMask\fR (string)
-Define a (case insensitive) list of masks matching nick names that should be
+Define a (case insensitive) list of masks matching nicknames 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).