source: sources/INSTALL @ 58

Last change on this file since 58 was 41, checked in by buchmann, 15 years ago

Add:

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