1FREECIV(6) Games Manual FREECIV(6)
2
6 civserver - The server for the Freeciv game
7
9 civserver [ -a|--auth ] [ -b|--bind address ] [ -d|--debug level_number
10 ] [ -e|--exit-on-end ] [ -f|--file filename ] [ -G|--Guests ] [
11 -g|--gamelog filename ] [ -h|--help ] [ -l|--log filename ] [
12 -M|--Metaserver address ] [ -m|--meta ] [ -N|--Newusers ] [ -p|--port
13 port ] [ -q|--quitidle time ] [ -r|--read filename ] [ -S|--Serverid id
14 ] [ -s|--saves directory ] [ -v|--version ]
15
17 Freeciv is a free turn-based multiplayer strategy game, in which each
18 player becomes the leader of a civilization, fighting to obtain the
19 ultimate goal: To become the greatest civilization.
20 Players of Civilization II® by Microprose® should feel at home, since
22 one aim of Freeciv is to have compatible rules.
23 Freeciv is maintained by an international team of coders and enthusi‐
25 asts, and is easily one of the most fun and addictive network games out
26 there!
27 This is the server program used to establish a Freeciv server - See
29 also civclient(6)
30 This manual page only lists the command line arguments. For details of
32 the directives necessary to configure civserver see the Server Manual
33 which can be found at http://www.freeciv.org/ ⟨⟩ as well as the docu‐
34 mentation which is part of the Freeciv distribution.
35
37 The following options are accepted on the command line of the server.
38 They may not be combined; that is, "civserver -fp savegame.sav 555"
39 will not work, instead you would need to enter "civserver -f saveg‐
40 ame.sav -p 555". All options have a short form (single hyphen and sin‐
41 gle letter) and a long form (double hyphen and a complete word); their
42 effects are identical.
43 -a, --auth
45 Enables server authentication and allows access to registered
46 players only.
47 -b address, --bind address
49 Sets the address on which the server will listen for clients.
50 -d level_number, --debug level_number
52 Sets the amount of debugging information to be logged in the
53 file named by the -l option. Acceptable values for the
54 level_number are:
55 0 for fatal messages only.
57 1 for fatal and error messages.
59 2 for fatal, error and normal messages.
61 3 for fatal, error, normal, and verbose messages.
63 -e, --exit-on-end
66 When a game ends, exit instead of restarting.
67 -f filename, --file filename
69 Loads a saved game (filename) into the server before initializa‐
70 tion, instead of starting a new game. This is for reloading
71 saved games, or for loading scenarios. The distribution comes
72 with such scenarios, typically stored in
73 /usr/local/share/freeciv/scenario:
74 · british-isles-85x80-v2.80.sav
77 · earth-160x90-v2.sav
79 · earth-80x50-v2.sav
81 · europe-200x100-v2.sav
83 · hagworld-120x60-v1.2.sav
85 · iberian-peninsula-136x100-v1.0.sav
87 -G, --Guests
90 Allow guests to login as 'guest' when authentication is enabled.
91 -g filename, --gamelog filename
93 Defines a log file, filename, to be produced during processing.
94 This is a game progress log of game-related events recording the
95 activities of the players.
96 -h, --help
98 Prints out a description of the command line options and exits.
99 -l filename, --log filename
101 Defines a log file, filename, to be produced during processing.
102 Use the -d option to set how much is logged. By default, fatal
103 and normal messages are printed to standard output. With a log
104 file, such messages go to the log instead.
105 -M address, --Metaserver address
107 Specifies the address of the metaserver to send your server's
108 information to.
109 -m, --meta
111 Directs the server to communicate with a metaserver, a place
112 where Freeciv servers can publish their presence. Freeciv
113 clients consult the metaserver to offer users a selection of
114 games to join. By default the standard Freeciv metaserver is
115 used. You may specify an alternate metaserver with the -M
116 option.
117 -N, --Newusers
119 Allow new users to login and be registered in the players base
120 if authentication is enabled.
121 -p port, --port port
123 Specifies the TCP port number to which clients will connect;
124 players must know this number to be able to connect if they are
125 not to use the default of 5555 decimal. You may need to use this
126 if 5555 is not available for your use on your system, or if you
127 would like to run multiple servers on the same system.
128 -q time, --quitidle time
130 Quits if no players are present for the specified time, in sec‐
131 onds, and restarts a new server.
132 -r filename, --read filename
134 Specifies a file, filename, of server commands which the server
135 will automatically read and process, as if you had typed them in
136 at the server's prompt. The distribution comes with a few exam‐
137 ples that set options to be similar to Civilization I® and Civi‐
138 lization II® . The files are named civ1.serv and civ2.serv, and
139 are typically found at /usr/local/share/freeciv/.
140 -S, --Serverid id
142 Sets the server id.
143 -s directory, --saves directory
145 Specifies the directory to place save game files created by the
146 server. This is especially useful when you're running more than
147 one server on the same system, as it inhibits your servers from
148 clobbering other's save game files.
149 -v, --version
151 Causes the server to display its version number and exit.
152
154 civserver --file oldgame.sav --port 2244
155 Starts a server on port 2244, loading the save game file
156 oldgame.sav.
157 civserver -g gamelog -l logfile -r script -f oldgame.sav.gz -p 2244
159 Starts a server on port 2244, loading the save game file
160 oldgame.sav.gz. Game related events are written to gamelog,
161 other logging information is written to logfile. When the server
162 starts, it immediately executes the commands contained in
163 script.
164 civserver -m -a -q 60 -p 2244 -d 2 -l logfile -r script -s ~/saves
166 Starts a server on port 2244 with authentication enabled and
167 communicates its existence to the standard Freeciv metaserver.
168 Fatal, error, and normal messages are written to logfile. When
169 the server starts it immediately executes the commands contained
170 in script. Save game files are stored in the ~/saves directory.
171 When there are no users on the server for 60 seconds, the server
172 will restart.
173
175 You may enter commands into the server at any time, either before or
176 during the running of a game.
177 Type "help" or "help help" for starters.
179
181 The Freeciv server requires the following files in the Freeciv data
182 directory, which is /usr/local/share/freeciv by default:
183 · default/buildings.ruleset
185 · default/cities.ruleset
187 · default/game.ruleset
189 · default/governments.ruleset
191 · default/nations.ruleset
193 · default/techs.ruleset
195 · default/terrain.ruleset
197 · default/units.ruleset
199 These are the default rule sets used for the game. Alternate sets of
201 rules can be used by placing them in a separate directory and using the
202 rulesetdir command to change your server's ruleset directory.
203 Type help rulesetdir for more information.
205
207 The Freeciv server accepts these environment variables:
208 FREECIV_CAPS
210 A string containing a list of "capabilities" provided by the
211 server. The compiled-in default should be correct for most pur‐
212 poses, but if you are familiar with the capability facility in
213 the source you may use it to enforce some constraints between
214 clients and server.
215 FREECIV_COMPRESSION_LEVEL
217 Sets the compression level.
218 FREECIV_DATA_ENCODING
220 Sets the data encoding (used for data files, savegames, and net‐
221 work strings).
222 FREECIV_INTERNAL_ENCODING
224 Sets the internal encoding (used for GUI strings).
225 FREECIV_LOCAL_ENCODING
227 Sets the local encoding (used for terminal output).
228 FREECIV_MULTICAST_GROUP
230 Sets the multicast group (for the LAN tab).
231 FREECIV_PATH
233 A colon separated list of directories pointing to the freeciv
234 data directory. By default freeciv looks in the following direc‐
235 tories, in order, for any data files: the current directory; the
236 "data" subdirectory of the current directory; the subdirectory
237 ".freeciv" in the user's home directory; and the directory where
238 the files are placed by running "make install".
239 HOME Specifies the user's home directory.
241 http_proxy
243 Set this variable accordingly when using a proxy.
244 LANG or LANGUAGE
246 Sets the language and locale on some platforms.
247 LC_ALL or LC_CTYPE
249 Similar to LANG (see documentation for your system).
250 USER Specifies the username of the current user.
252
254 Please report bugs to http://bugs.freeciv.org/ ⟨⟩
255 Tickets may also be created by sending an email to <bugs AT
257 freeciv.org>.
258
260 The Freeciv homepage is located at http://www.freeciv.org/ ⟨⟩
261 Updates and new info is first posted there.
263
265 The Freeciv Team <freeciv-dev AT freeciv.org>.
266 This manpage was originally put together by Florian Ernst <flo‐
268 rian_ernst AT gmx.net> using the Server Manual and the comments in the
269 sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add
270 new features, integrate information from the website's online documen‐
271 tation, and for slight formatting adjustments. Feel free to use it as
272 you wish.
273
275 civclient(6) and the Server Manual on the Freeciv homepage.
276 January 29th 2005 FREECIV(6)