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

NAME

6       freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22, freeciv-sdl, freeciv-sdl2,
7       freeciv-qt, freeciv-xaw - The clients for the Freeciv game
8

SYNOPSIS

10       freeciv-gtk2|freeciv-gtk3|freeciv-gtk3.22|freeciv-sdl|freeciv-
11       sdl2|freeciv-qt|freeciv-xaw  [ -A|--Announce protocol ] [ -a|--autocon‐
12       nect ] [ -d|--debug level_number ] [ -F|--Fatal [ signal_number ]  ]  [
13       -f|--file  filename  ]  [ -h|--help ] [ -l|--log filename ] [ -M|--Meta
14       URL ] [ -n|--name name ] [ -p|--port port ] [ -P|--Plugin  string  ]  [
15       -r|--read  filename  ]  [  -s|--server  address ] [ -S|--Sound name ] [
16       -t|--tiles name ] [ -v|--version ] [ -- client-specific-parameters ]
17
18       freeciv-gtk2 accepts the standard Gtk parameters following --; see  the
19       Gtk documentation. It also accepts [ -h|--help ]
20
21       freeciv-gtk3  accepts the standard Gtk parameters following --; see the
22       Gtk documentation. It also accepts [ -g|--gtk-warnings ] [ -h|--help  ]
23       [ -r|--resolution WIDTHxHEIGHT ]
24
25       freeciv-gtk3.22  accepts  the standard Gtk parameters following --; see
26       the Gtk documentation. It also accepts [ -h|--help ] [  -r|--resolution
27       WIDTHxHEIGHT ]
28
29       freeciv-qt  accepts the standard Qt parameters following --; see the Qt
30       documentation. It also accepts [ -h|--help ]
31
32       freeciv-sdl  accepts  the  following   parameters   following   --:   [
33       -e|--eventthread  ]  [  -f|--fullscreen  ]  [  -h|--help ] [ -t|--theme
34       string ]
35
36       freeciv-sdl2  accepts  the  following  parameters   following   --:   [
37       -f|--fullscreen ] [ -h|--help ] [ -t|--theme string ]
38
39       freeciv-xaw  accepts  the standard X11 toolkit parameters following --;
40       see X(7) . It also accepts [ -h|--help ]
41
42

DESCRIPTION

44       Freeciv is a free turn-based multiplayer strategy game, in  which  each
45       player  becomes  the  leader  of a civilization, fighting to obtain the
46       ultimate goal: To become the greatest civilization.
47
48       Players of Civilization II® by Microprose® should feel at  home,  since
49       one aim of Freeciv is to have compatible rules.
50
51       Freeciv  is  maintained by an international team of coders and enthusi‐
52       asts, and is easily one of the most fun and addictive network games out
53       there!
54
55       This  is  the  client program used to connect to a Freeciv server - see
56       also freeciv-server(6) . freeciv-gtk2,  freeciv-gtk3,  freeciv-gtk3.22,
57       freeciv-qt,  freeciv-sdl,  and  freeciv-sdl2  can  also spawn their own
58       local server for single-player games.
59
60       This manual page only  lists  the  command  line  arguments.  For  more
61       details   about   using   freeciv-gtk2,   freeciv-gtk3,freeciv-gtk3.22,
62       freeciv-sdl, freeciv-sdl2, freeciv-qt, or freeciv-xaw, see  the  Client
63       Manual    which    can    be    found    at    the    Freeciv   website
64http://www.freeciv.org/⟩ as well as the documentation which is part of
65       the Freeciv distribution.
66

OPTIONS

