1FREECIV(6) Games Manual FREECIV(6)
2
6 freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22, freeciv-sdl2, freeciv-qt -
7 The clients for the Freeciv game
8
10 freeciv-gtk2|freeciv-gtk3|freeciv-gtk3.22|freeciv-sdl2|freeciv-qt [
11 -A|--Announce protocol ] [ -a|--autoconnect ] [ -d|--debug level_number
12 ] [ -F|--Fatal [ signal_number ] ] [ -f|--file filename ] [ -h|--help ]
13 [ -l|--log filename ] [ -M|--Meta URL ] [ -n|--name name ] [ -p|--port
14 port ] [ -P|--Plugin string ] [ -r|--read filename ] [ -s|--server ad‐
15 dress ] [ -S|--Sound name ] [ -t|--tiles name ] [ -v|--version ] [ --
16 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 [ -h|--help ] [ -r|--resolution
27 WIDTHxHEIGHT ]
28 freeciv-qt accepts the standard Qt parameters following --; see the Qt
30 documentation. It also accepts [ -h|--help ]
31 freeciv-sdl2 accepts the following parameters following --: [
33 -f|--fullscreen ] [ -h|--help ] [ -t|--theme string ]
34
37 Freeciv is a free turn-based multiplayer strategy game, in which each
38 player becomes the leader of a civilization, fighting to obtain the ul‐
39 timate goal: To become the greatest civilization.
40 Players of Civilization II® by Microprose® should feel at home, since
42 one aim of Freeciv is to have compatible rules.
43 Freeciv is maintained by an international team of coders and enthusi‐
45 asts, and is easily one of the most fun and addictive network games out
46 there!
47 This is the client program used to connect to a Freeciv server - see
49 also freeciv-server(6) . freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22,
50 freeciv-qt, and freeciv-sdl2 can also spawn their own local server for
51 single-player games.
52 This manual page only lists the command line arguments. For more de‐
54 tails about using freeciv-gtk2, freeciv-gtk3, freeciv-gtk3.22, freeciv-
55 sdl2, or freeciv-qt, see the Client Manual which can be found at the
56 Freeciv website ⟨https://www.freeciv.org/⟩ as well as the documentation
57 which is part of the Freeciv distribution.
58
60 The following options are accepted by all clients. They may not be com‐
61 bined; that is, "-np caesar 5557" will not work, instead you would need
62 to enter "-n caesar -p 5557". All options have a short form (single hy‐
63 phen and single letter) and a long form (double hyphen and a complete
64 word); their effects are identical.
65 -A protocol, --Announce protocol
67 Uses protocol when searching for games on a LAN. Possible val‐
68 ues for protocol are:
69 IPv4
71 IPv6
73 none
75 -a, --autoconnect
77 Skips the connect dialog, automatically inserting the default
78 values. This is quite convenient when all has been set up prop‐
79 erly.
80 -d level_number, --debug level_number
82 Sets the amount of debugging information to be logged in the
83 file named by the -l option. Acceptable values for the
84 level_number are:
85 0 for fatal messages only.
87 1 for fatal and error messages.
89 2 for fatal, error and normal messages (default).
91 3 for fatal, error, normal, and verbose messages.
93 -F [ signal_number ], --Fatal [ signal_number ]
96 Raise a custom signal on failed assertion. If signal_number is
97 not specified, then the ABRT signal will be used.
98 -f filename, --file filename
100 Loads a saved game file (filename). This is for reloading previ‐
101 ously saved games, or for starting scenarios from the command
102 line.
103 -h, --help
105 Prints a short summary of the standard command line options.
106 -l filename, --log filename
108 Defines a log file, filename, to be produced during processing.
109 Use the -d option to set how much is logged. By default, fatal,
110 error, and normal messages are printed to standard output. With
111 a log file, such messages go to the log instead. If filename
112 already exists, it is appended to.
113 -M URL, --Meta URL
115 Specifies the URL of the metaserver to connect to. A metaserver
116 is a place where Freeciv servers can publish their presence.
117 Freeciv clients consult the metaserver to offer users a selec‐
118 tion of games to join. By default, the standard metaserver run
119 by the Freeciv maintainers will be used.
120 -n name, --name name
122 Specifies the user name (name) to use to connect to the server.
123 This option is critical when reconnecting to a game. Please note
124 that you might need to quote your username.
125 -p port, --port port
127 Specifies the server port to connect to. By default this is
128 5556, if in doubt ask the server administrator.
129 -P string, --Plugin string
131 Specifies the plugin to use for sound output. Available options
132 for string are:
133 none
135 sdl
137 -r filename, --read filename
140 Specifies a file, filename, of server commands which a server
141 spawned by the client will automatically read and process, as if
142 you had typed them in at the server's prompt.
143 -s address, --server address
145 Specifies the game server address to connect to. This server
146 might easily run on the same machine as the client.
147 -S name, --Sound name
149 Specifies the sound set to use. A file called name.soundspec is
150 searched for in the usual places (see the FILES section).
151 -t name, --tiles name
153 Specifies the map graphics ("tiles") to be used within the game.
154 A file called name.tilespec is searched for in the usual places
155 (see the FILES section). Currently the following tilespecs are
156 distributed with Freeciv:
157 • amplio2.tilespec
159 • cimpletoon.tilespec
161 • hex2t.tilespec
163 • isophex.tilespec
165 • isotrident.tilespec
167 • trident.tilespec
169 -v, --version
171 Prints the version number and exits.
172 -- All parameters following this -- will be considered as client-
174 specific parameters.
175 -- -f, -- --fullscreen
177 Starts the client in full screen mode. Only implemented in the
178 freeciv-sdl2 client.
179 -- -h, -- --help
181 Print the client-specific parameter help.
182 -- -r WIDTHxHEIGHT, -- --resolution WIDTHxHEIGHT
184 Behave as if screen resolution were WIDTHxHEIGHT. Only imple‐
185 mented in the freeciv-gtk3 and freeciv-gtk3.22 clients.
186 -- -t theme, -- --theme theme
188 Use a particular GUI theme. Only implemented in the freeciv-sdl2
189 client.
190
192 freeciv-gtk3 --name "King Richard" --server io.daimi.aau.dk
193 Starts the GTK3 client using the name King Richard and connect‐
194 ing to the server at io.daimi.aau.dk.
195 freeciv-sdl2 -a -t trident
197 Starts the SDL2-client with the trident tiles and autoconnects
198 to localhost.
199
201 ~/.freeciv/freeciv-client-rc-[version-number]
202 This is where your local settings will be stored.
203 tilespecs
205 These are searched for in the data path; see ENVIRONMENT.
206 soundspecs
208 These are searched for in the data path; see ENVIRONMENT.
209 The freeciv-modpack(6) utility can be used to locate and download addi‐
211 tional content such as tilesets and soundsets and (for client-spawned
212 servers only) scenarios and rulesets; it saves files under ~/.freeciv .
213
215 The Freeciv client accepts these environment variables:
216 FREECIV_CAPS
218 A string containing a list of "capabilities" provided by the
219 server. The compiled-in default should be correct for most pur‐
220 poses, but if you are familiar with the capability facility in
221 the source you may use it to enforce some constraints between
222 clients and server.
223 FREECIV_COMPRESSION_LEVEL
225 Sets the compression level for network traffic.
226 FREECIV_DATA_ENCODING
228 Sets the character encoding used for data files, savegames, and
229 network strings). This should not normally be changed from the
230 default of UTF-8, since that is the format of the supplied rule‐
231 sets and the standard network protocol.
232 FREECIV_INTERNAL_ENCODING
234 Sets the character encoding used internally by the freeciv
235 client. This generally needs to match the GUI toolkit, so its
236 default depends on the specific client; most clients default to
237 UTF-8.
238 FREECIV_LOCAL_ENCODING
240 Sets the local character encoding (used for the command line and
241 terminal output). The default is inferred from other aspects of
242 the environment.
243 FREECIV_MULTICAST_GROUP
245 Sets the multicast group (for the LAN tab).
246 FREECIV_DATA_PATH
248 A colon separated list of directories pointing to the freeciv
249 data directories. By default Freeciv looks in the following di‐
250 rectories, in order, for any data files: the current directory;
251 the "data" subdirectory of the current directory; the subdirec‐
252 tory ".freeciv/3.0" in the user's home directory; and the direc‐
253 tory where the files are placed by running "make install". If
254 not set, FREECIV_SAVE_PATH A colon separated list of directories
255 pointing to the freeciv save directories. By default Freeciv
256 looks in the following directories, in order, for save files:
257 the current directory; and the subdirectory ".freeciv/saves" in
258 the user's home directory.
259 (This does not affect where the server spawned by the client
261 creates save game files; these are always created in
262 ".freeciv/saves" in the user's home directory.)
263 FREECIV_SCENARIO_PATH
265 A colon separated list of directories pointing to the freeciv
266 scenario directories. By default Freeciv looks in the following
267 directories, in order, for scenario files: the current direc‐
268 tory; the "data/scenarios" subdirectory of the current direc‐
269 tory; the subdirectories ".freeciv/3.0/scenarios" and then
270 ".freeciv/scenarios" in the user's home directory; and the di‐
271 rectory where the files are placed by running "make install".
272 (This does not affect where the server spawned by the client
274 creates scenario files; these are always created in
275 ".freeciv/scenarios" in the user's home directory.)
276 FREECIV_OPT
278 Specifies a file to contain local settings, instead of
279 ~/.freeciv/freeciv-client-rc-[version-number].
280 HOME Specifies the user's home directory.
282 http_proxy
284 Set this variable accordingly when using a proxy.
285 LANG or LANGUAGE
287 Sets the language and locale on some platforms.
288 LC_ALL or LC_CTYPE
290 Similar to LANG (see documentation for your system).
291 USER Specifies the username of the current user.
293
295 Please report bugs to the Freeciv bug tracker
296 ⟨https://osdn.net/projects/freeciv/ticket/⟩ .
297
300 See the Freeciv homepage ⟨https://www.freeciv.org/⟩ .
301 Updates and new info is first posted there.
303
305 The Freeciv Team <freeciv-dev AT freelists.org>.
306 This manpage was originally put together by Florian Ernst <flo‐
308 rian_ernst AT gmx.net> using the Client Manual and the comments in the
309 sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add
310 new features, integrate information from the website's online documen‐
311 tation, and for slight formatting adjustments. Feel free to use it as
312 you wish.
313
316 freeciv-server(6) freeciv-modpack(6) and the Client Manual at the
317 Freeciv homepage.
318 November 2nd 2016 FREECIV(6)