1
.\" Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold
2
.\" This program is free software; you can redistribute it and/or modify
3
.\" it under the terms of the GNU General Public License as published by
4
.\" the Free Software Foundation; either version 2, or (at your option)
7
.\" This program is distributed in the hope that it will be useful,
8
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
9
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
.\" GNU General Public License for more details.
12
.TH FREECIV 6 "April 16th 2008"
14
civclient \- The client for the Freeciv game
17
[ \-a|\-\-autoconnect ] \
18
[ \-d|\-\-debug \fIlevel_number\fP ] \
20
[ \-l|\-\-log \fIfilename\fP ] \
21
[ \-m|\-\-meta \fIURL\fP ] \
22
[ \-n|\-\-name \fIstring\fP ] \
23
[ \-p|\-\-port \fIport\fP ] \
24
[ \-P|\-\-Plugin \fIstring\fP ] \
25
[ \-r|\-\-read \fIfilename\fP ] \
26
[ \-s|\-\-server \fIaddress\fP ] \
27
[ \-S|\-\-Sound \fIfilename\fP ] \
28
[ \-t|\-\-tiles \fIstring\fP ] \
31
Freeciv is a free turn-based multiplayer strategy game, in which each player
32
becomes the leader of a civilization, fighting to obtain the ultimate goal:
33
To become the greatest civilization.
35
Players of Civilization II\*R by Microprose\*R should feel at home, since one
36
aim of Freeciv is to have compatible rules.
38
Freeciv is maintained by an international team of coders and enthusiasts, and is
39
easily one of the most fun and addictive network games out there!
41
This is the client program used to connect to a Freeciv server - See also
44
This manual page only lists the command line arguments. For details
45
regarding the options when using
47
see the Client Manual which can be found at
49
http://www.freeciv.org/
51
as well as the documentation which is part of the Freeciv distribution.
54
accepts all of the standard X Toolkit command line options along with the
55
additional options listed below. Those may not be combined; that is,
56
"civclient \-np caesar 5557" will not work, instead you would need to enter
57
"civclient \-n caesar \-p 5557". All options have a short form (single
58
hyphen and single letter) and a long form (double hyphen and a complete word);
59
their effects are identical.
61
.BI "\-a, \-\-autoconnect"
62
Skips the connect dialog, automatically inserting the default values. This is
63
quite convenient when all has been set up properly.
65
.BI "\-d \fIlevel_number\fP, \-\-debug \fIlevel_number\fP"
66
Sets the amount of debugging information to be logged in the file named by the
68
option. Acceptable values for the \fIlevel_number\fP are:
70
\fB0\fP for fatal messages only.
72
\fB1\fP for fatal and error messages.
74
\fB2\fP for fatal, error and normal messages.
76
\fB3\fP for fatal, error, normal, and verbose messages.
80
Prints a short summary of the command line options.
82
.BI "\-l \fIfilename\fP, \-\-log \fIfilename\fP"
83
Defines a log file, \fIfilename\fP, to be produced during processing. Use the
85
option to set how much is logged. By default, fatal and normal messages are
86
printed to standard output. With a log file, such messages go to the log
89
.BI "\-m \fIURL\fP, \-\-meta \fIURL\fP"
90
Specifies the \fIURL\fP of the metaserver to connect to. A metaserver is a
91
place where Freeciv servers can publish their presence. Freeciv clients consult
92
the metaserver to offer users a selection of games to join. By default the
93
standard Freeciv metaserver is used.
95
.BI "\-n \fIstring\fP, \-\-name \fIstring\fP"
96
Specifies the name (\fIstring\fP) to play under. This option is critical when
97
reconnecting to a game. Please note that you might need to quote your playername.
99
.BI "\-p \fIport\fP, \-\-port \fIport\fP"
100
Specifies the server \fIport\fP to connect to. By default this is 5556, if in
101
doubt ask the server administrator.
103
.BI "\-P \fIstring\fP, \-\-Plugin \fIstring\fP"
104
Specifies the plugin to use for sound output. Available options for
112
.BI "\-r \fIfilename\fP, \-\-read \fIfilename\fP"
113
Specifies a file, \fIfilename\fP, of server commands which the server will
114
automatically read and process, as if you had typed them in at the server's
115
prompt. (for spawned server only)
117
.BI "\-s \fIaddress\fP, \-\-server \fIaddress\fP"
118
Specifies the game server \fIaddress\fP to connect to. This server might easily
119
run on the same machine as the client.
121
.BI "\-S \fIfilename\fP, \-\-Sound \fIfilename\fP"
122
Specifies the \fIfilename\fP to read the sound tags from.
124
.BI "\-t \fIstring\fP, \-\-tiles \fIstring\fP"
125
Specifies the tiles to be used within the game by supplying the name
126
(\fIstring\fP) of the tilespec. See the \fIFILES\fP section below for tilespecs
127
included with this distribution.
129
.BI "\-v, \-\-version"
130
Prints the version number and exits.
133
.B civclient \-\-name "King Richard" \-\-server io.daimi.aau.dk
134
Starts the client using the name \fIKing Richard\fP and connecting to the
135
server at \fIio.daimi.aau.dk\fP.
137
.B civclient \-a \-t trident
138
Starts the client with the \fItrident\fP tiles and autoconnects to the
143
This is where your local settings will be stored.
146
The Freeciv client requires several files in the Freeciv data directory,
148
.I /usr/local/share/freeciv
149
by default. Currently the following tilespecs can be used:
161
.I isotrident.tilespec
166
The Freeciv client accepts these environment variables:
169
A string containing a list of "capabilities" provided by the server. The
170
compiled-in default should be correct for most purposes, but if you are familiar
171
with the capability facility in the source you may use it to enforce some
172
constraints between clients and server.
174
.BI FREECIV_COMPRESSION_LEVEL
175
Sets the compression level for network traffic.
177
.BI FREECIV_DATA_ENCODING
178
Sets the data encoding (used for data files, savegames, and network strings).
180
.BI FREECIV_INTERNAL_ENCODING
181
Sets the internal encoding (used for GUI strings).
183
.BI FREECIV_LOCAL_ENCODING
184
Sets the local encoding (used for terminal output).
186
.BI FREECIV_MULTICAST_GROUP
187
Sets the multicast group (for the LAN tab).
190
A colon separated list of directories pointing to the
192
data directory. By default freeciv looks in the following directories, in order,
193
for any data files: the current directory; the "data" subdirectory of the
194
current directory; the subdirectory ".freeciv" in the user's home directory; and
195
the directory where the files are placed by running "make install".
198
Specifies the user's home directory.
201
Set this variable accordingly when using a proxy.
203
\fBLANG\fP or \fBLANGUAGE\fP
204
Sets the language and locale on some platforms.
206
\fBLC_ALL\fP or \fBLC_CTYPE\fP
207
Similar to LANG (see documentation for your system).
210
Specifies the username of the current user.
212
Please report bugs to
214
http://bugs.freeciv.org/
219
The Freeciv homepage is located at
221
http://www.freeciv.org/
225
Updates and new info is first posted there.
227
The Freeciv Team <freeciv-dev AT freeciv.org>.
229
This manpage was originally put together by Florian Ernst
230
<florian_ernst AT gmx.net> using the Client Manual and the comments in the
231
sourcecode. It was updated by Ben Bettin <bwbettin AT gmail.com> to add new
232
features, integrate information from the website's online documentation, and
233
for slight formatting adjustments. Feel free to use it as you wish.
237
and the Client Manual at the Freeciv homepage.
added
removed
doc/man/civclient.6
