← Back to branch summary

~ubuntu-branches/ubuntu/saucy/bumprace/saucy

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Bazaar Package Importer
  • Author(s): Christian T. Steigies
  • Date: 2008-03-24 19:39:13 UTC
  • mfrom: (4.1.1 gutsy)
  • Revision ID: james.westby@ubuntu.com-20080324193913-txwmazipk658a8t6
Tags: 1.5.3-2
* updated Standards-Version to 3.7.3, use section Games/Action according
  to the menu policy
* modify build-depends for libsdl1.2-dev as suggested by lintian
* re-create manpage with docbook-to-man to remove lintian warnings

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
 
1
Installation Instructions
 
2
*************************
 
3
 
 
4
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
 
5
2006 Free Software Foundation, Inc.
 
6
 
 
7
This file is free documentation; the Free Software Foundation gives
 
8
unlimited permission to copy, distribute and modify it.
 
9
 
1
10
Basic Installation
2
11
==================
3
12
 
4
 
   These are generic installation instructions.
 
13
Briefly, the shell commands `./configure; make; make install' should
 
14
configure, build, and install this package.  The following
 
15
more-detailed instructions are generic; see the `README' file for
 
16
instructions specific to this package.
5
17
 
6
18
   The `configure' shell script attempts to guess correct values for
7
19
various system-dependent variables used during compilation.  It uses
8
20
those values to create a `Makefile' in each directory of the package.
9
21
It may also create one or more `.h' files containing system-dependent
10
22
definitions.  Finally, it creates a shell script `config.status' that
11
 
you can run in the future to recreate the current configuration, a file
12
 
`config.cache' that saves the results of its tests to speed up
13
 
reconfiguring, and a file `config.log' containing compiler output
14
 
