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