tINSTALL - vaccinewars - be a doctor and try to vaccinate the world
HTML git clone git://src.adamsgaard.dk/vaccinewars
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
tINSTALL (11580B)
---
1 PREREQUISITES
2 =============
3
4 dopewars _requires_ the GLib library for compilation, even when not using
5 the GTK+ client. Other libraries may be required for additional features:-
6
7 Unix/Linux:
8 - Get GLib from http://www.gtk.org/
9 - For the GTK+ client, GTK+ libraries are needed, also from
10 http://www.gtk.org/ (GTK+2 and GTK+3 are supported). To actually
11 compile dopewars, you'll probably need your distribution's
12 "gtk-devel" package.
13 - For the curses client, curses, ncurses or libcurses_color libraries
14 and headers are required.
15
16 Windows:
17 - dopewars can be built via cross-compilation using MinGW. See
18 the win32 directory for more information.
19
20
21 INSTALLATION
22 ============
23
24 dopewars installation should require no more than the following:-
25
26 ./configure
27 make
28 make install
29
30 (To build a version from git, you must have the automake and autoconf packages
31 installed. Run ./autogen.sh instead of ./configure - this generates the
32 Makefiles and configure script. You will also need the gettext package if
33 you want to enable NLS support, in order to generate the necessary .po files.)
34
35 The configure script checks to see if your system is a "normal" Unix or the
36 cross-compile for Windows (MinGW) environment.
37
38 For a smaller binary, you may wish to build a "stripped" binary by specifying
39 the -s option in LDFLAGS. In a Bourne-compatible shell, this can be achieved
40 with a command similar to the following:-
41 LDFLAGS="-s" ./configure
42
43 The dopewars high score file is written as /usr/local/var/dopewars.sco on
44 Unix systems or ./dopewars.sco on Win32 systems by default. On Unix systems,
45 translations, documentation, sounds and graphics are installed in the
46 locale, doc, dopewars and pixmaps directories respectively under
47 /usr/local/share. (On Windows systems, these directories are under the
48 current directory.) On Unix systems, you can move the score file with the
49 --localstatedir flag to configure, the sounds with the --datadir flag, and
50 the documentation with the --docdir flag. (On Win32 systems, these flags are
51 ignored.) The dopewars binary can also be moved from /usr/local/bin/dopewars
52 with the --bindir flag. For example:-
53
54 ./configure --bindir=/usr/bin --localstatedir=/var/lib/games
55 will configure the system to write the dopewars binary as /usr/bin/dopewars
56 and the high score as /var/lib/games/dopewars.sco
57
58 Other options to ./configure include:-
59
60 --enable-networking:
61 Compile dopewars with support for running as a server, and/or to
62 connect to existing servers over a TCP/IP network. (Without networking,
63 dopewars will only be useable in single-player mode.) If this option is not
64 specified, the configure script will enable networking only if it believes
65 your system has the necessary support functions (select and socket). You can
66 also explicitly disable networking with --enable-networking=no or
67 --disable-networking
68
69 --enable-gui-client:
70 Compile a graphical dopewars client, using GTK+ on Unix systems and
71 the standard libaries under Windows. If unspecified, this is enabled only
72 if your system has the necessary libraries (e.g. GTK+) installed.
73
74 --enable-curses-client:
75 Compile a text-mode client, using ncurses or similar on Unix systems
76 and the standard libraries under Windows. If unspecified, this is enabled only
77 if you have ncurses (or similar) installed.
78
79 --enable-gui-server:
80 Use a (very basic) graphical interface to the dopewars server. If not
81 specified, this is enabled under Windows and disabled under Unix (where a
82 simple text-mode server is used instead).
83
84 --enable-strict
85 If using gcc to compile dopewars (recommended) then this turns on
86 extra warning messages (useful for debugging, etc.) Unfortunately a lot of
87 these warnings can be safely ignored, so this is not the default.
88
89 Basic Installation
90 ==================
91
92 These are generic installation instructions.
93
94 The `configure' shell script attempts to guess correct values for
95 various system-dependent variables used during compilation. It uses
96 those values to create a `Makefile' in each directory of the package.
97 It may also create one or more `.h' files containing system-dependent
98 definitions. Finally, it creates a shell script `config.status' that
99 you can run in the future to recreate the current configuration, a file
100 `config.cache' that saves the results of its tests to speed up
101 reconfiguring, and a file `config.log' containing compiler output
102 (useful mainly for debugging `configure').
103
104 If you need to do unusual things to compile the package, please try
105 to figure out how `configure' could check whether to do them, and mail
106 diffs or instructions to the address given in the `README' so they can
107 be considered for the next release. If at some point `config.cache'
108 contains results you don't want to keep, you may remove or edit it.
109
110 The file `configure.in' is used to create `configure' by a program
111 called `autoconf'. You only need `configure.in' if you want to change
112 it or regenerate `configure' using a newer version of `autoconf'.
113
114 The simplest way to compile this package is:
115
116 1. `cd' to the directory containing the package's source code and type
117 `./configure' to configure the package for your system. If you're
118 using `csh' on an old version of System V, you might need to type
119 `sh ./configure' instead to prevent `csh' from trying to execute
120 `configure' itself.
121
122 Running `configure' takes awhile. While running, it prints some
123 messages telling which features it is checking for.
124
125 2. Type `make' to compile the package.
126
127 3. Optionally, type `make check' to run any self-tests that come with
128 the package.
129
130 4. Type `make install' to install the programs and any data files and
131 documentation.
132
133 5. You can remove the program binaries and object files from the
134 source code directory by typing `make clean'. To also remove the
135 files that `configure' created (so you can compile the package for
136 a different kind of computer), type `make distclean'. There is
137 also a `make maintainer-clean' target, but that is intended mainly
138 for the package's developers. If you use it, you may have to get
139 all sorts of other programs in order to regenerate files that came
140 with the distribution.
141
142 Compilers and Options
143 =====================
144
145 Some systems require unusual options for compilation or linking that
146 the `configure' script does not know about. You can give `configure'
147 initial values for variables by setting them in the environment. Using
148 a Bourne-compatible shell, you can do that on the command line like
149 this:
150 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
151
152 Or on systems that have the `env' program, you can do it like this:
153 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
154
155 Compiling For Multiple Architectures
156 ====================================
157
158 You can compile the package for more than one kind of computer at the
159 same time, by placing the object files for each architecture in their
160 own directory. To do this, you must use a version of `make' that
161 supports the `VPATH' variable, such as GNU `make'. `cd' to the
162 directory where you want the object files and executables to go and run
163 the `configure' script. `configure' automatically checks for the
164 source code in the directory that `configure' is in and in `..'.
165
166 If you have to use a `make' that does not supports the `VPATH'
167 variable, you have to compile the package for one architecture at a time
168 in the source code directory. After you have installed the package for
169 one architecture, use `make distclean' before reconfiguring for another
170 architecture.
171
172 Installation Names
173 ==================
174
175 By default, `make install' will install the package's files in
176 `/usr/local/bin', `/usr/local/man', etc. You can specify an
177 installation prefix other than `/usr/local' by giving `configure' the
178 option `--prefix=PATH'.
179
180 You can specify separate installation prefixes for
181 architecture-specific files and architecture-independent files. If you
182 give `configure' the option `--exec-prefix=PATH', the package will use
183 PATH as the prefix for installing programs and libraries.
184 Documentation and other data files will still use the regular prefix.
185
186 In addition, if you use an unusual directory layout you can give
187 options like `--bindir=PATH' to specify different values for particular
188 kinds of files. Run `configure --help' for a list of the directories
189 you can set and what kinds of files go in them.
190
191 If the package supports it, you can cause programs to be installed
192 with an extra prefix or suffix on their names by giving `configure' the
193 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
194
195 Optional Features
196 =================
197
198 Some packages pay attention to `--enable-FEATURE' options to
199 `configure', where FEATURE indicates an optional part of the package.
200 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
201 is something like `gnu-as' or `x' (for the X Window System). The
202 `README' should mention any `--enable-' and `--with-' options that the
203 package recognizes.
204
205 For packages that use the X Window System, `configure' can usually
206 find the X include and library files automatically, but if it doesn't,
207 you can use the `configure' options `--x-includes=DIR' and
208 `--x-libraries=DIR' to specify their locations.
209
210 Specifying the System Type
211 ==========================
212
213 There may be some features `configure' can not figure out
214 automatically, but needs to determine by the type of host the package
215 will run on. Usually `configure' can figure that out, but if it prints
216 a message saying it can not guess the host type, give it the
217 `--host=TYPE' option. TYPE can either be a short name for the system
218 type, such as `sun4', or a canonical name with three fields:
219 CPU-COMPANY-SYSTEM
220
221 See the file `config.sub' for the possible values of each field. If
222 `config.sub' isn't included in this package, then this package doesn't
223 need to know the host type.
224
225 If you are building compiler tools for cross-compiling, you can also
226 use the `--target=TYPE' option to select the type of system they will
227 produce code for and the `--build=TYPE' option to select the type of
228 system on which you are compiling the package.
229
230 Sharing Defaults
231 ================
232
233 If you want to set default values for `configure' scripts to share,
234 you can create a site shell script called `config.site' that gives
235 default values for variables like `CC', `cache_file', and `prefix'.
236 `configure' looks for `PREFIX/share/config.site' if it exists, then
237 `PREFIX/etc/config.site' if it exists. Or, you can set the
238 `CONFIG_SITE' environment variable to the location of the site script.
239 A warning: not all `configure' scripts look for a site script.
240
241 Operation Controls
242 ==================
243
244 `configure' recognizes the following options to control how it
245 operates.
246
247 `--cache-file=FILE'
248 Use and save the results of the tests in FILE instead of
249 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
250 debugging `configure'.
251
252 `--help'
253 Print a summary of the options to `configure', and exit.
254
255 `--quiet'
256 `--silent'
257 `-q'
258 Do not print messages saying which checks are being made. To
259 suppress all normal output, redirect it to `/dev/null' (any error
260 messages will still be shown).
261
262 `--srcdir=DIR'
263 Look for the package's source code in directory DIR. Usually
264 `configure' can determine that directory automatically.
265
266 `--version'
267 Print the version of Autoconf used to generate the `configure'
268 script, and exit.
269
270 `configure' also accepts some other, not widely useful, options.