Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/INSTALL @ 5694

Last change on this file since 5694 was 4944, checked in by bensch, 19 years ago

orxonox/trunk: opened and saved some files, and also rewritten some organizatory stuff

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