~ubuntu-branches/debian/squeeze/freeciv/squeeze

« back to all changes in this revision

Viewing changes to debian/civserver.6

  • Committer: Bazaar Package Importer
  • Author(s): Jordi Mallach
  • Date: 2008-07-08 18:34:23 UTC
  • mfrom: (5.1.9 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080708183423-c80u1h25xmj6h9s0
Tags: 2.1.5-2
Export datarootdir=/usr/share in debian/rules, so make calls can
have a correct value for LOCALEDIR (closes: #489455). Thanks Loïc Minier
for the help to solve this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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)
5
 
.\"   any later version.
6
 
.\"
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.
11
 
.\"
12
 
.TH FREECIV 6 "July 1st 2004"
13
 
.SH NAME
14
 
civserver \- The server for the Freeciv game
15
 
.SH SYNOPSIS
16
 
.B civserver \
17
 
[ -d|--debug \fIlevel\fP ] \
18
 
[ -f|--file \fIsavegame\fP ] [ -g|--gamelog \fIgamelog\fP ] [ -h|--help ] \
19
 
[ -i|--info \fIinfo\fP ] [ -l|--log \fIlogfile\fP ] [ -m|--meta ] \
20
 
[ -M|--Metaserver \fIserver\fP ] [ -p|--port \fIport\fP ] \
21
 
[ -q|--quitidle \fIseconds\fP ] \
22
 
[ -r|--read \fIfile\fP ] [ -v|--version ]
23
 
.SH DESCRIPTION
24
 
Freeciv is a free turn-based multiplayer strategy game, in which each player
25
 
becomes the leader of a civilization, fighting to obtain the ultimate goal:
26
 
To become the greatest civilization.
27
 
 
28
 
Players of Civilization II\*R by Microprose\*R should feel at home, since one
29
 
aim of Freeciv is to have compatible rules. 
30
 
 
31
 
Freeciv is maintained by an international team of coders and enthusiasts, and is
32
 
easily one of the most fun and addictive network games out there!
33
 
 
34
 
This is the server program used to establish a Freeciv server - See also
35
 
.IR civclient (6)
36
 
 
37
 
This manual page only lists the command line arguments. For details
38
 
of the directives necessary to configure
39
 
.B civserver
40
 
see the Server Manual which can be found at
41
 
.UR
42
 
http://www.freeciv.org/
43
 
.UE
44
 
as well as the documentation which is part of the Freeciv distribution.
45
 
.SH OPTIONS
46
 
The following options are accepted on the command line of the server. They may
47
 
not be combined; that is, "civserver -fp savegame.sav 555" will not work,
48
 
instead you would need to enter "civserver -f savegame.sav -p 555". All options
49
 
have a short form (single hyphen and single letter) and a long form (double
50
 
hyphen and a complete word); their effects are identical.
51
 
.TP
52
 
.BI "-d, --debug"
53
 
Sets the amount of debugging information to be logged in the file named by the
54
 
.I -l
55
 
option. The number should be 0 for fatal errors only, 1 for fatal and normal
56
 
messages, 2 for fatal, normal, and debugging messages, or 3 for very verbose
57
 
output.
58
 
.TP
59
 
.BI "-f, --file"
60
 
Loads a saved game into the server before initialization, instead of starting a
61
 
new game. This is for reloading saved games, or for loading scenarios.
62
 
.TP
63
 
.BI "-g, --gamelog"
64
 
Defines a log file to be produced during processing. This is a game progress
65
 
log of game-related events recording the activities of the players.
66
 
.TP
67
 
.BI "-h, --help"
68
 
Prints out a description of the command line options and exits.
69
 
.TP
70
 
.BI "-i, --info"
71
 
Extra info to be sent to the metaserver.
72
 
.TP
73
 
.BI "-l, --log"
74
 
Defines a log file to be produced during processing. Use the
75
 
.I -d
76
 
option to set how much is logged.
77
 
.TP
78
 
.BI "-m, --meta"
79
 
Directs the server to communicate with a metaserver, a place where Freeciv
80
 
servers can publish their presence. Freeciv clients consult the metaserver to
81
 
offer users a selection of games to join.
82
 
.TP
83
 
.BI "-M, --Metaserver"
84
 
Sets the metaserver address.
85
 
.TP
86
 
.BI "-p, --port"
87
 
Specifies the TCP port number to which clients will connect; players must know
88
 
this number to be able to connect if they are not to use the default of 5555
89
 
decimal. You may need to use this if 5555 is not available for your use on your
90
 
system.
91
 
.TP
92
 
.BI "-q, --quitidle"
93
 
Quit if no players present for the given number of seconds.
94
 
.TP
95
 
.BI "-r, --read"
96
 
Specifies a file of server commands which the server will automatically read and
97
 
process, as if you had typed them in at the server's prompt.
98
 
.TP
99
 
.BI "-v, --version"
100
 
Causes the server to display its version number and exit.
101
 
.SH EXAMPLES
102
 
civserver --file oldgame.sav --port 2244
103
 
 
104
 
civserver -g gamelog -l logfile -r script -f oldgame.sav.gz
105
 
.SH COMMANDS
106
 
You may enter commands into the server at any time, either before or during the
107
 
running of a game. 
108
 
 
109
 
Type "help" or "help help" for starters.
110
 
.SH FILES
111
 
The Freeciv server requires the following files in the Freeciv data directory,
112
 
which on Debian systems is
113
 
.I /usr/share/games/freeciv/
114
 
by default:
115
 
 
116
 
\(bu
117
 
.I default/buildings.ruleset
118
 
 
119
 
\(bu
120
 
.I default/techs.ruleset
121
 
 
122
 
\(bu
123
 
.I default/units.ruleset
124
 
 
125
 
These are the default rule sets used for the game. Alternate sets of rules can
126
 
be installed with the option settings "techs", "units", and "buildings", each of
127
 
which provides a name to replace the directory name "default".
128
 
.SH ENVIRONMENT
129
 
The Freeciv server accepts these environment variables:
130
 
.TP
131
 
.BI FREECIV_CAPS
132
 
A string containing a list of "capabilities" provided by the server. The
133
 
compiled-in default should be correct for most purposes, but if you are familiar
134
 
with the capability facility in the source you may use it to enforce some
135
 
constraints between clients and server.
136
 
.TP
137
 
.BI FREECIV_PATH
138
 
A colon separated list of directories pointing to the
139
 
.B freeciv
140
 
data directory. By default freeciv looks in the following directories, in order,
141
 
for any data files: the current directory; the "data" subdirectory of the
142
 
current directory; the subdirectory ".freeciv" in the user's home directory; and
143
 
the directory where the files are placed by running "make install".
144
 
.TP
145
 
.BI FREECIV_LOCAL_ENCODING
146
 
The local encoding to be used.
147
 
.TP
148
 
.BI http_proxy
149
 
Set this variable accordingly when using a proxy.
150
 
.SH BUGS
151
 
Please report bugs to
152
 
.UR
153
 
http://rt.freeciv.org/
154
 
.UE
155
 
\.
156
 
.SH "MORE INFO"
157
 
The Freeciv homepage is located at
158
 
.UR
159
 
http://www.freeciv.org/
160
 
.UE
161
 
\.
162
 
 
163
 
Updates and new info is first posted there.
164
 
.SH AUTHORS
165
 
The Freeciv Team <freeciv-dev AT freeciv.org>.
166
 
 
167
 
This manpage was put together by Florian Ernst <florian_ernst AT gmx.net> using
168
 
the Server Manual and the comments in the sourcecode. Feel free to use it as
169
 
you wish.
170
 
.SH "SEE ALSO"
171
 
.IR civclient (6)
172
 
and the Server Manual on the Freeciv homepage.