man/ngircd.conf.5

   1 .\"
   2 .\" $Id: ngircd.conf.5,v 1.11 2003/09/11 12:05:28 alex Exp $
   3 .\"
   4 .TH ngircd.conf 5 "Mai 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 .BR ngircd.conf
  11 is the configuration file for
  12 .BR ngircd (8)
  13 which you should 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 .PP
  19 Sections contain parameters of the form
  20 .PP
  21 .RS
  22 .I name
  23 =
  24 .I value
  25 .RE
  26 .PP
  27 Any line beginning with a semicolon (';') or a hash ('#') character is
  28 treated as a comment and ignored.
  29 .PP
  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 .PP
  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 .PP
  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 .TP
  55 \fBName\fR
  56 Server name in the IRC network
  57 .TP
  58 \fBInfo\fR
  59 Info text of the server. This will be shown by WHOIS and LINKS requests for
  60 example.
  61 .TP
  62 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
  63 Information about the server and the administrator, used by the ADMIN
  64 command.
  65 .TP
  66 \fBPorts\fR
  67 Ports on which the server should listen. There may be more than one port,
  68 separated with ';'. Default: 6667.
  69 .TP
  70 \fBListen\fR
  71 The ip address on which the server should listen. Default is empty, so
  72 the server listens on all configured ip addresses and interfaces.
  73 .TP
  74 \fBMotdFile\fR
  75 Text file with the "message of the day" (MOTD). This message will be shown
  76 to all users connecting to the server.
  77 .TP
  78 \fBServerUID\fR
  79 User ID under which the server should run; you can use the name of the user
  80 or the numerical ID.
  81 .PP
  82 .RS
  83 .B Attention:
  84 .br
  85 For this to work the server must have been
  86 started with root privileges! In addition, the configuration and MOTD files
  87 must be readable by this user, otherwise RESTART and REHASH won't work!
  88 .RE
  89 .TP
  90 \fBServerGID\fR
  91 Group ID under which the ngIRCd should run; you can use the name of the
  92 group or the numerical ID.
  93 .PP
  94 .RS
  95 .B Attention:
  96 .br
  97 For this to work the server must have
  98 been started with root privileges!
  99 .RE
 100 .TP
 101 \fBPingTimeout\fR
 102 After <PingTimeout> seconds of inactivity the server will send a PING to
 103 the peer to test whether it is alive or not. Default: 120.
 104 .TP
 105 \fBPongTimeout\fR
 106 If a client fails to answer a PING with a PONG within <PongTimeout>
 107 seconds, it will be disconnected by the server. Default: 20.
 108 .TP
 109 \fBConnectRetry\fR
 110 The server tries every <ConnectRetry> seconds to establish a link to not yet
 111 (or no longer) connected servers. Default: 60.
 112 .TP
 113 \fBOperCanUseMode\fR
 114 Should IRC Operators be allowed to use the MODE command even if they are
 115 not(!) channel-operators? Default: no.
 116 .TP
 117 \fBMaxConnections\fR
 118 Maximum number of simultaneous connection the server is allowed to accept
 119 (<=0: unlimited). Default: -1.
 120 .TP
 121 \fBMaxJoins\fR
 122 Maximum number of channels a user can be member of (<=0: no limit).
 123 Default: 10.
 124 .SH [OPERATOR]
 125 .I [Operator]
 126 sections are used to define IRC Operators. There may be more than one
 127 .I [Operator]
 128 block, one for each local operator.
 129 .TP
 130 \fBName\fR
 131 ID of the operator (may be different of the nick name).
 132 .TP
 133 \fBPassword\fR
 134 Password of the IRC operator.
 135 .SH [SERVER]
 136 Other servers are configured in
 137 .I [Server]
 138 sections. If you configure a port for the connection, then this ngIRCd
 139 tries to connect to to the other server on the given port; if not, it waits
 140 for the other server to connect.
 141 .PP
 142 The ngIRCd allows "server groups": You can assign an "ID" to every server
 143 with which you want this ngIRCd to link. If a server of a group won't
 144 answer, the ngIRCd tries to connect to the next server in the given group.
 145 But ngIRCd never tries to connect to two servers with the same group ID.
 146 .PP
 147 There may be more than one
 148 .I [Server]
 149 block.
 150 .TP
 151 \fBName\fR
 152 IRC name of the server
 153 .TP
 154 \fBHost\fR
 155 Internet host name of the peer
 156 .TP
 157 \fBPort\fR
 158 Port of the server to which the ngIRCd should connect. If you assign no port
 159 the ngIRCd waits for incoming connections.
 160 .TP
 161 \fBMyPassword\fR
 162 Own password for this connection. This password has to be configured as
 163 "PeerPassword" on the other server.
 164 .TP
 165 \fBPeerPassword\fR
 166 Foreign password for this connection. This password has to be configured as
 167 "MyPassword" on the other server.
 168 .TP
 169 \fBGroup\fR
 170 Group of this server (optional).
 171 .SH [CHANNEL]
 172 Pre-defined channels can be configured in
 173 .I [Channel]
 174 sections. Such channels are created by the server when starting up and even
 175 persist when there are no more members left.
 176 .PP
 177 Persistent channels are marked with the mode 'P', which can be set and unset
 178 by IRC operators like other modes on the fly.
 179 .PP
 180 There may be more than one
 181 .I [Channel]
 182 block.
 183 .TP
 184 \fBName\fR
 185 Name of the channel
 186 .TP
 187 \fBTopic\fR
 188 Topic for this channel
 189 .TP
 190 \fBModes\fR
 191 Initial channel modes.
 192 .SH HINTS
 193 It's wise to use "ngircd --configtest" to validate the configuration file
 194 after changing it. See
 195 .BR ngircd (8)
 196 for details.
 197 .SH AUTHOR
 198 Alexander Barton,
 199 .UR mailto:alex@barton.de
 200 alex@barton.de
 201 .UE
 202 .br
 203 Homepage:
 204 .UR http://arthur.ath.cx/~alex/ngircd/
 205 http://arthur.ath.cx/~alex/ngircd/
 206 .UE
 207 .SH "SEE ALSO"
 208 .BR ngircd (8)
 209 .\"
 210 .\" -eof-