1FREECIV(6)                       Games Manual                       FREECIV(6)
2
3
4

NAME

6       freeciv-server - The server for the Freeciv game
7

SYNOPSIS

9       freeciv-server  [  -A|--Announce  protocol  ]  [  -b|--bind address ] [
10       -B|--Bind-meta address ] [ -d|--debug level_number ] [ -e|--exit-on-end
11       ] [ -F|--Fatal [ signal_number ] ] [ -f|--file filename ] [ -h|--help ]
12       [ -i|--identity address ]  [  -k|--keep  ]  [  -l|--log  filename  ]  [
13       -M|--Metaserver   address  ]  [  -m|--meta  ]  [  -p|--port  port  ]  [
14       -q|--quitidle time ] [ -R|--Ranklog filename ] [ -r|--read filename ] [
15       -S|--Serverid id ] [ -s|--saves directory ] [ --scenarios directory ] [
16       -v|--version ]
17
18       Auth  aware  servers  have  additional  parameters:  [  -a|--auth  ]  [
19       -D|--Database file ] [ -G|--Guests ] [ -N|--Newusers ]
20
21       Servers  with  AI  module  support  have  an  additional  parameter:  [
22       -L|--LoadAI module ]
23
24

DESCRIPTION

26       Freeciv is a free turn-based multiplayer strategy game, in  which  each
27       player  becomes  the  leader  of a civilization, fighting to obtain the
28       ultimate goal: To become the greatest civilization.
29
30       Players of Civilization II® by Microprose® should feel at  home,  since
31       one aim of Freeciv is to have compatible rules.
32
33       Freeciv  is  maintained by an international team of coders and enthusi‐
34       asts, and is easily one of the most fun and addictive network games out
35       there!
36
37       This  is  the  server  program used to establish a Freeciv server - see
38       also freeciv-client(6) .
39
40       This manual page only lists the command line arguments. For details  of
41       the  directives  necessary  to  configure freeciv-server see the Server
42       Manual   which    can    be    found    at    the    Freeciv    website
43http://www.freeciv.org/⟩ as well as the documentation which is part of
44       the Freeciv distribution.
45

OPTIONS

