Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/INSTALL @ 10629

Last change on this file since 10629 was 10587, checked in by patrick, 18 years ago

some very small change

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