| 1 |
.\"
|
| 2 |
.\" Copyright (C) 1998 Mark Baysinger (mbaysing@ucsd.edu)
|
| 3 |
.\" Copyright (C) 1998,1999,2000 Ross Combs (ross@bnetd.org)
|
| 4 |
.\" Copyright (C) 1999 Rob Crittenden (rcrit@greyoak.com)
|
| 5 |
.\"
|
| 6 |
.\" This is free documentation; you can redistribute it and/or
|
| 7 |
.\" modify it under the terms of the GNU General Public License as
|
| 8 |
.\" published by the Free Software Foundation; either version 2 of
|
| 9 |
.\" the License, or (at your option) any later version.
|
| 10 |
.\"
|
| 11 |
.\" The GNU General Public License's references to "object code"
|
| 12 |
.\" and "executables" are to be interpreted as the output of any
|
| 13 |
.\" document formatting or typesetting system, including
|
| 14 |
.\" intermediate and printed output.
|
| 15 |
.\"
|
| 16 |
.\" This manual is distributed in the hope that it will be useful,
|
| 17 |
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 18 |
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 19 |
.\" GNU General Public License for more details.
|
| 20 |
.\"
|
| 21 |
.\" You should have received a copy of the GNU General Public
|
| 22 |
.\" License along with this manual; if not, write to the Free
|
| 23 |
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
|
| 24 |
.\" USA.
|
| 25 |
.\"
|
| 26 |
.TH BNETD.CONF 5 "12 June, 2000" "BNETD" "BNETD User's Manual"
|
| 27 |
.SH NAME
|
| 28 |
bnetd.conf \- configuration for the Unix Battle.net daemon
|
| 29 |
.SH DESCRIPTION
|
| 30 |
The file
|
| 31 |
.I bnetd.conf
|
| 32 |
contains information used by the Unix Battle.net daemon
|
| 33 |
.BR bnetd (1)
|
| 34 |
to obtain system-specific information such as file locations and policies.
|
| 35 |
.LP
|
| 36 |
The file consists of a list of configuration entries and comments. A comment
|
| 37 |
starts with a pound (#) sign and continues to the end of the line. Blank lines
|
| 38 |
and whitespace are ignored between entries. A configuration entry is composed
|
| 39 |
of two fields separated by an equals (=) sign:
|
| 40 |
.IP
|
| 41 |
\f2directive\f1 = \f2value\f1
|
| 42 |
.LP
|
| 43 |
The
|
| 44 |
.I directive
|
| 45 |
field contains the name of the configuration item you want to set to the value
|
| 46 |
of \f2value\f1. If the value contains spaces it should be surrounded by
|
| 47 |
quotation marks ("). The value may not contain quotation marks. Multiple
|
| 48 |
entries are not allowed on a single line.
|
| 49 |
.LP
|
| 50 |
If the field is Boolean, any of \fBtrue\fP, \fBfalse\fP, \fByes\fP, \fBno\fP,
|
| 51 |
\fB1\fP, or \fB0\fP may be used. If the field is numeric, it must be in base
|
| 52 |
ten. If the field is an address list, it must be delimited by commas. Each
|
| 53 |
element may contain a hostname (or IP) and a port number. If a port number is
|
| 54 |
given, it must be preceded by a colon (:). A colon by itself may be used to
|
| 55 |
represent the wildcard address. If the field is a file or directory path, use
|
| 56 |
of an absolute pathname is recommended. The values for \fBiconfile\fP,
|
| 57 |
\fBtosfile\fP, and \fBmpqauthfile\fP are not pathnames but just the names of
|
| 58 |
the files. They must be in the \fBfiledir\fP directory.
|
| 59 |
.LP
|
| 60 |
Recognized values for \f2directive\f1 include:
|
| 61 |
.RS
|
| 62 |
.TP 10
|
| 63 |
.B filedir
|
| 64 |
Specifies the path where downloadable files are stored. These files are
|
| 65 |
include the TOS (terms of service), icons, and ad banners. (Normally "files/")
|
| 66 |
.TP
|
| 67 |
.B userdir
|
| 68 |
Specify the path where user accounts are stored. (Normally "users/")
|
| 69 |
.TP
|
| 70 |
.B reportdir
|
| 71 |
Specify the path where game reports are stored. (Normally "reports/")
|
| 72 |
.TP
|
| 73 |
.B chanlogdir
|
| 74 |
Specify the path where channel logs are stored. (Normally "chanlogs/")
|
| 75 |
.TP
|
| 76 |
.B defacct
|
| 77 |
Specify the path of the default account file. This file contains all default
|
| 78 |
account attributes which are used when an attribute is not set on an actual
|
| 79 |
account. (Normally "bnetd_default_user")
|
| 80 |
.TP
|
| 81 |
.B motdfile
|
| 82 |
Specify the path of the "message of the day" text file. This is displayed
|
| 83 |
when a user enters the first chat channel. (Normally "bnmotd.txt")
|
| 84 |
.TP
|
| 85 |
.B channelfile
|
| 86 |
Specify the path of the permanent channel list. (Normally "channel.list")
|
| 87 |
.TP
|
| 88 |
.B newsfile
|
| 89 |
Specify the path of the file that is printed when the /news command is used.
|
| 90 |
If no file is specified or the file doesn't exist then the server prints
|
| 91 |
"No news today" to the user. (Normally "news.txt")
|
| 92 |
.TP
|
| 93 |
.B adfile
|
| 94 |
Specify the path of the ad banner list which determines which banners to
|
| 95 |
display at which times. (Normally "ad.list")
|
| 96 |
.TP
|
| 97 |
.B ipbanfile
|
| 98 |
Specify the path of the IP ban file which can be used to block connections
|
| 99 |
from certain addresses. (Normally "bnban")
|
| 100 |
.TP
|
| 101 |
.B helpfile
|
| 102 |
Specify the path of the chat command help file. (Normally "bnhelp")
|
| 103 |
.TP
|
| 104 |
.B transfile
|
| 105 |
Specify the path of the game address translation file which can be used to
|
| 106 |
allow players from behind a NAT firewall to play with those outside of the
|
| 107 |
firewall. (Normally "gametrans")
|
| 108 |
.TP
|
| 109 |
.B mpqfile
|
| 110 |
Specify the path of the autoupdate MPQ archive list. It chooses which
|
| 111 |
versions of which clients to update. (Normally "autoupdate")
|
| 112 |
.TP
|
| 113 |
.B logfile
|
| 114 |
Specifies the file where the server appends the event messages selected with
|
| 115 |
the \f3loglevels\f1 field. (Normally "bnetd.log")
|
| 116 |
.TP
|
| 117 |
.B pidfile
|
| 118 |
Specify the path of the file where the server records its process ID.
|
| 119 |
(Normally "bnetd.pid")
|
| 120 |
.TP
|
| 121 |
.B fortunecmd
|
| 122 |
The path for the program to be executed when /fortune is used. See
|
| 123 |
.BR fortune (6).
|
| 124 |
(Normally "/usr/games/fortune")
|
| 125 |
.TP
|
| 126 |
.B loglevels
|
| 127 |
Specify A comma-delimited list of message levels to log. The avaliable levels
|
| 128 |
are:
|
| 129 |
.RS
|
| 130 |
.TP
|
| 131 |
.B trace
|
| 132 |
flow tracing statements
|
| 133 |
.TP
|
| 134 |
.B debug
|
| 135 |
debugging information
|
| 136 |
.TP
|
| 137 |
.B info
|
| 138 |
potentially useful informational
|
| 139 |
.TP
|
| 140 |
.B warn
|
| 141 |
potentially serious events
|
| 142 |
.TP
|
| 143 |
.B error
|
| 144 |
error messages and unexpected events
|
| 145 |
.TP
|
| 146 |
.B fatal
|
| 147 |
fatal errors
|
| 148 |
.RE
|
| 149 |
.TP
|
| 150 |
.B iconfile
|
| 151 |
Specify the name of the BNI chat icons file which must be inside of the
|
| 152 |
.B filedir
|
| 153 |
directory. (Normally "icons.bni")
|
| 154 |
.TP
|
| 155 |
.B tosfile
|
| 156 |
Specify the name of the TOS file which must be inside of the
|
| 157 |
.B filedir
|
| 158 |
directory. (Normally "tos.txt")
|
| 159 |
.TP
|
| 160 |
.B allow_autoupdate
|
| 161 |
Enable or disable to automatic client update facility. If you want to allow
|
| 162 |
different client versions to connect, set this to false. If you want to update
|
| 163 |
all clients to the same version, be sure to also download the MPQ auth file,
|
| 164 |
and the update MPQ.
|
| 165 |
.TP
|
| 166 |
.B mpqauthfile
|
| 167 |
Specify the name of the MPQ authorization file which must be inside of the
|
| 168 |
.B filedir
|
| 169 |
directory. This file is used to determine the current client version. This
|
| 170 |
is only needed if
|
| 171 |
.B allow_autoupdate
|
| 172 |
is turned on. (Normally "IX86ver1.mpq")
|
| 173 |
.TP
|
| 174 |
.B usersync
|
| 175 |
Specify the time in seconds between account file saves. A value of 0 means to
|
| 176 |
wait until shutdown to save account files and not do do periodic updates.
|
| 177 |
.TP
|
| 178 |
.B userflush
|
| 179 |
Specify the number of seconds of inactivity before a user is unloaded from
|
| 180 |
memory (only checked during file account updates, see usersync. After the
|
| 181 |
account has been unloaded, it must be read from disk when accessed again.
|
| 182 |
.TP
|
| 183 |
.B latency
|
| 184 |
How often to send user latency tests to the user, in seconds. These are used
|
| 185 |
to decide how many "lag bars" to print next to users in channels.
|
| 186 |
.TP
|
| 187 |
.B shutdown_delay
|
| 188 |
Specify the amount of time in seconds to delay shutting down the server when it
|
| 189 |
receives a SIGTERM or SIGINT
|
| 190 |
.BR signal (7).
|
| 191 |
.TP
|
| 192 |
.B shutdown_decr
|
| 193 |
You can decrease the amount of time to wait by this value by sending another
|
| 194 |
SIGTERM or SIGINT
|
| 195 |
.BR signal (7).
|
| 196 |
.TP
|
| 197 |
.B newaccounts
|
| 198 |
If this value is true then new accounts may be created by users on the system.
|
| 199 |
Administrators can always use the /addacct chat command.
|
| 200 |
.TP
|
| 201 |
.B kick_oldlogin
|
| 202 |
If this value is true then a second login by the same user will kick off the
|
| 203 |
first, otherwise the second login will get message saying that they are already
|
| 204 |
logged in.
|
| 205 |
.TP
|
| 206 |
.B ask_new_channel
|
| 207 |
If this value is true, a user using the "Channels" button to join a
|
| 208 |
non-existing channel will be asked if they wish to create it just like
|
| 209 |
Battle.net. Otherwise, the channel will be created silently.
|
| 210 |
.TP
|
| 211 |
.B report_all_games
|
| 212 |
If this value is true, all games with more than one player lasting for more
|
| 213 |
than 5 minutes will be logged. Otherwise, only ladder games are logged.
|
| 214 |
.TP
|
| 215 |
.B hide_pass_games
|
| 216 |
If this value is true, private (passworded) games will not be shown in the game
|
| 217 |
list just like Battle.net. Otherwise all games will be listed.
|
| 218 |
.TP
|
| 219 |
.B hide_started_games
|
| 220 |
If this value is true, games which have already stated will not be sent to the
|
| 221 |
clients. The clients filter these games out for Starcraft and Brood War already.
|
| 222 |
.TP
|
| 223 |
.B hide_temp_channels
|
| 224 |
If this value is true, private channels will not be shown in the channel list
|
| 225 |
just like Battle.net. Otherwise all channels will be listed.
|
| 226 |
.TP
|
| 227 |
.B extra_commands
|
| 228 |
If this value is true then all the extended chat commands are enabled,
|
| 229 |
otherwise only those which exist on Battle.net are enabled.
|
| 230 |
.TP
|
| 231 |
.B disc_is_loss
|
| 232 |
If this value is true then any disconnect will be treated as a loss (regardless
|
| 233 |
of the setting in ladder games).
|
| 234 |
.TP
|
| 235 |
.B enable_conn_all
|
| 236 |
If this value is true then all users may use the /con and /connections
|
| 237 |
commands. Otherwise only administrators may use them.
|
| 238 |
.TP
|
| 239 |
.B hide_addr
|
| 240 |
If this value is true then IP addresses will be hidden from non-admins in the
|
| 241 |
output of the /con, /games, /gameinfo, and /netinfo commands.
|
| 242 |
.TP
|
| 243 |
.B chanlog
|
| 244 |
If this value is true then private channels will be logged to files in the
|
| 245 |
.B chanlogdir
|
| 246 |
direcotry. The logging of public (permanent) channels is controlled in the
|
| 247 |
.B channelfile
|
| 248 |
file.
|
| 249 |
.TP
|
| 250 |
.B track
|
| 251 |
Set this value to 0 to disable sending updates to the tracking server. Any
|
| 252 |
other number will set the number of seconds between tracking packets. Try to
|
| 253 |
use a number above 60 seconds unless you know the tracking server administrator
|
| 254 |
doesn't mind being spammed.
|
| 255 |
.TP
|
| 256 |
.B trackaddrs
|
| 257 |
Specify a comma-delimited list of addresses of tracking servers to send updates
|
| 258 |
to. The address for the master server is "track.bnetd.org". A port may be
|
| 259 |
specified after a colon numerically or by name from
|
| 260 |
.BR /etc/services (5).
|
| 261 |
If a port number is not specified, it defaults to 6114.
|
| 262 |
.TP
|
| 263 |
.B location
|
| 264 |
Give a description of the physical location of the server such as
|
| 265 |
"San Diego, CA, USA". This is reported to the tracking server.
|
| 266 |
.TP
|
| 267 |
.B description
|
| 268 |
Give a description of title or role of the server such as
|
| 269 |
"Joe's Spiffy Server". This is reported to the tracking server.
|
| 270 |
.TP
|
| 271 |
.B url
|
| 272 |
Give a URL for the homepage or contact for the server such as
|
| 273 |
"http://www.foo.com/joeserv.html". This is reported to the tracking
|
| 274 |
server.
|
| 275 |
.TP
|
| 276 |
.B contact_name
|
| 277 |
Give the name of the contact for the server such as "Joe Blockhead". This is
|
| 278 |
reported to the tracking server.
|
| 279 |
.TP
|
| 280 |
.B contact_email
|
| 281 |
Give the email address of the contact for the server such as "joe@foo.com".
|
| 282 |
This is reported to the tracking server.
|
| 283 |
.TP
|
| 284 |
.B use_keepalive
|
| 285 |
If this value is set to true, the server will enable the TCP keepalive option
|
| 286 |
to allow the system to detect stale connections.
|
| 287 |
.TP
|
| 288 |
.B servaddrs
|
| 289 |
Specify the comma-delimited list of addresses the server should listen on. A
|
| 290 |
port may be specified after a colon numerically or by name from
|
| 291 |
.BR /etc/services (5).
|
| 292 |
If a port number is not specified, it defaults to 6112.
|
| 293 |
.TP
|
| 294 |
.B udptest_port
|
| 295 |
The UDP port number which is assumed for clients if they don't send SESSIONADDR
|
| 296 |
packets. If it is set to zero, the server will use the remote TCP port number
|
| 297 |
as the default UDP port number.
|
| 298 |
.SH SEE ALSO
|
| 299 |
.BR bnetd (1)
|
| 300 |
.SH AUTHOR
|
| 301 |
Rob Crittenden (\fIrob@bnetd.org\fP),
|
| 302 |
Ross Combs (\fIross@bnetd.org\fP)
|
Parent Directory
| 
Revision Log