Merge branch 'master' of git://git.breakpoint.cc/fw/ngircd-fw

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

diff --git a/man/ngircd.conf.5.tmpl b/man/ngircd.conf.5.tmpl
index af32c411562701a18de5858ba68ce6572218d4ae..cd5922afd9ab4071e8852c397eb4f0f6e1803d74 100644 (file)
--- a/man/ngircd.conf.5.tmpl
+++ b/man/ngircd.conf.5.tmpl
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" $Id: ngircd.conf.5.tmpl,v 1.1 2006/12/25 16:13:26 alex Exp $
+.\" $Id: ngircd.conf.5.tmpl,v 1.7 2007/11/23 16:26:03 fw Exp $

 .\"
 .TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
 .SH NAME
 .\"
 .TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
 .SH NAME


@@ -150,19 +150,49 @@ by non-chanops as if they were coming from the server. Default: no.
 If enabled, no new channels can be created. Useful if
 you do not want to have channels other than those defined in
 the config file.
 If enabled, no new channels can be created. Useful if
 you do not want to have channels other than those defined in
 the config file.

+Default: No.
+.TP
+\fBNoDNS\fR
+If enabled, ngircd will not make DNS lookups when clients connect.
+If you configure ngircd to connect to other servers, ngircd may still
+perform a DNS lookup if required.
+Default: No.
+.TP
+\fBListenIPv4\fR
+Set this to no if you do not want ngircd to accept clients using the standard internet protocol, ipv4.
+This allows use of ngircd in ipv6-only setups.
+Default: Yes.
+.TP
+\fBListenIPv6\fR
+Set this to no if you do not want ngircd to accept clients using the new internet protocol, ipv6.
+Default: Yes.
+.TP
+\fBConnectIPv4\fR
+Set this to no if you do not want ngircd to connect to other irc servers using ipv4.
+This allows use of ngircd in ipv6-only setups.
+Default: Yes.
+.TP
+\fBConnectIPv6\fR
+Set this to no if you do not want ngircd to connect to other irc servers using ipv6.
+Default: Yes.

 .TP
 \fBMaxConnections\fR
 Maximum number of simultaneous connection the server is allowed to accept
 .TP
 \fBMaxConnections\fR
 Maximum number of simultaneous connection the server is allowed to accept

-(<=0: unlimited). Default: -1.
+(0: unlimited). Default: 0.

 .TP
 \fBMaxConnectionsIP\fR
 Maximum number of simultaneous connections from a single IP address that
 .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 server will accept (0: unlimited). This configuration options lowers

 the risk of denial of service attacks (DoS). Default: 5.
 .TP
 \fBMaxJoins\fR
 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).
+Maximum number of channels a user can be member of (0: no limit).

 Default: 10.
 Default: 10.

+.TP
+\fBMaxNickLength\fR
+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!

 .SH [OPERATOR]
 .I [Operator]
 sections are used to define IRC Operators. There may be more than one
 .SH [OPERATOR]
 .I [Operator]
 sections are used to define IRC Operators. There may be more than one


@@ -200,6 +230,10 @@ IRC name of the server
 \fBHost\fR
 Internet host name of the peer
 .TP
 \fBHost\fR
 Internet host name of the peer
 .TP

+\fBBind\fR
+IP address to use as source IP for the outgoing connection. Default ist
+to let the operating system decide.
+.TP

 \fBPort\fR
 Port of the server to which the ngIRCd should connect. If you assign no port
 the ngIRCd waits for incoming connections.
 \fBPort\fR
 Port of the server to which the ngIRCd should connect. If you assign no port
 the ngIRCd waits for incoming connections.


@@ -214,6 +248,9 @@ Foreign password for this connection. This password has to be configured as
 .TP
 \fBGroup\fR
 Group of this server (optional).
 .TP
 \fBGroup\fR
 Group of this server (optional).

+\fBPassive\fR
+Disable automatic connection even if port value is specified. Default: false.
+You can use the IRC Operator command CONNECT later on to create the link.

 .SH [CHANNEL]
 Pre-defined channels can be configured in
 .I [Channel]
 .SH [CHANNEL]
 Pre-defined channels can be configured in
 .I [Channel]


@@ -235,6 +272,12 @@ Topic for this channel
 .TP
 \fBModes\fR
 Initial channel modes.
 .TP
 \fBModes\fR
 Initial channel modes.

+.TP
+\fBKey\fR
+Sets initial channel key (only relevant if mode k is set)
+.TP
+\fBMaxUsers\fR
+Set maximum user limit for this channel (only relevant if mode l is set)

 .SH HINTS
 It's wise to use "ngircd --configtest" to validate the configuration file
 after changing it. See
 .SH HINTS
 It's wise to use "ngircd --configtest" to validate the configuration file
 after changing it. See