1FREECIV(6) Games Manual FREECIV(6)
2
6 freeciv-server - The server for the Freeciv game
7
9 freeciv-server [ -b|--bind address ] [ -d|--debug level_number ] [
10 -e|--exit-on-end ] [ -f|--file filename ] [ -h|--help ] [ -i|--identity
11 address ] [ -l|--log filename ] [ -M|--Metaserver address ] [ -m|--meta
12 ] [ -p|--port port ] [ -P|--Ppm ] [ -q|--quitidle time ] [ -R|--Ranklog
13 filename ] [ -r|--read filename ] [ -S|--Serverid id ] [ -s|--saves
14 directory ] [ -v|--version ]
15 Auth aware servers have additional parameters: [ -a|--auth ] [
17 -G|--Guests ] [ -N|--Newusers ]
18 IPv6 aware servers have additional parameter: [ -A|--announce protocol
20 ]
21
24 Freeciv is a free turn-based multiplayer strategy game, in which each
25 player becomes the leader of a civilization, fighting to obtain the
26 ultimate goal: To become the greatest civilization.
27 Players of Civilization II® by Microprose® should feel at home, since
29 one aim of Freeciv is to have compatible rules.
30 Freeciv is maintained by an international team of coders and enthusi‐
32 asts, and is easily one of the most fun and addictive network games out
33 there!
34 This is the server program used to establish a Freeciv server - See
36 also freeciv-client(6)
37 This manual page only lists the command line arguments. For details of
39 the directives necessary to configure freeciv-server see the Server
40 Manual which can be found at http://www.freeciv.org/ ⟨⟩ as well as the
41 documentation which is part of the Freeciv distribution.
42
44 The following options are accepted on the command line of the server.
45 They may not be combined; that is, "freeciv-server -fp savegame.sav
46 5557" will not work, instead you would need to enter "freeciv-server -f
47 savegame.sav -p 5557". All options have a short form (single hyphen and
48 single letter) and a long form (double hyphen and a complete word);
49 their effects are identical.
50 -A, --announce protocol
52 Uses protocol when announcing game in LAN. Possible values for
53 protocol are:
54 IPv4
56 IPv6
58 none
60 -a, --auth
63 Enables server authentication and allows access to registered
64 players only.
65 -b address, --bind address
67 Sets the address on which the server will listen for clients.
68 -d level_number, --debug level_number
70 Sets the amount of debugging information to be logged in the
71 file named by the -l option. Acceptable values for the
72 level_number are:
73 0 for fatal messages only.
75 1 for fatal and error messages.
77 2 for fatal, error and normal messages.
79 3 for fatal, error, normal, and verbose messages.
81 -e, --exit-on-end
84 When a game ends, exit instead of restarting.
85 -f filename, --file filename
87 Loads a saved game (filename) into the server before initializa‐
88 tion, instead of starting a new game. This is for reloading
89 saved games, or for loading scenarios. The distribution comes
90 with such scenarios, typically stored in
91 /usr/local/share/freeciv/scenario:
92 · british-isles-85x80-v2.80.sav
95 · earth-160x90-v2.sav
97 · earth-80x50-v2.sav
99 · europe-200x100-v2.sav
101 · hagworld-120x60-v1.2.sav
103 · iberian-peninsula-136x100-v1.0.sav
105 -G, --Guests
108 Allow guests to login as 'guest' when authentication is enabled.
109 -h, --help
112 Prints out a description of the command line options and
113 exits.
114 -i address, --identity address
116 Reports the address to the metaserver. Then, the
117 metaserver will use this address to redirect the users.
118 -l filename, --log filename
120 Defines a log file, filename, to be produced during pro‐
121 cessing. Use the -d option to set how much is logged. By
122 default, fatal and normal messages are printed to stan‐
123 dard output. With a log file, such messages go to the
124 log instead.
125 -M address, --Metaserver address
127 Specifies the address of the metaserver to send your
128 server's information to.
129 -m, --meta
131 Directs the server to communicate with a metaserver, a
132 place where Freeciv servers can publish their presence.
133 Freeciv clients consult the metaserver to offer users a
134 selection of games to join. By default the standard
135 Freeciv metaserver is used. You may specify an alternate
136 metaserver with the -M option.
137 -N, --Newusers
139 Allow new users to login and be registered in the players
140 base if authentication is enabled.
141 -p port, --port port
143 Specifies the TCP port number to which clients will con‐
144 nect; players must know this number to be able to connect
145 if they are not to use the default of 5556 decimal. You
146 may need to use this if 5556 is not available for your
147 use on your system, or if you would like to run multiple
148 servers on the same system.
149 -P, --Ppm
151 Save map ppms to savegames.
152 -q time, --quitidle time
154 Quits if no players are present for the specified time,
155 in seconds, and restarts a new server.
156 -R filename, --Ranklog filename
158 Defines a log file, filename, to be produced during pro‐
159 cessing. This log contains information for player rank‐
160 ing.
161 -r filename, --read filename
163 Specifies a file, filename, of server commands which the
164 server will automatically read and process, as if you had
165 typed them in at the server's prompt. The distribution
166 comes with a few examples that set options to be similar
167 to Civilization I® and Civilization II® . The files are
168 named civ1.serv and civ2.serv, and are typically found at
169 /usr/local/share/freeciv/.
170 -S, --Serverid id
172 Sets the server id.
173 -s directory, --saves directory
175 Specifies the directory to place save game files created
176 by the server. This is especially useful when you're
177 running more than one server on the same system, as it
178 inhibits your servers from clobbering other's save game
179 files.
180 -v, --version
182 Causes the server to display its version number and exit.
183
185 freeciv-server --file oldgame.sav --port 2244
186 Starts a server on port 2244, loading the save game file
187 oldgame.sav.
188 freeciv-server -R ranklog -l logfile -r script -f oldgame.sav.gz
190 -p 2244
191 Starts a server on port 2244, loading the save game file
192 oldgame.sav.gz. Ranking related events are written to
193 ranklog, other logging information is written to logfile.
194 When the server starts, it immediately executes the com‐
195 mands contained in script.
196 freeciv-server -m -a -q 60 -p 2244 -d 2 -l logfile -r script -s
198 ~/saves
199 Starts a server on port 2244 with authentication enabled
200 and communicates its existence to the standard Freeciv
201 metaserver. Fatal, error, and normal messages are written
202 to logfile. When the server starts it immediately exe‐
203 cutes the commands contained in script. Save game files
204 are stored in the ~/saves directory. When there are no
205 users on the server for 60 seconds, the server will
206 restart.
207
209 You may enter commands into the server at any time, either
210 before or during the running of a game.
211 Type "help" or "help help" for starters.
213
215 The Freeciv server requires the following files in the Freeciv
216 data directory, which is /usr/local/share/freeciv by default:
217 · default/buildings.ruleset
219 · default/cities.ruleset
221 · default/game.ruleset
223 · default/governments.ruleset
225 · default/nations.ruleset
227 · default/techs.ruleset
229 · default/terrain.ruleset
231 · default/units.ruleset
233 These are the default rule sets used for the game. Alternate
235 sets of rules can be used by placing them in a separate direc‐
236 tory and using the rulesetdir command to change your server's
237 ruleset directory.
238 Type help rulesetdir for more information.
240
242 The Freeciv server accepts these environment variables:
243 FREECIV_CAPS
245 A string containing a list of "capabilities" provided by
246 the server. The compiled-in default should be correct for
247 most purposes, but if you are familiar with the capabil‐
248 ity facility in the source you may use it to enforce some
249 constraints between clients and server.
250 FREECIV_COMPRESSION_LEVEL
252 Sets the compression level for network traffic.
253 FREECIV_DATA_ENCODING
255 Sets the data encoding (used for data files, savegames,
256 and network strings).
257 FREECIV_INTERNAL_ENCODING
259 Sets the internal encoding (used for GUI strings).
260 FREECIV_LOCAL_ENCODING
262 Sets the local encoding (used for terminal output).
263 FREECIV_MULTICAST_GROUP
265 Sets the multicast group (for the LAN tab).
266 FREECIV_PATH
268 A colon separated list of directories pointing to the
269 freeciv data directory. By default freeciv looks in the
270 following directories, in order, for any data files: the
271 current directory; the "data" subdirectory of the current
272 directory; the subdirectory ".freeciv" in the user's home
273 directory; and the directory where the files are placed
274 by running "make install".
275 HOME Specifies the user's home directory.
277 http_proxy
279 Set this variable accordingly when using a proxy.
280 LANG or LANGUAGE
282 Sets the language and locale on some platforms.
283 LC_ALL or LC_CTYPE
285 Similar to LANG (see documentation for your system).
286 USER Specifies the username of the current user.
288
290 Please report bugs to http://gna.org/projects/freeciv/ ⟨⟩
291
294 The Freeciv homepage is located at http://www.freeciv.org/ ⟨⟩
295 Updates and new info is first posted there.
297
299 The Freeciv Team <freeciv-dev AT gna.org>.
300 This manpage was originally put together by Florian Ernst <flo‐
302 rian_ernst AT gmx.net> using the Server Manual and the comments
303 in the sourcecode. It was updated by Ben Bettin <bwbettin AT
304 gmail.com> to add new features, integrate information from the
305 website's online documentation, and for slight formatting
306 adjustments. Feel free to use it as you wish.
307
309 freeciv-client(6) and the Server Manual on the Freeciv homepage.
310 October 22th 2009 FREECIV(6)