]> arthur.barton.de Git - ngircd-alex.git/blobdiff - man/ngircd.conf.5
register io handler before creating new local client structure
[ngircd-alex.git] / man / ngircd.conf.5
index 29346e5575723863d79eaecc055951a656ea16c7..84514e14df15480e61a18b7eaa9e63e5fd34ec5a 100644 (file)
@@ -1,16 +1,17 @@
 .\"
-.\" $Id: ngircd.conf.5,v 1.16 2005/03/15 16:56:17 alex Exp $
+.\" $Id: ngircd.conf.5,v 1.21 2006/12/11 22:07:09 fw Exp $
 .\"
-.TH ngircd.conf 5 "February 2005" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
 .SH NAME
 ngircd.conf \- configuration file of ngIRCd
 .SH SYNOPSIS
 .B /usr/local/etc/ngircd.conf
 .SH DESCRIPTION
 .BR ngircd.conf
-is the configuration file for
+is the configuration file of the
 .BR ngircd (8)
-which you should adept to your local preferences and needs.
+Internet Relay Chat (IRC) daemon which you should adept to your local
+preferences and needs.
 .SH "FILE FORMAT"
 The file consists of sections and parameters. A section begins with the name
 of the section in square brackets and continues until the next section
@@ -24,21 +25,21 @@ Sections contain parameters of the form
 .I value
 .RE
 .PP
-Any line beginning with a semicolon (';') or a hash ('#') character is
-treated as a comment and ignored.
+Empty lines and any line beginning with a semicolon (';') or a hash ('#')
+character is treated as a comment and will be ignored.
 .PP
 The file format is line-based - that means, each newline-terminated line
 represents either a comment, a section name or a parameter.
 .PP
 Section and parameter names are not case sensitive.
 .SH "SECTION OVERVIEW"
-The file is separated in four blocks: [Global], [Operator], [Server],
+The file can contain blocks of four types: [Global], [Operator], [Server],
 and [Channel].
 .PP
 In the
 .I [Global]
 section, there is the main configuration like the server name and the
-ports, on which the server should be listening. IRC operators of this
+ports on which the server should be listening. IRC operators of this
 server are defined in
 .I [Operator]
 blocks.
@@ -46,6 +47,9 @@ blocks.
 is the section where server links are configured. And
 .I [Channel]
 blocks are used to configure pre-defined ("persistent") IRC channels.
+.PP
+There can be more than one [Operator], [Server] and [Channel] sections
+per configuration file, but only one [Global] section.
 .SH [GLOBAL]
 The
 .I [Global]
@@ -68,15 +72,15 @@ Ports on which the server should listen. There may be more than one port,
 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.
+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.
+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
@@ -142,6 +146,11 @@ If OperCanUseMode is enabled, this may lead the compatibility problems with
 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
 by non-chanops as if they were coming from the server. Default: no.
 .TP
+\fBPredefChannelsOnly\fR
+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.
+.TP
 \fBMaxConnections\fR
 Maximum number of simultaneous connection the server is allowed to accept
 (<=0: unlimited). Default: -1.
@@ -197,7 +206,7 @@ the ngIRCd waits for incoming connections.
 .TP
 \fBMyPassword\fR
 Own password for this connection. This password has to be configured as
-"PeerPassword" on the other server.
+"PeerPassword" on the other server. Must not have ':' as first character.
 .TP
 \fBPeerPassword\fR
 Foreign password for this connection. This password has to be configured as
@@ -238,8 +247,8 @@ alex@barton.de
 .UE
 .br
 Homepage:
-.UR http://arthur.ath.cx/~alex/ngircd/
-http://arthur.ath.cx/~alex/ngircd/
+.UR http://ngircd.barton.de/
+http://ngircd.barton.de/
 .UE
 .SH "SEE ALSO"
 .BR ngircd (8)