man/ngircd.conf.5

   1 .\"
   2 .\" $Id: ngircd.conf.5,v 1.9 2003/03/10 00:58:06 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 .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 \fBMotdFile\fR
  71 Text file with the "message of the day" (MOTD). This message will be shown
  72 to all users connecting to the server.
  73 .TP
  74 \fBServerUID\fR
  75 User ID under which the server should run; you can use the name of the user
  76 or the numerical ID.
  77 .PP
  78 .RS
  79 .B Attention:
  80 .br
  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!
  84 .RE
  85 .TP
  86 \fBServerGID\fR
  87 Group ID under which the ngIRCd should run; you can use the name of the
  88 group or the numerical ID.
  89 .PP
  90 .RS
  91 .B Attention:
  92 .br
  93 For this to work the server must have
  94 been started with root privileges!
  95 .RE
  96 .TP
  97 \fBPingTimeout\fR
  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.
 100 .TP
 101 \fBPongTimeout\fR
 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.
 104 .IT
 105 \fBConnectRetry\fR
 106 The server tries every <ConnectRetry> seconds to establish a link to not yet
 107 (or no longer) connected servers. Default: 60.
 108 .TP
 109 \fBOperCanUseMode\fR
 110 Should IRC Operators be allowed to use the MODE command even if they are
 111 not(!) channel-operators? Default: no.
 112 .TP
 113 \fBMaxConnections\fR
 114 Maximum number of simultaneous connection the server is allowed to accept
 115 (<=0: unlimited). Default: -1.
 116 .TP
 117 \fBMaxJoins\fR
 118 Maximum number of channels a user can be member of (<=0: no limit).
 119 Default: 10.
 120 .SH [OPERATOR]
 121 .I [Operator]
 122 sections are used to define IRC Operators. There may be more than one
 123 .I [Operator]
 124 block, one for each local operator.
 125 .TP
 126 \fBName\fR
 127 ID of the operator (may be different of the nick name).
 128 .TP
 129 \fBPassword\fR
 130 Password of the IRC operator.
 131 .SH [SERVER]
 132 Other servers are configured in
 133 .I [Server]
 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.
 137 .PP
 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.
 142 .PP
 143 There may be more than one
 144 .I [Server]
 145 block.
 146 .TP
 147 \fBName\fR
 148 IRC name of the server
 149 .TP
 150 \fBHost\fR
 151 Internet host name of the peer
 152 .TP
 153 \fBPort\fR
 154 Port of the server to which the ngIRCd should connect. If you assign no port
 155 the ngIRCd waits for incoming connections.
 156 .TP
 157 \fBMyPassword\fR
 158 Own password for this connection. This password has to be configured as
 159 "PeerPassword" on the other server.
 160 .TP
 161 \fBPeerPassword\fR
 162 Foreign password for this connection. This password has to be configured as
 163 "MyPassword" on the other server.
 164 .TP
 165 \fBGroup\fR
 166 Group of this server (optional).
 167 .SH [CHANNEL]
 168 Pre-defined channels can be configured in
 169 .I [Channel]
 170 sections. Such channels are created by the server when starting up and even
 171 persist when there are no more members left.
 172 .PP
 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.
 175 .PP
 176 There may be more than one
 177 .I [Channel]
 178 block.
 179 .TP
 180 \fBName\fR
 181 Name of the channel
 182 .TP
 183 \fBTopic\fR
 184 Topic for this channel
 185 .TP
 186 \fBModes\fR
 187 Initial channel modes.
 188 .SH HINTS
 189 It's wise to use "ngircd --configtest" to validate the configuration file
 190 after changing it. See
 191 .BR ngircd (8)
 192 for details.
 193 .SH AUTHOR
 194 Alexander Barton,
 195 .UR mailto:alex@barton.de
 196 alex@barton.de
 197 .UE
 198 .br
 199 Homepage:
 200 .UR http://arthur.ath.cx/~alex/ngircd/
 201 http://arthur.ath.cx/~alex/ngircd/
 202 .UE
 203 .SH "SEE ALSO"
 204 .BR ngircd (8)
 205 .\"
 206 .\" -eof-