1FREECIV(6) Games Manual FREECIV(6)
2
6 freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22, freeciv-sdl, freeciv-sdl2,
7 freeciv-qt, freeciv-xaw - The clients for the Freeciv game
8
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 freeciv-gtk2 accepts the standard Gtk parameters following --; see the
19 Gtk documentation. It also accepts [ -h|--help ]
20 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 freeciv-gtk3.22 accepts the standard Gtk parameters following --; see
26 the Gtk documentation. It also accepts
27 freeciv-qt accepts the standard Qt parameters following --; see the Qt
29 documentation. It also accepts [ -h|--help ]
30 freeciv-sdl accepts the following parameters following --: [
32 -e|--eventthread ] [ -f|--fullscreen ] [ -h|--help ] [ -t|--theme
33 string ]
34 freeciv-sdl2 accepts the following parameters following --: [
36 -f|--fullscreen ] [ -h|--help ] [ -t|--theme string ]
37 freeciv-xaw accepts the standard X11 toolkit parameters following --;
39 see X(7) . It also accepts [ -h|--help ]
40
43 Freeciv is a free turn-based multiplayer strategy game, in which each
44 player becomes the leader of a civilization, fighting to obtain the
45 ultimate goal: To become the greatest civilization.
46 Players of Civilization II® by Microprose® should feel at home, since
48 one aim of Freeciv is to have compatible rules.
49 Freeciv is maintained by an international team of coders and enthusi‐
51 asts, and is easily one of the most fun and addictive network games out
52 there!
53 This is the client program used to connect to a Freeciv server - see
55 also freeciv-server(6) . freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22,
56 freeciv-qt, freeciv-sdl, and freeciv-sdl2 can also spawn their own
57 local server for single-player games.
58 This manual page only lists the command line arguments. For more
60 details about using freeciv-gtk2, freeciv-gtk3,freeciv-gtk3.22,
61 freeciv-sdl, freeciv-sdl2, freeciv-qt, or freeciv-xaw, see the Client
62 Manual which can be found at the Freeciv website
63 ⟨http://www.freeciv.org/⟩ as well as the documentation which is part of
64 the Freeciv distribution.
65
67 The following options are accepted by all clients. They may not be com‐
68 bined; that is, "-np caesar 5557" will not work, instead you would need
69 to enter "-n caesar -p 5557". All options have a short form (single
70 hyphen and single letter) and a long form (double hyphen and a complete
71 word); their effects are identical.
72 -A protocol, --Announce protocol
74 Uses protocol when searching for games on a LAN. Possible val‐
75 ues for protocol are:
76 IPv4
78 IPv6
80 none
82 -a, --autoconnect
84 Skips the connect dialog, automatically inserting the default
85 values. This is quite convenient when all has been set up prop‐
86 erly.
87 -d level_number, --debug level_number
89 Sets the amount of debugging information to be logged in the
90 file named by the -l option. Acceptable values for the
91 level_number are:
92 0 for fatal messages only.
94 1 for fatal and error messages.
96 2 for fatal, error and normal messages (default).
98 3 for fatal, error, normal, and verbose messages.
100 -F [ signal_number ], --Fatal [ signal_number ]
103 Raise a custom signal on failed assertion. If signal_number is
104 not specified, then the ABRT signal will be used.
105 -f filename, --file filename
107 Loads a saved game file (filename). This is for reloading previ‐
108 ously saved games, or for starting scenarios from the command
109 line.
110 -h, --help
112 Prints a short summary of the standard command line options.
113 -l filename, --log filename
115 Defines a log file, filename, to be produced during processing.
116 Use the -d option to set how much is logged. By default, fatal,
117 error, and normal messages are printed to standard output. With
118 a log file, such messages go to the log instead. If filename
119 already exists, it is appended to.
120 -M URL, --Meta URL
122 Specifies the URL of the metaserver to connect to. A metaserver
123 is a place where Freeciv servers can publish their presence.
124 Freeciv clients consult the metaserver to offer users a selec‐
125 tion of games to join. By default, the standard metaserver run
126 by the Freeciv maintainers will be used.
127 -n name, --name name
129 Specifies the user name (name) to use to connect to the server.
130 This option is critical when reconnecting to a game. Please note
131 that you might need to quote your username.
132 -p port, --port port
134 Specifies the server port to connect to. By default this is
135 5556, if in doubt ask the server administrator.
136 -P string, --Plugin string
138 Specifies the plugin to use for sound output. Available options
139 for string are:
140 none
142 sdl
144 -r filename, --read filename
147 Specifies a file, filename, of server commands which a server
148 spawned by the client will automatically read and process, as if
149 you had typed them in at the server's prompt.
150 -s address, --server address
152 Specifies the game server address to connect to. This server
153 might easily run on the same machine as the client.
154 -S name, --Sound name
156 Specifies the sound set to use. A file called name.soundspec is
157 searched for in the usual places (see the FILES section).
158 -t name, --tiles name
160 Specifies the map graphics ("tiles") to be used within the game.
161 A file called name.tilespec is searched for in the usual places
162 (see the FILES section). Currently the following tilespecs are
163 distributed with Freeciv:
164 · amplio2.tilespec
166 · cimpletoon.tilespec
168 · hex2t.tilespec
170 · isophex.tilespec
172 · isotrident.tilespec
174 · trident.tilespec
176 -v, --version
178 Prints the version number and exits.
179 -- All parameters following this -- will be considered as client-
181 specific parameters.
182 -- -e, -- --eventthread
184 Initializes the event subsystem in other thread. Only available
185 for the freeciv-sdl client under Linux or BeOS.
186 -- -f, -- --fullscreen
188 Starts the client in full screen mode. Only implemented in the
189 freeciv-sdl and freeciv-sdl2 client.
190 -- -h, -- --help
192 Print the client-specific parameter help.
193 -- -r WIDTHxHEIGHT, -- --resolution WIDTHxHEIGHT
195 Behave as if screen resolution were WIDTHxHEIGHT. Only imple‐
196 mented in the freeciv-gtk3 and freeciv-gtk3.22 clients.
197 -- -t theme, -- --theme theme
199 Use a particular GUI theme. Only implemented in the freeciv-sdl
200 and freeciv-sdl2 clients.
201
203 freeciv-gtk3 --name "King Richard" --server io.daimi.aau.dk
204 Starts the GTK3 client using the name King Richard and connect‐
205 ing to the server at io.daimi.aau.dk.
206 freeciv-sdl -a -t trident
208 Starts the SDL client with the trident tiles and autoconnects to
209 localhost.
210
212 ~/.freeciv/freeciv-client-rc-[version-number]
213 This is where your local settings will be stored.
214 tilespecs
216 These are searched for in the data path; see ENVIRONMENT.
217 soundspecs
219 These are searched for in the data path; see ENVIRONMENT.
220 The freeciv-modpack(6) utility can be used to locate and download addi‐
222 tional content such as tilesets and soundsets and (for client-spawned
223 servers only) scenarios and rulesets; it saves files under ~/.freeciv .
224
226 The Freeciv client accepts these environment variables:
227 FREECIV_CAPS
229 A string containing a list of "capabilities" provided by the
230 server. The compiled-in default should be correct for most pur‐
231 poses, but if you are familiar with the capability facility in
232 the source you may use it to enforce some constraints between
233 clients and server.
234 FREECIV_COMPRESSION_LEVEL
236 Sets the compression level for network traffic.
237 FREECIV_DATA_ENCODING
239 Sets the character encoding used for data files, savegames, and
240 network strings). This should not normally be changed from the
241 default of UTF-8, since that is the format of the supplied rule‐
242 sets and the standard network protocol.
243 FREECIV_INTERNAL_ENCODING
245 Sets the character encoding used internally by the freeciv
246 client. This generally needs to match the GUI toolkit, so its
247 default depends on the specific client; most clients default to
248 UTF-8.
249 FREECIV_LOCAL_ENCODING
251 Sets the local character encoding (used for the command line and
252 terminal output). The default is inferred from other aspects of
253 the environment.
254 FREECIV_MULTICAST_GROUP
256 Sets the multicast group (for the LAN tab).
257 FREECIV_DATA_PATH
259 A colon separated list of directories pointing to the freeciv
260 data directories. By default Freeciv looks in the following
261 directories, in order, for any data files: the current direc‐
262 tory; the "data" subdirectory of the current directory; the sub‐
263 directory ".freeciv/2.6" in the user's home directory; and the
264 directory where the files are placed by running "make install".
265 If not set, FREECIV_PATH is checked before these defaults are
266 used.
267 FREECIV_SAVE_PATH
269 A colon separated list of directories pointing to the freeciv
270 save directories. By default Freeciv looks in the following
271 directories, in order, for save files: the current directory;
272 and the subdirectory ".freeciv/saves" in the user's home direc‐
273 tory. If not set, FREECIV_PATH is checked before these defaults
274 are used; in this case Freeciv also looks in "saves" potential
275 subdirectories.
276 (This does not affect where the server spawned by the client
278 creates save game files; these are always created in
279 ".freeciv/saves" in the user's home directory.)
280 FREECIV_SCENARIO_PATH
282 A colon separated list of directories pointing to the freeciv
283 scenario directories. By default Freeciv looks in the following
284 directories, in order, for scenario files: the current direc‐
285 tory; the "data/scenarios" subdirectory of the current direc‐
286 tory; the subdirectories ".freeciv/2.6/scenarios" and then
287 ".freeciv/scenarios" in the user's home directory; and the
288 directory where the files are placed by running "make install".
289 If not set, FREECIV_PATH is checked before these defaults are
290 used; in this case Freeciv also looks in "scenario" and "scenar‐
291 ios" potential subdirectories.
292 (This does not affect where the server spawned by the client
294 creates scenario files; these are always created in
295 ".freeciv/scenarios" in the user's home directory.)
296 FREECIV_PATH
298 A colon separated list of directories to look for various files.
299 This variable has no effect if FREECIV_DATA_PATH,
300 FREECIV_SAVE_PATH and FREECIV_SCENARIO_PATH are defined
301 together; those variables are the recommended way to override
302 paths, with FREECIV_PATH provided only for backward compatibil‐
303 ity with older versions of Freeciv; FREECIV_PATH will be removed
304 in a future release. The precise search path depends on the type
305 of file being searched for.
306 FREECIV_OPT
308 Specifies a file to contain local settings, instead of
309 ~/.freeciv/freeciv-client-rc-[version-number].
310 HOME Specifies the user's home directory.
312 http_proxy
314 Set this variable accordingly when using a proxy.
315 LANG or LANGUAGE
317 Sets the language and locale on some platforms.
318 LC_ALL or LC_CTYPE
320 Similar to LANG (see documentation for your system).
321 USER Specifies the username of the current user.
323
325 Please report bugs to the Freeciv bug tracker
326 ⟨https://www.hostedredmine.com/projects/freeciv⟩ .
327
330 See the Freeciv homepage ⟨http://www.freeciv.org/⟩ .
331 Updates and new info is first posted there.
333
335 The Freeciv Team <freeciv-dev AT freelists.org>.
336 This manpage was originally put together by Florian Ernst <flo‐
338 rian_ernst AT gmx.net> using the Client Manual and the comments in the
339 sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add
340 new features, integrate information from the website's online documen‐
341 tation, and for slight formatting adjustments. Feel free to use it as
342 you wish.
343
346 freeciv-server(6) freeciv-modpack(6) and the Client Manual at the
347 Freeciv homepage.
348 November 2nd 2016 FREECIV(6)