2 .\" $Id: ngircd.conf.5,v 1.10 2003/05/02 20:51:42 alex Exp $
4 .TH ngircd.conf 5 "Mai 2003" ngircd "ngIRCd Manual"
6 ngircd.conf \- configuration file of ngIRCd
8 .B /usr/local/etc/ngircd.conf
11 is the configuration file for
13 which you should adept to your local preferences and needs.
15 The file consists of sections and parameters. A section begins with the name
16 of the section in square brackets and continues until the next section
19 Sections contain parameters of the form
27 Any line beginning with a semicolon (';') or a hash ('#') character is
28 treated as a comment and ignored.
30 The file format is line-based - that means, each newline-terminated line
31 represents either a comment, a section name or a parameter.
33 Section and parameter names are not case sensitive.
34 .SH "SECTION OVERVIEW"
35 The file is separated in four blocks: [Global], [Operator], [Server],
40 section, there is the main configuration like the server name and the
41 ports, on which the server should be listening. IRC operators of this
46 is the section where server links are configured. And
48 blocks are used to configure pre-defined ("persistent") IRC channels.
52 section is used to define the server main configuration, like the server
53 name and the ports on which the server should be listening.
56 Server name in the IRC network
59 Info text of the server. This will be shown by WHOIS and LINKS requests for
62 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
63 Information about the server and the administrator, used by the ADMIN
67 Ports on which the server should listen. There may be more than one port,
68 separated with ';'. Default: 6667.
71 Text file with the "message of the day" (MOTD). This message will be shown
72 to all users connecting to the server.
75 User ID under which the server should run; you can use the name of the user
81 For this to work the server must have been
82 started with root privileges! In addition, the configuration and MOTD files
83 must be readable by this user, otherwise RESTART and REHASH won't work!
87 Group ID under which the ngIRCd should run; you can use the name of the
88 group or the numerical ID.
93 For this to work the server must have
94 been started with root privileges!
98 After <PingTimeout> seconds of inactivity the server will send a PING to
99 the peer to test whether it is alive or not. Default: 120.
102 If a client fails to answer a PING with a PONG within <PongTimeout>
103 seconds, it will be disconnected by the server. Default: 20.
106 The server tries every <ConnectRetry> seconds to establish a link to not yet
107 (or no longer) connected servers. Default: 60.
110 Should IRC Operators be allowed to use the MODE command even if they are
111 not(!) channel-operators? Default: no.
114 Maximum number of simultaneous connection the server is allowed to accept
115 (<=0: unlimited). Default: -1.
118 Maximum number of channels a user can be member of (<=0: no limit).
122 sections are used to define IRC Operators. There may be more than one
124 block, one for each local operator.
127 ID of the operator (may be different of the nick name).
130 Password of the IRC operator.
132 Other servers are configured in
134 sections. If you configure a port for the connection, then this ngIRCd
135 tries to connect to to the other server on the given port; if not, it waits
136 for the other server to connect.
138 The ngIRCd allows "server groups": You can assign an "ID" to every server
139 with which you want this ngIRCd to link. If a server of a group won't
140 answer, the ngIRCd tries to connect to the next server in the given group.
141 But ngIRCd never tries to connect to two servers with the same group ID.
143 There may be more than one
148 IRC name of the server
151 Internet host name of the peer
154 Port of the server to which the ngIRCd should connect. If you assign no port
155 the ngIRCd waits for incoming connections.
158 Own password for this connection. This password has to be configured as
159 "PeerPassword" on the other server.
162 Foreign password for this connection. This password has to be configured as
163 "MyPassword" on the other server.
166 Group of this server (optional).
168 Pre-defined channels can be configured in
170 sections. Such channels are created by the server when starting up and even
171 persist when there are no more members left.
173 Persistent channels are marked with the mode 'P', which can be set and unset
174 by IRC operators like other modes on the fly.
176 There may be more than one
184 Topic for this channel
187 Initial channel modes.
189 It's wise to use "ngircd --configtest" to validate the configuration file
190 after changing it. See
195 .UR mailto:alex@barton.de
200 .UR http://arthur.ath.cx/~alex/ngircd/
201 http://arthur.ath.cx/~alex/ngircd/