47       The following options are accepted on the command line of  the  server.
48       They  may  not  be  combined; that is, "freeciv-server -fp savegame.sav
49       5557" will not work, instead you would need to enter "freeciv-server -f
50       savegame.sav  -p  5557".  Most options have a short form (single hyphen
51       and single letter) and a long form (double hyphen and a complete word);
52       their effects are identical.
53
54       -A protocol, --Announce protocol
55              Uses  protocol when announcing game in LAN.  Possible values for
56              protocol are:
57
58              IPv4
59
60              IPv6
61
62              none
63
64
65       -a, --auth
66              Enables server authentication and allows  access  to  registered
67              players only.  Requires the --Database option to be specified.
68
69       -b address, --bind address
70              Sets the address on which the server will listen for clients.
71
72       -B address, --Bind-meta address
73              Sets  the  address  which  request  to metaserver are sent from.
74              Defaults to address given by -b option.
75
76       -d level_number, --debug level_number
77              Sets the amount of debugging information to  be  logged  in  the
78              file   named  by  the  -l  option.  Acceptable  values  for  the
79              level_number are:
80
81              0    for fatal messages only.
82
83              1    for fatal and error messages.
84
85              2    for fatal, error and normal messages (default).
86
87              3    for fatal, error, normal, and verbose messages.
88
89
90       -D filename, --Database filename
91              Specifies a database configuration file for authentication. This
92              file  specifies  the details of the database. See README.fcdb in
93              the Freeciv distribution for details of its format.
94
95       -e, --exit-on-end
96              When a game ends, exit instead of restarting.
97
98       -F [ signal_number ], --Fatal [ signal_number ]
99              Raise a custom signal on failed assertion.  If signal_number  is
100              not specified, then the ABRT signal will be used.
101
102       -f filename, --file filename
103              Loads a saved game (filename) into the server before initializa‐
104              tion, instead of starting a new  game.  This  is  for  reloading
105              saved games, or for loading scenarios. See ENVIRONMENT for where
106              the server looks for these files.
107
108              The distribution comes with several scenarios, typically  stored
109              in /usr/local/share/freeciv/scenarios, for example:
110
111
112              · british-isles-85x80-v2.80.sav
113
114              · earth-160x90-v2.sav
115
116              · earth-80x50-v3.sav
117
118              · europe-200x100-v2.sav
119
120              · hagworld-120x60-v1.2.sav
121
122              · iberian-peninsula-136x100-v1.0.sav
123
124
125       -G, --Guests
126              Allow guests to login as 'guest' when authentication is enabled.
127
128       -h, --help
129              Prints out a description of the command line options and exits.
130
131       -i address, --identity address
132              Reports  the  address  to  the metaserver.  Then, the metaserver
133              will use this address to redirect the users.
134
135       -L module, --LoadAI module
136              Loads AI module. This option can appear multiple times  to  load
137              different modules.
138
139       -l filename, --log filename
140              Defines  a log file, filename, to be produced during processing.
141              Use the -d option to set how much is logged.  By default, fatal,
142              error, and normal messages are printed to standard output.  With
143              a log file, such messages go to the log  instead.   If  filename
144              already exists, it is appended to.
145
146       -M address, --Metaserver address
147              Specifies  the  address  of the metaserver to send your server's
148              information to. By default, the standard metaserver run  by  the
149              Freeciv maintainers will be used.
150
151       -m, --meta
152              Directs  the  server  to  communicate with a metaserver, a place
153              where  Freeciv  servers  can  publish  their  presence.  Freeciv
154              clients  consult  the  metaserver  to offer users a selection of
155              games to join. By default the  standard  Freeciv  metaserver  is
156              used.  You  may  specify  an  alternate  metaserver  with the -M
157              option.
158
159       -k, --keep
160              Usually freeciv server stops sending updates to the  metaserver,
161              when  there's  problems on the connection once. With this option
162              it keeps on trying to send further updates  even  after  it  has
163              failed  to  send  updated  status  once.  This option implies -m
164              option.
165
166       -N, --Newusers
167              Allow new users to login and be registered in the  players  base
168              if authentication is enabled.
169
170       -p port, --port port
171              Specifies  the  TCP  port  number to which clients will connect;
172              players must know this number to be able to connect if they  are
173              not to use the default of 5556 decimal. You may need to use this
174              if 5556 is not available for your use on your system, or if  you
175              would like to run multiple servers on the same system.
176
177       -q time, --quitidle time
178              Quits  if no players are present for the specified time, in sec‐
179              onds, and restarts a new server.
180
181       -R filename, --Ranklog filename
182              Defines a log file, filename, to be produced during  processing.
183              This log contains information for player ranking.
184
185       -r filename, --read filename
186              Specifies  a file, filename, of server commands which the server
187              will automatically read and process, as if you had typed them in
188              at  the server's prompt. The distribution comes with a few exam‐
189              ples, including files that set options to be  similar  to  Civi‐
190              lization I® and Civilization II® . The files are named civ1.serv
191              and    civ2.serv,     and     are     typically     found     at
192              /usr/local/share/freeciv/.
193
194       -S id, --Serverid id
195              Sets  the  server id. This is used to identify a particular run‐
196              ning game.
197
198       -s directory, --saves directory
199              Specifies the directory to place save game files created by  the
200              server.  This is especially useful when you're running more than
201              one server on the same system, as it inhibits your servers  from
202              clobbering other's save game files.
203
204              (This  does  not  influence  where the server looks when loading
205              save game files; see FREECIV_SAVE_PATH for that.)
206
207       --scenarios directory
208              Specifies the directory to place scenarios saved by  the  server
209              (for instance, those created with the in-game editor).
210
211              (This  does  not  influence  where the server looks when loading
212              scenario files; see FREECIV_SCENARIO_PATH for that.)
213
214       -v, --version
215              Causes the server to display its version number and exit.
216

EXAMPLES

218       freeciv-server --file oldgame.sav --port 2244
219              Starts a server  on  port  2244,  loading  the  save  game  file
220              oldgame.sav.
221
222       freeciv-server  -R  ranklog  -l  logfile -r script -f oldgame.sav.gz -p
223       2244
224              Starts a server  on  port  2244,  loading  the  save  game  file
225              oldgame.sav.gz.  Ranking  related events are written to ranklog,
226              other logging information is written to logfile. When the server
227              starts,  it  immediately  executes  the  commands  contained  in
228              script.
229
230       freeciv-server -m -a -D fc_auth.conf -q 60 -p 2244 -d 2 -l  logfile  -r
231       script -s ~/saves
232              Starts  a  server  on  port 2244 with authentication enabled and
233              communicates its existence to the standard  Freeciv  metaserver.
234              Fatal,  error,  and normal messages are written to logfile. When
235              the server starts it immediately executes the commands contained
236              in  script. Save game files are stored in the ~/saves directory.
237              When there are no users on the server for 60 seconds, the server
238              will restart.
239

COMMANDS

241       You  may  enter  commands into the server at any time, either before or
242       during the running of a game.
243
244       Type "help" or "help help" for starters.
245

FILES

247       The Freeciv server requires the following files  in  the  Freeciv  data
248       directory, which is /usr/local/share/freeciv by default:
249
250       · classic/buildings.ruleset
251
252       · classic/cities.ruleset
253
254       · classic/effects.ruleset
255
256       · classic/game.ruleset
257
258       · classic/governments.ruleset
259
260       · classic/nations.ruleset
261
262       · classic/styles.ruleset
263
264       · classic/techs.ruleset
265
266       · classic/terrain.ruleset
267
268       · classic/units.ruleset
269
270       · classic/script.lua
271
272       · default/default.lua
273
274       · default/nationlist.ruleset
275
276       These  are  the  default rule sets used for the game. Alternate sets of
277       rules can be used by placing them in a separate directory and using the
278       rulesetdir command to change your server's ruleset directory.
279
280       Type help rulesetdir for more information.
281