68       The following options are accepted by all clients. They may not be com‐
69       bined; that is, "-np caesar 5557" will not work, instead you would need
70       to  enter  "-n  caesar  -p 5557". All options have a short form (single
71       hyphen and single letter) and a long form (double hyphen and a complete
72       word); their effects are identical.
73
74       -A protocol, --Announce protocol
75              Uses  protocol when searching for games on a LAN.  Possible val‐
76              ues for protocol are:
77
78              IPv4
79
80              IPv6
81
82              none
83
84       -a, --autoconnect
85              Skips the connect dialog, automatically  inserting  the  default
86              values.  This is quite convenient when all has been set up prop‐
87              erly.
88
89       -d level_number, --debug level_number
90              Sets the amount of debugging information to  be  logged  in  the
91              file   named  by  the  -l  option.  Acceptable  values  for  the
92              level_number are:
93
94              0    for fatal messages only.
95
96              1    for fatal and error messages.
97
98              2    for fatal, error and normal messages (default).
99
100              3    for fatal, error, normal, and verbose messages.
101
102
103       -F [ signal_number ], --Fatal [ signal_number ]
104              Raise a custom signal on failed assertion.  If signal_number  is
105              not specified, then the ABRT signal will be used.
106
107       -f filename, --file filename
108              Loads a saved game file (filename). This is for reloading previ‐
109              ously saved games, or for starting scenarios  from  the  command
110              line.
111
112       -h, --help
113              Prints a short summary of the standard command line options.
114
115       -l filename, --log filename
116              Defines  a log file, filename, to be produced during processing.
117              Use the -d option to set how much is logged.  By default, fatal,
118              error, and normal messages are printed to standard output.  With
119              a log file, such messages go to the log  instead.   If  filename
120              already exists, it is appended to.
121
122       -M URL, --Meta URL
123              Specifies  the URL of the metaserver to connect to. A metaserver
124              is a place where Freeciv servers  can  publish  their  presence.
125              Freeciv  clients  consult the metaserver to offer users a selec‐
126              tion of games to join. By default, the standard  metaserver  run
127              by the Freeciv maintainers will be used.
128
129       -n name, --name name
130              Specifies  the user name (name) to use to connect to the server.
131              This option is critical when reconnecting to a game. Please note
132              that you might need to quote your username.
133
134       -p port, --port port
135              Specifies  the  server  port  to  connect to. By default this is
136              5556, if in doubt ask the server administrator.
137
138       -P string, --Plugin string
139              Specifies the plugin to use for sound output.  Available options
140              for string are:
141
142              none
143
144              sdl
145
146
147       -r filename, --read filename
148              Specifies  a  file,  filename, of server commands which a server
149              spawned by the client will automatically read and process, as if
150              you had typed them in at the server's prompt.
151
152       -s address, --server address
153              Specifies  the  game  server  address to connect to. This server
154              might easily run on the same machine as the client.
155
156       -S name, --Sound name
157              Specifies the sound set to use. A file called name.soundspec  is
158              searched for in the usual places (see the FILES section).
159
160       -t name, --tiles name
161              Specifies the map graphics ("tiles") to be used within the game.
162              A file called name.tilespec is searched for in the usual  places
163              (see  the  FILES section). Currently the following tilespecs are
164              distributed with Freeciv:
165
166              · amplio2.tilespec
167
168              · cimpletoon.tilespec
169
170              · hex2t.tilespec
171
172              · isophex.tilespec
173
174              · isotrident.tilespec
175
176              · trident.tilespec
177
178       -v, --version
179              Prints the version number and exits.
180
181       --     All parameters following this -- will be considered  as  client-
182              specific parameters.
183
184       -- -e, -- --eventthread
185              Initializes the event subsystem in other thread.  Only available
186              for the freeciv-sdl client under Linux or BeOS.
187
188       -- -f, -- --fullscreen
189              Starts the client in full screen mode. Only implemented  in  the
190              freeciv-sdl and freeciv-sdl2 client.
191
192       -- -h, -- --help
193              Print the client-specific parameter help.
194
195       -- -r WIDTHxHEIGHT, -- --resolution WIDTHxHEIGHT
196              Behave  as  if  screen resolution were WIDTHxHEIGHT. Only imple‐
197              mented in the freeciv-gtk3 and freeciv-gtk3.22 clients.
198
199       -- -t theme, -- --theme theme
200              Use a particular GUI theme. Only implemented in the  freeciv-sdl
201              and freeciv-sdl2 clients.
202

EXAMPLES

204       freeciv-gtk3 --name "King Richard" --server io.daimi.aau.dk
205              Starts  the GTK3 client using the name King Richard and connect‐
206              ing to the server at io.daimi.aau.dk.
207
208       freeciv-sdl -a -t trident
209              Starts the SDL client with the trident tiles and autoconnects to
210              localhost.
211

FILES

213       ~/.freeciv/freeciv-client-rc-[version-number]
214              This is where your local settings will be stored.
215
216       tilespecs
217              These are searched for in the data path; see ENVIRONMENT.
218
219       soundspecs
220              These are searched for in the data path; see ENVIRONMENT.
221
222       The freeciv-modpack(6) utility can be used to locate and download addi‐
223       tional content such as tilesets and soundsets and  (for  client-spawned
224       servers only) scenarios and rulesets; it saves files under ~/.freeciv .
225

ENVIRONMENT

