Enable Pidfile /var/run/ircd/ngircd.pid

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

diff --git a/man/ngircd.conf.5 b/man/ngircd.conf.5
index 56a0e594511a8c5ebb287b175536caa6179c0189..49efafded42ac06e7c4b3c5eb84c67d4f8419ab5 100644 (file)
--- a/man/ngircd.conf.5
+++ b/man/ngircd.conf.5
@@ -1,7 +1,7 @@
 .\"
-.\" $Id: ngircd.conf.5,v 1.10 2003/05/02 20:51:42 alex Exp $
+.\" $Id: ngircd.conf.5,v 1.14 2005/02/14 00:42:41 alex Exp $
 .\"
-.TH ngircd.conf 5 "Mai 2003" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "February 2005" ngircd "ngIRCd Manual"
 .SH NAME
 ngircd.conf \- configuration file of ngIRCd
 .SH SYNOPSIS
@@ -65,12 +65,20 @@ command.
 .TP
 \fBPorts\fR
 Ports on which the server should listen. There may be more than one port,
-separated with ';'. Default: 6667.
+separated with ','. Default: 6667.
+.TP
+\fBListen\fR
+The ip address on which the server should listen. Default is empty, so
+the server listens on all configured ip addresses and interfaces.
 .TP
 \fBMotdFile\fR
 Text file with the "message of the day" (MOTD). This message will be shown
 to all users connecting to the server.
 .TP
+\fBMotdPhrase\fR
+A simple Phrase (<256 chars) if you don't want to use a motd file.
+If it is set no MotdFile will be read at all.
+.TP
 \fBServerUID\fR
 User ID under which the server should run; you can use the name of the user
 or the numerical ID.
@@ -94,6 +102,25 @@ For this to work the server must have
 been started with root privileges!
 .RE
 .TP
+\fBChrootDir\fR
+A directory to chroot in when everything is initialized. It doesn't need
+to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
+won't use the chroot() feature.
+.PP
+.RS
+.B Attention:
+.br
+For this to work the server must have
+been started with root privileges!
+.RE
+.TP
+\fBPidFile\fR
+This tells ngIRCd to write its current process ID to a file. Note that the
+pidfile is written AFTER chroot and switching the user ID, i. e. the
+directory the pidfile resides in must be writeable by the ngIRCd user and
+exist in the chroot directory (if configured, see above).
+.RE
+.TP
 \fBPingTimeout\fR
 After <PingTimeout> seconds of inactivity the server will send a PING to
 the peer to test whether it is alive or not. Default: 120.
@@ -114,6 +141,11 @@ not(!) channel-operators? Default: no.
 Maximum number of simultaneous connection the server is allowed to accept
 (<=0: unlimited). Default: -1.
 .TP
+\fBMaxConnectionsIP\fR
+Maximum number of simultaneous connections from a single IP address that
+the server will accept (<=0: unlimited). This configuration options lowers
+the risk of denial of service attacks (DoS). Default: 5.
+.TP
 \fBMaxJoins\fR
 Maximum number of channels a user can be member of (<=0: no limit).
 Default: 10.