Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/orxonox/trunk/INSTALL @ 4646

Last change on this file since 4646 was 4604, checked in by bensch, 19 years ago

orxonox/trunk: minor

File size: 10.1 KB
Line 
1
2INSTALLATION INSTRUCTIONS FOR ORXONOX
3=====================================
4
5INSTALLATION
6============
7
8To make it quite easy for those of you who just want to install orxonox:
9
101. ./configure
112. make
123. make install
13
14(Further Information please see below at autoconf information)
15
16DEPENDENCIES
17============
18
19There are some dependencies for orxonox you have to install:
20
211. SDL           (http://www.libsdl.org)
222. OPENGL        (http://www.opengl.org)
233. OPENAL        (http://www.openal.org)
244. SDL_image     (http://www.libsdl.org/projects/SDL_image)
255. SDL_ttf       (http://www.libsdl.org/projects/SDL_ttf)
26 a) needs libttf (http://www.freetype.org/)
27
28Nice to Have:
296. Doxygen       (http://www.stack.nl/~dimitri/doxygen/)
307. Automake      (http://www.gnu.org/software/automake/)
318. Autoconf      (http://www.gnu.org/software/autoconf/)
32
33Windows Users also need the following:
349. mingw         (http://mingw.org/)
35
36
37BUGS
38====
39Send bug reports to <orxonox-dev@mail.datacore.ch>
40
41ORXONOX->
42##########################################################
43                                                <-AUTOCONF
44
45
46
47Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
48Foundation, Inc.
49
50   This file is free documentation; the Free Software Foundation gives
51unlimited permission to copy, distribute and modify it.
52
53Basic Installation
54==================
55
56   These are generic installation instructions.
57
58   The `configure' shell script attempts to guess correct values for
59various system-dependent variables used during compilation.  It uses
60those values to create a `Makefile' in each directory of the package.
61It may also create one or more `.h' files containing system-dependent
62definitions.  Finally, it creates a shell script `config.status' that
63you can run in the future to recreate the current configuration, and a
64file `config.log' containing compiler output (useful mainly for
65debugging `configure').
66
67   It can also use an optional file (typically called `config.cache'
68and enabled with `--cache-file=config.cache' or simply `-C') that saves
69the results of its tests to speed up reconfiguring.  (Caching is
70disabled by default to prevent problems with accidental use of stale
71cache files.)
72
73   If you need to do unusual things to compile the package, please try
74to figure out how `configure' could check whether to do them, and mail
75diffs or instructions to the address given in the `README' so they can
76be considered for the next release.  If you are using the cache, and at
77some point `config.cache' contains results you don't want to keep, you
78may remove or edit it.
79
80   The file `configure.ac' (or `configure.in') is used to create
81`configure' by a program called `autoconf'.  You only need
82`configure.ac' if you want to change it or regenerate `configure' using
83a newer version of `autoconf'.
84
85The simplest way to compile this package is:
86
87  1. `cd' to the directory containing the package's source code and type
88     `./configure' to configure the package for your system.  If you're
89     using `csh' on an old version of System V, you might need to type
90     `sh ./configure' instead to prevent `csh' from trying to execute
91     `configure' itself.
92
93     Running `configure' takes awhile.  While running, it prints some
94     messages telling which features it is checking for.
95
96  2. Type `make' to compile the package.
97
98  3. Optionally, type `make check' to run any self-tests that come with
99     the package.
100
101  4. Type `make install' to install the programs and any data files and
102     documentation.
103
104  5. You can remove the program binaries and object files from the
105     source code directory by typing `make clean'.  To also remove the
106     files that `configure' created (so you can compile the package for
107     a different kind of computer), type `make distclean'.  There is
108     also a `make maintainer-clean' target, but that is intended mainly
109     for the package's developers.  If you use it, you may have to get
110     all sorts of other programs in order to regenerate files that came
111     with the distribution.
112
113Compilers and Options
114=====================
115
116   Some systems require unusual options for compilation or linking that
117the `configure' script does not know about.  Run `./configure --help'
118for details on some of the pertinent environment variables.
119
120   You can give `configure' initial values for configuration parameters
121by setting variables in the command line or in the environment.  Here
122is an example:
123
124     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
125
126   *Note Defining Variables::, for more details.
127
128Compiling For Multiple Architectures
129====================================
130
131   You can compile the package for more than one kind of computer at the
132same time, by placing the object files for each architecture in their
133own directory.  To do this, you must use a version of `make' that
134supports the `VPATH' variable, such as GNU `make'.  `cd' to the
135directory where you want the object files and executables to go and run
136the `configure' script.  `configure' automatically checks for the
137source code in the directory that `configure' is in and in `..'.
138
139   If you have to use a `make' that does not support the `VPATH'
140variable, you have to compile the package for one architecture at a
141time in the source code directory.  After you have installed the
142package for one architecture, use `make distclean' before reconfiguring
143for another architecture.
144
145Installation Names
146==================
147
148   By default, `make install' will install the package's files in
149`/usr/local/bin', `/usr/local/man', etc.  You can specify an
150installation prefix other than `/usr/local' by giving `configure' the
151option `--prefix=PATH'.
152
153   You can specify separate installation prefixes for
154architecture-specific files and architecture-independent files.  If you
155give `configure' the option `--exec-prefix=PATH', the package will use
156PATH as the prefix for installing programs and libraries.
157Documentation and other data files will still use the regular prefix.
158
159   In addition, if you use an unusual directory layout you can give
160options like `--bindir=PATH' to specify different values for particular
161kinds of files.  Run `configure --help' for a list of the directories
162you can set and what kinds of files go in them.
163
164   If the package supports it, you can cause programs to be installed
165with an extra prefix or suffix on their names by giving `configure' the
166option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
167
168Optional Features
169=================
170
171   Some packages pay attention to `--enable-FEATURE' options to
172`configure', where FEATURE indicates an optional part of the package.
173They may also pay attention to `--with-PACKAGE' options, where PACKAGE
174is something like `gnu-as' or `x' (for the X Window System).  The
175`README' should mention any `--enable-' and `--with-' options that the
176package recognizes.
177
178   For packages that use the X Window System, `configure' can usually
179find the X include and library files automatically, but if it doesn't,
180you can use the `configure' options `--x-includes=DIR' and
181`--x-libraries=DIR' to specify their locations.
182
183Specifying the System Type
184==========================
185
186   There may be some features `configure' cannot figure out
187automatically, but needs to determine by the type of machine the package
188will run on.  Usually, assuming the package is built to be run on the
189_same_ architectures, `configure' can figure that out, but if it prints
190a message saying it cannot guess the machine type, give it the
191`--build=TYPE' option.  TYPE can either be a short name for the system
192type, such as `sun4', or a canonical name which has the form:
193
194     CPU-COMPANY-SYSTEM
195
196where SYSTEM can have one of these forms:
197
198     OS KERNEL-OS
199
200   See the file `config.sub' for the possible values of each field.  If
201`config.sub' isn't included in this package, then this package doesn't
202need to know the machine type.
203
204   If you are _building_ compiler tools for cross-compiling, you should
205use the `--target=TYPE' option to select the type of system they will
206produce code for.
207
208   If you want to _use_ a cross compiler, that generates code for a
209platform different from the build platform, you should specify the
210"host" platform (i.e., that on which the generated programs will
211eventually be run) with `--host=TYPE'.
212
213Sharing Defaults
214================
215
216   If you want to set default values for `configure' scripts to share,
217you can create a site shell script called `config.site' that gives
218default values for variables like `CC', `cache_file', and `prefix'.
219`configure' looks for `PREFIX/share/config.site' if it exists, then
220`PREFIX/etc/config.site' if it exists.  Or, you can set the
221`CONFIG_SITE' environment variable to the location of the site script.
222A warning: not all `configure' scripts look for a site script.
223
224Defining Variables
225==================
226
227   Variables not defined in a site shell script can be set in the
228environment passed to `configure'.  However, some packages may run
229configure again during the build, and the customized values of these
230variables may be lost.  In order to avoid this problem, you should set
231them in the `configure' command line, using `VAR=value'.  For example:
232
233     ./configure CC=/usr/local2/bin/gcc
234
235will cause the specified gcc to be used as the C compiler (unless it is
236overridden in the site shell script).
237
238`configure' Invocation
239======================
240
241   `configure' recognizes the following options to control how it
242operates.
243
244`--help'
245`-h'
246     Print a summary of the options to `configure', and exit.
247
248`--version'
249`-V'
250     Print the version of Autoconf used to generate the `configure'
251     script, and exit.
252
253`--cache-file=FILE'
254     Enable the cache: use and save the results of the tests in FILE,
255     traditionally `config.cache'.  FILE defaults to `/dev/null' to
256     disable caching.
257
258`--config-cache'
259`-C'
260     Alias for `--cache-file=config.cache'.
261
262`--quiet'
263`--silent'
264`-q'
265     Do not print messages saying which checks are being made.  To
266     suppress all normal output, redirect it to `/dev/null' (any error
267     messages will still be shown).
268
269`--srcdir=DIR'
270     Look for the package's source code in directory DIR.  Usually
271     `configure' can determine that directory automatically.
272
273`configure' also accepts some other, not widely useful, options.  Run
274`configure --help' for more details.
275
Note: See TracBrowser for help on using the repository browser.