1
.\" Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
2
.\" This program is free software; you can redistribute it and/or modify
3
.\" it under the terms of the GNU General Public License as published by
4
.\" the Free Software Foundation; either version 2, or (at your option)
7
.\" This program is distributed in the hope that it will be useful,
8
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
9
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
.\" GNU General Public License for more details.
12
.TH FREECIV 6 "April 16th 2008"
14
civserver \- The server for the Freeciv game
17
[ \-b|\-\-bind \fIaddress\fP ] \
18
[ \-d|\-\-debug \fIlevel_number\fP ] \
19
[ \-e|\-\-exit\-on\-end ] \
20
[ \-f|\-\-file \fIfilename\fP ] \
22
[ \-i|\-\-identity \fIaddress\fP ] \
23
[ \-l|\-\-log \fIfilename\fP ] \
24
[ \-M|\-\-Metaserver \fIaddress\fP ] \
26
[ \-p|\-\-port \fIport\fP ] \
28
[ \-q|\-\-quitidle \fItime\fP ] \
29
[ \-R|\-\-Ranklog \fIfilename\fP ] \
30
[ \-r|\-\-read \fIfilename\fP ] \
31
[ \-S|\-\-Serverid \fIid\fP ] \
32
[ \-s|\-\-saves \fIdirectory\fP ] \
35
Auth aware servers have additional parameters:
41
Freeciv is a free turn-based multiplayer strategy game, in which each player
42
becomes the leader of a civilization, fighting to obtain the ultimate goal:
43
To become the greatest civilization.
45
Players of Civilization II\*R by Microprose\*R should feel at home, since one
46
aim of Freeciv is to have compatible rules.
48
Freeciv is maintained by an international team of coders and enthusiasts, and is
49
easily one of the most fun and addictive network games out there!
51
This is the server program used to establish a Freeciv server - See also
54
This manual page only lists the command line arguments. For details
55
of the directives necessary to configure
57
see the Server Manual which can be found at
59
http://www.freeciv.org/
61
as well as the documentation which is part of the Freeciv distribution.
63
The following options are accepted on the command line of the server. They may
64
not be combined; that is, "civserver \-fp savegame.sav 5557" will not work,
65
instead you would need to enter "civserver \-f savegame.sav \-p 5557". All
66
options have a short form (single hyphen and single letter) and a long form
67
(double hyphen and a complete word); their effects are identical.
70
Enables server authentication and allows access to registered players only.
72
.BI "\-b \fIaddress\fP, \-\-bind \fIaddress\fP"
73
Sets the \fIaddress\fP on which the server will listen for clients.
75
.BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP"
76
Sets the amount of debugging information to be logged in the file named by the
78
option. Acceptable values for the \fIlevel_number\fP are:
80
\fB0\fP for fatal messages only.
82
\fB1\fP for fatal and error messages.
84
\fB2\fP for fatal, error and normal messages.
86
\fB3\fP for fatal, error, normal, and verbose messages.
89
.BI "\-e, \-\-exit\-on\-end"
90
When a game ends, exit instead of restarting.
92
.BI "\-f \fIfilename\fP, \-\-file \fIfilename\fP"
93
Loads a saved game (\fIfilename\fP) into the server before initialization,
94
instead of starting a new game. This is for reloading saved games, or for
95
loading scenarios. The distribution comes with such scenarios, typically stored
96
in \fI/usr/local/share/freeciv/scenario\fP:
100
.I british\-isles\-85x80\-v2.80.sav
103
.I earth\-160x90\-v2.sav
106
.I earth\-80x50\-v2.sav
109
.I europe\-200x100\-v2.sav
112
.I hagworld\-120x60\-v1.2.sav
115
.I iberian\-peninsula\-136x100\-v1.0.sav
118
.BI "\-G, \-\-Guests"
119
Allow guests to login as 'guest' when authentication is enabled.
123
Prints out a description of the command line options and exits.
125
.BI "\-i \fIaddress\fP, \-\-identity \fIaddress\fP"
126
Reports the \fIaddress\fP to the metaserver. Then, the metaserver will use
127
this address to redirect the users.
129
.BI "\-l \fIfilename\fP, \-\-log \fIfilename\fP"
130
Defines a log file, \fIfilename\fP, to be produced during processing. Use the
132
option to set how much is logged. By default, fatal and normal messages are
133
printed to standard output. With a log file, such messages go to the log
136
.BI "\-M \fIaddress\fP, \-\-Metaserver \fIaddress\fP"
137
Specifies the \fIaddress\fP of the metaserver to send your server's information
141
Directs the server to communicate with a metaserver, a place where Freeciv
142
servers can publish their presence. Freeciv clients consult the metaserver to
143
offer users a selection of games to join. By default the standard Freeciv
144
metaserver is used. You may specify an alternate metaserver with the \fI\-M\fP
147
.BI "\-N, \-\-Newusers"
148
Allow new users to login and be registered in the players base if authentication
151
.BI "\-p \fIport\fP, \-\-port \fIport\fP"
152
Specifies the TCP \fIport\fP number to which clients will connect; players must know
153
this number to be able to connect if they are not to use the default of 5556
154
decimal. You may need to use this if 5556 is not available for your use on your
155
system, or if you would like to run multiple servers on the same system.
158
Save map ppms to savegames.
160
.BI "\-q \fItime\fP, \-\-quitidle \fItime\fP"
161
Quits if no players are present for the specified \fItime\fP, in seconds, and
162
restarts a new server.
164
.BI "\-R \fIfilename\fP, \-\-Ranklog \fIfilename\fP"
165
Defines a log file, \fIfilename\fP, to be produced during processing. This log
166
contains information for player ranking.
168
.BI "\-r \fIfilename\fP, \-\-read \fIfilename\fP"
169
Specifies a file, \fIfilename\fP, of server commands which the server will
170
automatically read and process, as if you had typed them in at the server's
171
prompt. The distribution comes with a few examples that set options to be
172
similar to Civilization I\*R and Civilization II\*R . The files are named
173
\fIciv1.serv\fP and \fIciv2.serv\fP, and are typically found at
174
\fI/usr/local/share/freeciv/\fP.
176
.BI "\-S, \-\-Serverid \fIid\fP"
177
Sets the server \fIid\fP.
179
.BI "\-s \fIdirectory\fP, \-\-saves \fIdirectory\fP"
180
Specifies the \fIdirectory\fP to place save game files created by the server.
181
This is especially useful when you're running more than one server on the same
182
system, as it inhibits your servers from clobbering other's save game files.
184
.BI "\-v, \-\-version"
185
Causes the server to display its version number and exit.
188
.B civserver \-\-file oldgame.sav \-\-port 2244
189
Starts a server on port \fI2244\fP, loading the save game file
192
.B civserver \-R ranklog \-l logfile \-r script \-f oldgame.sav.gz -p 2244
193
Starts a server on port \fI2244\fP, loading the save game file
194
\fIoldgame.sav.gz\fP. Ranking related events are written to \fIranklog\fP, other
195
logging information is written to \fIlogfile\fP. When the server starts, it
196
immediately executes the commands contained in \fIscript\fP.
198
.B civserver -m -a -q 60 -p 2244 -d 2 -l logfile -r script -s ~/saves
199
Starts a server on port \fI2244\fP with authentication enabled and communicates
200
its existence to the standard Freeciv metaserver. Fatal, error, and normal
201
messages are written to \fIlogfile\fP. When the server starts it immediately
202
executes the commands contained in \fIscript\fP. Save game files are stored in
203
the \fI~/saves\fP directory. When there are no users on the server for \fI60\fP
204
seconds, the server will restart.
206
You may enter commands into the server at any time, either before or during the
209
Type "help" or "help help" for starters.
211
The Freeciv server requires the following files in the Freeciv data directory,
213
.I /usr/local/share/freeciv
217
.I default/buildings.ruleset
220
.I default/cities.ruleset
223
.I default/game.ruleset
226
.I default/governments.ruleset
229
.I default/nations.ruleset
232
.I default/techs.ruleset
235
.I default/terrain.ruleset
238
.I default/units.ruleset
240
These are the default rule sets used for the game. Alternate sets of rules can
241
be used by placing them in a separate directory and using the \fBrulesetdir\fP
242
command to change your server's ruleset directory.
244
Type \fBhelp rulesetdir\fP for more information.
246
The Freeciv server accepts these environment variables:
249
A string containing a list of "capabilities" provided by the server. The
250
compiled-in default should be correct for most purposes, but if you are familiar
251
with the capability facility in the source you may use it to enforce some
252
constraints between clients and server.
254
.BI FREECIV_COMPRESSION_LEVEL
255
Sets the compression level for network traffic.
257
.BI FREECIV_DATA_ENCODING
258
Sets the data encoding (used for data files, savegames, and network strings).
260
.BI FREECIV_INTERNAL_ENCODING
261
Sets the internal encoding (used for GUI strings).
263
.BI FREECIV_LOCAL_ENCODING
264
Sets the local encoding (used for terminal output).
266
.BI FREECIV_MULTICAST_GROUP
267
Sets the multicast group (for the LAN tab).
270
A colon separated list of directories pointing to the
272
data directory. By default freeciv looks in the following directories, in order,
273
for any data files: the current directory; the "data" subdirectory of the
274
current directory; the subdirectory ".freeciv" in the user's home directory; and
275
the directory where the files are placed by running "make install".
278
Specifies the user's home directory.
281
Set this variable accordingly when using a proxy.
283
\fBLANG\fP or \fBLANGUAGE\fP
284
Sets the language and locale on some platforms.
286
\fBLC_ALL\fP or \fBLC_CTYPE\fP
287
Similar to LANG (see documentation for your system).
290
Specifies the username of the current user.
292
Please report bugs to
294
http://bugs.freeciv.org/
299
The Freeciv homepage is located at
301
http://www.freeciv.org/
305
Updates and new info is first posted there.
307
The Freeciv Team <freeciv-dev AT freeciv.org>.
309
This manpage was originally put together by Florian Ernst
310
<florian_ernst AT gmx.net> using the Server Manual and the comments in the
311
sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add new
312
features, integrate information from the website's online documentation, and
313
for slight formatting adjustments. Feel free to use it as you wish.
316
and the Server Manual on the Freeciv homepage.
added
removed
doc/man/civserver.6