ENVIRONMENT

283       The Freeciv server accepts these environment variables:
284
285       FREECIV_CAPS
286              A  string  containing  a  list of "capabilities" provided by the
287              server. The compiled-in default should be correct for most  pur‐
288              poses,  but  if you are familiar with the capability facility in
289              the source you may use it to enforce  some  constraints  between
290              clients and server.
291
292       FREECIV_COMPRESSION_LEVEL
293              Sets the compression level for network traffic.
294
295       FREECIV_DATA_ENCODING
296              Sets  the character encoding used for data files, savegames, and
297              network strings). This should not normally be changed  from  the
298              default of UTF-8, since that is the format of the supplied rule‐
299              sets and the standard network protocol.
300
301       FREECIV_INTERNAL_ENCODING
302              Sets the character encoding used internally  by  freeciv-server;
303              this  encoding  should not be visible at any interface. Defaults
304              to UTF-8.
305
306       FREECIV_LOCAL_ENCODING
307              Sets the local character encoding (used for the command line and
308              terminal  output). The default is inferred from other aspects of
309              the environment.
310
311       FREECIV_MULTICAST_GROUP
312              Sets the multicast group (for the LAN tab).
313
314       FREECIV_DATA_PATH
315              A colon separated list of directories pointing  to  the  freeciv
316              data  directories.  By  default  Freeciv  looks in the following
317              directories, in order, for any data files:  the  current  direc‐
318              tory; the "data" subdirectory of the current directory; the sub‐
319              directory ".freeciv/2.6" in the user's home directory;  and  the
320              directory  where the files are placed by running "make install".
321              If not set, FREECIV_PATH is checked before  these  defaults  are
322              used.
323
324       FREECIV_SAVE_PATH
325              A  colon  separated  list of directories pointing to the freeciv
326              save directories. By default  Freeciv  looks  in  the  following
327              directories,  in  order,  for save files: the current directory;
328              and the subdirectory ".freeciv/saves" in the user's home  direc‐
329              tory.  If not set, FREECIV_PATH is checked before these defaults
330              are used; in this case Freeciv also looks in  "saves"  potential
331              subdirectories.
332
333              (This  does not affect where the server creates save game files;
334              see the --saves option for that.)
335
336       FREECIV_SCENARIO_PATH
337              A colon separated list of directories pointing  to  the  freeciv
338              scenario  directories. By default Freeciv looks in the following
339              directories, in order, for scenario files:  the  current  direc‐
340              tory;  the  "data/scenarios"  subdirectory of the current direc‐
341              tory;  the  subdirectories  ".freeciv/2.6/scenarios"  and   then
342              ".freeciv/scenarios"  in  the  user's  home  directory;  and the
343              directory where the files are placed by running "make  install".
344              If  not  set,  FREECIV_PATH is checked before these defaults are
345              used; in this case Freeciv also looks in "scenario" and "scenar‐
346              ios" potential subdirectories.
347
348              (This  does  not affect where the server creates scenario files;
349              see the --scenarios option for that.)
350
351       FREECIV_PATH
352              A colon separated list of directories to look for various files.
353              This    variable    has    no   effect   if   FREECIV_DATA_PATH,
354              FREECIV_SAVE_PATH   and   FREECIV_SCENARIO_PATH   are    defined
355              together;  those  variables  are the recommended way to override
356              paths, with FREECIV_PATH provided only for backward  compatibil‐
357              ity with older versions of Freeciv; FREECIV_PATH will be removed
358              in a future release. The precise search path depends on the type
359              of file being searched for.
360
361       HOME   Specifies the user's home directory.
362
363       http_proxy
364              Set this variable accordingly when using a proxy.
365
366       LANG  or  LANGUAGE
367              Sets the language and locale on some platforms.
368
369       LC_ALL  or  LC_CTYPE
370              Similar to LANG (see documentation for your system).
371
372       USER   Specifies the username of the current user.
373

BUGS

375       Please     report     bugs     to     the     Freeciv    bug    tracker
376https://www.hostedredmine.com/projects/freeciv⟩ .
377
378

MORE INFO

380       See the Freeciv homepage ⟨http://www.freeciv.org/⟩ .
381
382       Updates and new info is first posted there.
383

AUTHORS

385       The Freeciv Team <freeciv-dev AT freelists.org>.
386
387       This manpage  was  originally  put  together  by  Florian  Ernst  <flo‐
388       rian_ernst  AT gmx.net> using the Server Manual and the comments in the
389       sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add
390       new  features, integrate information from the website's online documen‐
391       tation, and for slight formatting adjustments. Feel free to use  it  as
392       you wish.
393

SEE ALSO

395       freeciv-client(6) and the Server Manual on the Freeciv homepage.
396
397
398
399                              December 10th 2011                    FREECIV(6)
Impressum