Updated manual page.
[ngircd-alex.git] / man / ngircd.conf.5
1 .\"
2 .\" $Id: ngircd.conf.5,v 1.7 2003/03/10 00:23:50 alex Exp $
3 .\"
4 .TH ngircd.conf 5 "March 2003" ngircd "ngIRCd Manual"
5 .SH NAME
6 ngircd.conf \- configuration file of ngIRCd
7 .SH SYNOPSIS
8 .B /usr/local/etc/ngircd.conf
9 .SH DESCRIPTION
10 .B ngircd.conf
11 is the configuration file for
12 .B ngircd
13 which you can adept to your local preferences and needs.
14 .SH FILE FORMAT
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
17 begins.
18
19 Sections contain parameters of the form
20
21 .RS
22 .I name
23 =
24 .I value
25 .RE
26
27 Any line beginning with a semicolon (';') or a hash ('#') character is
28 treated as a comment and ignored.
29
30 The file format is line-based - that means, each newline-terminated line
31 represents either a comment, a section name or a parameter.
32
33 Section and parameter names are not case sensitive.
34 .SH SECTION OVERVIEW
35 The file is separated in four blocks: [Global], [Operator], [Server],
36 and [Channel].
37
38 In the
39 .I [Global]
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
42 server are defined in
43 .I [Operator]
44 blocks.
45 .I [Server]
46 is the section where server links are configured. And
47 .I [Channel]
48 blocks are used to configure pre-defined ("persistent") IRC channels.
49 .SH [GLOBAL]
50 The
51 .I [Global]
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.
54 .IP Name
55 Server name in the IRC network
56 .IP Info
57 Info text of the server. This will be shown by WHOIS and LINKS requests for
58 example.
59 .IP AdminInfo1
60 .IP AdminInfo2
61 .IP AdminEMail
62 Information about the server and the administrator, used by the ADMIN
63 command.
64 .IP Ports
65 Ports on which the server should listen. There may be more than one port,
66 separated with ';'. Default: 6667.
67 .IP MotdFile
68 Text file with the "message of the day" (MOTD). This message will be shown
69 to all users connecting to the server.
70 .IP ServerUID
71 User ID under which the server should run; you can use the name of the user
72 or the numerical ID.
73 .B Attention:
74 For this to work the server must have been
75 started with root privileges! In addition, the configuration and MOTD files
76 must be readable by this user, otherwise RESTART and REHASH won't work!
77 .IP ServerGID
78 Group ID under which the ngircd should run; you can use the name of the
79 group or the numerical ID.
80 .B Attention:
81 For this to work the server must have
82 been started with root privileges!
83 .IP PingTimeout
84 After <PingTimeout> seconds of inactivity the server will send a PING to
85 the peer to test whether it is alive or not. Default: 120.
86 .IP PongTimeout
87 If a client fails to answer a PING with a PONG within <PongTimeout>
88 seconds, it will be disconnected by the server. Default: 20.
89 .IP ConnectRetry
90 The server tries every <ConnectRetry> seconds to establish a link to not yet
91 (or no longer) connected servers. Default: 60.
92 .IP OperCanUseMode
93 Should IRC Operators be allowed to use the MODE command even if they are
94 not(!) channel-operators? Default: no.
95 .IP MaxConnections
96 Maximum number of simultaneous connection the server is allowed to accept
97 (<=0: unlimited). Default: -1.
98 .IP MaxJoins
99 Maximum number of channels a user can be member of (<=0: no limit).
100 Default: 10.
101 .SH [OPERATOR]
102 .I [Operator]
103 sections are used to define IRC Operators. There may be more than one
104 .I [Operator]
105 block, one for each local operator.
106 .IP Name
107 ID of the operator (may be different of the nick name).
108 .IP Password
109 Password of the IRC operator.
110 .SH [SERVER]
111 Other servers are configured in
112 .I [Server]
113 sections. If you configure a port for the connection, then this ngircd
114 tries to connect to to the other server on the given port; if not it waits
115 for the other server to connect.
116
117 The ngIRCd allows "server groups": You can assign an "ID" to every server
118 with which you want this ngIRCd to link. If a server of a group won't
119 answer, the ngIRCd tries to connect to the next server in the given group.
120 But the ngircd never tries to connect to two servers with the same group ID.
121
122 There may be more than one server block.
123 .IP Name
124 IRC name of the server
125 .IP Host
126 Internet host name of the peer
127 .IP Port
128 Port of the server to which the ngIRCd should connect. If you assign no port
129 the ngIRCd waits for incoming connections.
130 .IP MyPassword
131 Own password for this connection. This password has to be configured as
132 "PeerPassword" on the other server.
133 .IP PeerPassword
134 Foreign password for this connection. This password has to be configured as
135 "MyPassword" on the other server.
136 .IP Group
137 Group of this server (optional).
138 .SH [Channel]
139 Pre-defined channels can be configured in [Channel] sections. Such channels
140 are created by the server when starting up and even persist when there are
141 no more members left.
142
143 Persistent channels are marked with the mode 'P', which can be set and unset
144 by IRC operators like other modes on the fly.
145
146 There may be more than one [Channel] block.
147 .IP Name
148 Name of the channel
149 .IP Topic
150 Topic for this channel
151 .IP Modes
152 Initial channel modes.
153 .SH AUTHOR
154 Alexander Barton,
155 .UR mailto:alex@barton.de
156 alex@barton.de
157 .UE
158 .br
159 Homepage:
160 .UR http://arthur.ath.cx/~alex/ngircd/
161 http://arthur.ath.cx/~alex/ngircd/
162 .UE
163 .SH "SEE ALSO"
164 .BR ngircd (8)
165 .BR ircd (8)
166 .\"
167 .\" -eof-