(useful mainly for debugging `configure').
 
23
you can run in the future to recreate the current configuration, and a
 
24
file `config.log' containing compiler output (useful mainly for
 
25
debugging `configure').
 
26
 
 
27
   It can also use an optional file (typically called `config.cache'
 
28
and enabled with `--cache-file=config.cache' or simply `-C') that saves
 
29
the results of its tests to speed up reconfiguring.  Caching is
 
30
disabled by default to prevent problems with accidental use of stale
 
31
cache files.
15
32
 
16
33
   If you need to do unusual things to compile the package, please try
17
34
to figure out how `configure' could check whether to do them, and mail
18
35
diffs or instructions to the address given in the `README' so they can
19
 
be considered for the next release.  If at some point `config.cache'
20
 
contains results you don't want to keep, you may remove or edit it.
 
36
be considered for the next release.  If you are using the cache, and at
 
37
some point `config.cache' contains results you don't want to keep, you
 
38
may remove or edit it.
21
39
 
22
 
   The file `configure.in' is used to create `configure' by a program
23
 
called `autoconf'.  You only need `configure.in' if you want to change
24
 
it or regenerate `configure' using a newer version of `autoconf'.
 
40
   The file `configure.ac' (or `configure.in') is used to create
 
41
`configure' by a program called `autoconf'.  You need `configure.ac' if
 
42
you want to change it or regenerate `configure' using a newer version
 
43
of `autoconf'.
25
44
 
26
45
The simplest way to compile this package is:
27
46
 
28
47
  1. `cd' to the directory containing the package's source code and type
29
 
     `./configure' to configure the package for your system.  If you're
30
 
     using `csh' on an old version of System V, you might need to type
31
 
     `sh ./configure' instead to prevent `csh' from trying to execute
32
 
     `configure' itself.
 
48
     `./configure' to configure the package for your system.
33
49
 
34
 
     Running `configure' takes awhile.  While running, it prints some
35
 
     messages telling which features it is checking for.
 
50
     Running `configure' might take a while.  While running, it prints
 
51
     some messages telling which features it is checking for.
36
52
 
37
53
  2. Type `make' to compile the package.
38
54
 
54
70
Compilers and Options
55
71
=====================
56
72
 
57
 
   Some systems require unusual options for compilation or linking that
58
 
the `configure' script does not know about.  You can give `configure'
59
 
initial values for variables by setting them in the environment.  Using
60
 
a Bourne-compatible shell, you can do that on the command line like
61
 
this:
62
 
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
63
 
 
64
 
Or on systems that have the `env' program, you can do it like this:
65
 
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 
73
Some systems require unusual options for compilation or linking that the
 
74
`configure' script does not know about.  Run `./configure --help' for
 
75
details on some of the pertinent environment variables.
 
76
 
 
77
   You can give `configure' initial values for configuration parameters
 
78
by setting variables in the command line or in the environment.  Here
 
79
is an example:
 
80
 
 
81
     ./configure CC=c99 CFLAGS=-g LIBS=-lposix
 
82
 
 
83
   *Note Defining Variables::, for more details.
66
84
 
67
85
Compiling For Multiple Architectures
68
86
====================================
69
87
 
70
 
   You can compile the package for more than one kind of computer at the
 
88
You can compile the package for more than one kind of computer at the
71
89
same time, by placing the object files for each architecture in their
72
 
own directory.  To do this, you must use a version of `make' that
73
 
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 
90
own directory.  To do this, you can use GNU `make'.  `cd' to the
74
91
directory where you want the object files and executables to go and run
75
92
the `configure' script.  `configure' automatically checks for the
76
93
source code in the directory that `configure' is in and in `..'.
77
94
 
78
 
   If you have to use a `make' that does not supports the `VPATH'
79
 
variable, you have to compile the package for one architecture at a time
80
 
in the source code directory.  After you have installed the package for
81
 
one architecture, use `make distclean' before reconfiguring for another
82
 
architecture.
 
95
   With a non-GNU `make', it is safer to compile the package for one
 
96
architecture at a time in the source code directory.  After you have
 
97
installed the package for one architecture, use `make distclean' before
 
98
reconfiguring for another architecture.
83
99
 
84
100
Installation Names
85
101
==================
86
102
 
87
 
   By default, `make install' will install the package's files in
88
 
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
89
 
installation prefix other than `/usr/local' by giving `configure' the
90
 
option `--prefix=PATH'.
 
103
By default, `make install' installs the package's commands under
 
104
`/usr/local/bin', include files under `/usr/local/include', etc.  You
 
105
can specify an installation prefix other than `/usr/local' by giving
 
106
`configure' the option `--prefix=PREFIX'.
91
107
 
92
108
   You can specify separate installation prefixes for
93
109
architecture-specific files and architecture-independent files.  If you
94
 
give `configure' the option `--exec-prefix=PATH', the package will use
95
 
PATH as the prefix for installing programs and libraries.
96
 
Documentation and other data files will still use the regular prefix.
 
110
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 
111
PREFIX as the prefix for installing programs and libraries.
 
112
Documentation and other data files still use the regular prefix.
97
113
 
98
114
   In addition, if you use an unusual directory layout you can give
99
 
options like `--bindir=PATH' to specify different values for particular
 
115
options like `--bindir=DIR' to specify different values for particular
100
116
kinds of files.  Run `configure --help' for a list of the directories
101
117
you can set and what kinds of files go in them.
102
118
 
107
123
Optional Features
108
124
=================
109
125
 
110
 
   Some packages pay attention to `--enable-FEATURE' options to
 
126
Some packages pay attention to `--enable-FEATURE' options to
111
127
`configure', where FEATURE indicates an optional part of the package.
112
128
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
113
129
is something like `gnu-as' or `x' (for the X Window System).  The
122
138
Specifying the System Type
123
139
==========================
124
140
 
125
 
   There may be some features `configure' can not figure out
126
 
automatically, but needs to determine by the type of host the package
127
 
will run on.  Usually `configure' can figure that out, but if it prints
128
 
a message saying it can not guess the host type, give it the
129
 
`--host=TYPE' option.  TYPE can either be a short name for the system
130
 
type, such as `sun4', or a canonical name with three fields:
 
141
There may be some features `configure' cannot figure out automatically,
 
142
but needs to determine by the type of machine the package will run on.
 
143
Usually, assuming the package is built to be run on the _same_
 
144
architectures, `configure' can figure that out, but if it prints a
 
145
message saying it cannot guess the machine type, give it the
 
146
`--build=TYPE' option.  TYPE can either be a short name for the system
 
147
type, such as `sun4', or a canonical name which has the form:
 
148
 
131
149
     CPU-COMPANY-SYSTEM
132
150
 
133
 
See the file `config.sub' for the possible values of each field.  If
 
151
where SYSTEM can have one of these forms:
 
152
 
 
153
     OS KERNEL-OS
 
154
 
 
155
   See the file `config.sub' for the possible values of each field.  If
134
156
`config.sub' isn't included in this package, then this package doesn't
135
 
need to know the host type.
136
 
 
137
 
   If you are building compiler tools for cross-compiling, you can also
138
 
use the `--target=TYPE' option to select the type of system they will
139
 
produce code for and the `--build=TYPE' option to select the type of
140
 
system on which you are compiling the package.
 
157
need to know the machine type.
 
158
 
 
159
   If you are _building_ compiler tools for cross-compiling, you should
 
160
use the option `--target=TYPE' to select the type of system they will
 
161
produce code for.
 
162
 
 
163
   If you want to _use_ a cross compiler, that generates code for a
 
164
platform different from the build platform, you should specify the
 
165
"host" platform (i.e., that on which the generated programs will
 
166
eventually be run) with `--host=TYPE'.
141
167
 
142
168
Sharing Defaults
143
169
================
144
170
 
145
 
   If you want to set default values for `configure' scripts to share,
146
 
you can create a site shell script called `config.site' that gives
147
 
default values for variables like `CC', `cache_file', and `prefix'.
 
171
If you want to set default values for `configure' scripts to share, you
 
172
can create a site shell script called `config.site' that gives default
 
173
values for variables like `CC', `cache_file', and `prefix'.
148
174
`configure' looks for `PREFIX/share/config.site' if it exists, then
149
175
`PREFIX/etc/config.site' if it exists.  Or, you can set the
150
176
`CONFIG_SITE' environment variable to the location of the site script.
151
177
A warning: not all `configure' scripts look for a site script.
152
178
 
153
 
Operation Controls
 
179
Defining Variables
154
180
==================
155
181
 
156
 
   `configure' recognizes the following options to control how it
157
 
operates.
158
 
 
159
 
`--cache-file=FILE'
160
 
     Use and save the results of the tests in FILE instead of
161
 
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
162
 
     debugging `configure'.
 
182
Variables not defined in a site shell script can be set in the
 
183
environment passed to `configure'.  However, some packages may run
 
184
configure again during the build, and the customized values of these
 
185
variables may be lost.  In order to avoid this problem, you should set
 
186
them in the `configure' command line, using `VAR=value'.  For example:
 
187
 
 
188
     ./configure CC=/usr/local2/bin/gcc
 
189
 
 
190
causes the specified `gcc' to be used as the C compiler (unless it is
 
191
overridden in the site shell script).
 
192
 
 
193
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
 
194
an Autoconf bug.  Until the bug is fixed you can use this workaround:
 
195
 
 
196
     CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
 
197
 
 
198
`configure' Invocation
 
199
======================
 
200
 
 
201
`configure' recognizes the following options to control how it operates.
163
202
 
164
203
`--help'
 
204
`-h'
165
205
     Print a summary of the options to `configure', and exit.
166
206
 
 
207
`--version'
 
208
`-V'
 
209
     Print the version of Autoconf used to generate the `configure'
 
210
     script, and exit.
 
211
 
 
212
`--cache-file=FILE'
 
213
     Enable the cache: use and save the results of the tests in FILE,
 
214
     traditionally `config.cache'.  FILE defaults to `/dev/null' to
 
215
     disable caching.
 
216
 
 
217
`--config-cache'
 
218
`-C'
 
219
     Alias for `--cache-file=config.cache'.
 
220
 
167
221
`--quiet'
168
222
`--silent'
169
223
`-q'
175
229
     Look for the package's source code in directory DIR.  Usually
176
230
     `configure' can determine that directory automatically.
177
231
 
178
 
`--version'
179
 
     Print the version of Autoconf used to generate the `configure'
180
 
     script, and exit.
 
232
`configure' also accepts some other, not widely useful, options.  Run
 
233
`configure --help' for more details.
181
234
 
182
 
`configure' also accepts some other, not widely useful, options.