227       The Freeciv client accepts these environment variables:
228
229       FREECIV_CAPS
230              A  string  containing  a  list of "capabilities" provided by the
231              server. The compiled-in default should be correct for most  pur‐
232              poses,  but  if you are familiar with the capability facility in
233              the source you may use it to enforce  some  constraints  between
234              clients and server.
235
236       FREECIV_COMPRESSION_LEVEL
237              Sets the compression level for network traffic.
238
239       FREECIV_DATA_ENCODING
240              Sets  the character encoding used for data files, savegames, and
241              network strings). This should not normally be changed  from  the
242              default of UTF-8, since that is the format of the supplied rule‐
243              sets and the standard network protocol.
244
245       FREECIV_INTERNAL_ENCODING
246              Sets the character  encoding  used  internally  by  the  freeciv
247              client.   This  generally needs to match the GUI toolkit, so its
248              default depends on the specific client; most clients default  to
249              UTF-8.
250
251       FREECIV_LOCAL_ENCODING
252              Sets the local character encoding (used for the command line and
253              terminal output). The default is inferred from other aspects  of
254              the environment.
255
256       FREECIV_MULTICAST_GROUP
257              Sets the multicast group (for the LAN tab).
258
259       FREECIV_DATA_PATH
260              A  colon  separated  list of directories pointing to the freeciv
261              data directories. By default  Freeciv  looks  in  the  following
262              directories,  in  order,  for any data files: the current direc‐
263              tory; the "data" subdirectory of the current directory; the sub‐
264              directory  ".freeciv/2.6"  in the user's home directory; and the
265              directory where the files are placed by running "make  install".
266              If  not  set,  FREECIV_PATH is checked before these defaults are
267              used.
268
269       FREECIV_SAVE_PATH
270              A colon separated list of directories pointing  to  the  freeciv
271              save  directories.  By  default  Freeciv  looks in the following
272              directories, in order, for save files:  the  current  directory;
273              and  the subdirectory ".freeciv/saves" in the user's home direc‐
274              tory.  If not set, FREECIV_PATH is checked before these defaults
275              are  used;  in this case Freeciv also looks in "saves" potential
276              subdirectories.
277
278              (This does not affect where the server  spawned  by  the  client
279              creates   save   game   files;   these  are  always  created  in
280              ".freeciv/saves" in the user's home directory.)
281
282       FREECIV_SCENARIO_PATH
283              A colon separated list of directories pointing  to  the  freeciv
284              scenario  directories. By default Freeciv looks in the following
285              directories, in order, for scenario files:  the  current  direc‐
286              tory;  the  "data/scenarios"  subdirectory of the current direc‐
287              tory;  the  subdirectories  ".freeciv/2.6/scenarios"  and   then
288              ".freeciv/scenarios"  in  the  user's  home  directory;  and the
289              directory where the files are placed by running "make  install".
290              If  not  set,  FREECIV_PATH is checked before these defaults are
291              used; in this case Freeciv also looks in "scenario" and "scenar‐
292              ios" potential subdirectories.
293
294              (This  does  not  affect  where the server spawned by the client
295              creates  scenario   files;   these   are   always   created   in
296              ".freeciv/scenarios" in the user's home directory.)
297
298       FREECIV_PATH
299              A colon separated list of directories to look for various files.
300              This   variable   has   no    effect    if    FREECIV_DATA_PATH,
301              FREECIV_SAVE_PATH    and   FREECIV_SCENARIO_PATH   are   defined
302              together; those variables are the recommended  way  to  override
303              paths,  with FREECIV_PATH provided only for backward compatibil‐
304              ity with older versions of Freeciv; FREECIV_PATH will be removed
305              in a future release. The precise search path depends on the type
306              of file being searched for.
307
308       FREECIV_OPT
309              Specifies  a  file  to  contain  local  settings,   instead   of
310              ~/.freeciv/freeciv-client-rc-[version-number].
311
312       HOME   Specifies the user's home directory.
313
314       http_proxy
315              Set this variable accordingly when using a proxy.
316
317       LANG  or  LANGUAGE
318              Sets the language and locale on some platforms.
319
320       LC_ALL  or  LC_CTYPE
321              Similar to LANG (see documentation for your system).
322
323       USER   Specifies the username of the current user.
324

BUGS

326       Please     report     bugs     to     the     Freeciv    bug    tracker
327https://www.hostedredmine.com/projects/freeciv⟩ .
328
329

MORE INFO

331       See the Freeciv homepage ⟨http://www.freeciv.org/⟩ .
332
333       Updates and new info is first posted there.
334

AUTHORS

336       The Freeciv Team <freeciv-dev AT freelists.org>.
337
338       This manpage  was  originally  put  together  by  Florian  Ernst  <flo‐
339       rian_ernst  AT gmx.net> using the Client Manual and the comments in the
340       sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add
341       new  features, integrate information from the website's online documen‐
342       tation, and for slight formatting adjustments. Feel free to use  it  as
343       you wish.
344
345

SEE ALSO

347       freeciv-server(6)  freeciv-modpack(6)  and  the  Client  Manual  at the
348       Freeciv homepage.
349
350
351
352                               November 2nd 2016                    FREECIV(6)
Impressum