Subversion Repositories shark

Rev

Rev 3 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
2 pj 1
-----------------------------------------------------------------------
2
			   Installing FFTW
3
-----------------------------------------------------------------------
4
 
5
Here, we provide a terse overview of FFTW's installation.  More
6
detailed installation instructions can be found in the "Installation"
7
section of the FFTW manual, in the doc/ directory.  We encourage you
8
to refer to the manual.
9
 
10
On Unix systems, type
11
 
12
          ./configure
13
          make
14
 
15
to compile FFTW and its test programs.  Type 'make install' to install
16
the FFTW library and header file into standard places.  Type 'make check'
17
to put the test programs through their paces.  The 'configure' script
18
may output helpful suggestions or warnings (surrounded by many
19
asterisks, so you can't miss them); be sure to peruse its output.
20
Also, see below for generic instructions regarding the usage of the
21
Unix 'configure' script.
22
 
23
On non-Unix systems, you should simply compile all of the .c files in
24
the fftw/ directory into a library for the complex transforms, and all
25
of the .c files in the rfftw/ directory for the real transforms.  You
26
can also compile and link the test programs in the tests/ directory;
27
see the FFTW manual for more detail.
28
 
29
-----------------------------------------------------------------------
30
		    Generic Instructions for Unix
31
-----------------------------------------------------------------------
32
 
33
Basic Installation
34
==================
35
 
36
   These are generic installation instructions.
37
 
38
   The `configure' shell script attempts to guess correct values for
39
various system-dependent variables used during compilation.  It uses
40
those values to create a `Makefile' in each directory of the package.
41
It may also create one or more `.h' files containing system-dependent
42
definitions.  Finally, it creates a shell script `config.status' that
43
you can run in the future to recreate the current configuration, a file
44
`config.cache' that saves the results of its tests to speed up
45
reconfiguring, and a file `config.log' containing compiler output
46
(useful mainly for debugging `configure').
47
 
48
   If you need to do unusual things to compile the package, please try
49
to figure out how `configure' could check whether to do them, and mail
50
diffs or instructions to the address given in the `README' so they can
51
be considered for the next release.  If at some point `config.cache'
52
contains results you don't want to keep, you may remove or edit it.
53
 
54
   The file `configure.in' is used to create `configure' by a program
55
called `autoconf'.  You only need `configure.in' if you want to change
56
it or regenerate `configure' using a newer version of `autoconf'.
57
 
58
The simplest way to compile this package is:
59
 
60
  1. `cd' to the directory containing the package's source code and type
61
     `./configure' to configure the package for your system.  If you're
62
     using `csh' on an old version of System V, you might need to type
63
     `sh ./configure' instead to prevent `csh' from trying to execute
64
     `configure' itself.
65
 
66
     Running `configure' takes awhile.  While running, it prints some
67
     messages telling which features it is checking for.
68
 
69
  2. Type `make' to compile the package.
70
 
71
  3. Optionally, type `make check' to run any self-tests that come with
72
     the package.
73
 
74
  4. Type `make install' to install the programs and any data files and
75
     documentation.
76
 
77
  5. You can remove the program binaries and object files from the
78
     source code directory by typing `make clean'.  To also remove the
79
     files that `configure' created (so you can compile the package for
80
     a different kind of computer), type `make distclean'.  There is
81
     also a `make maintainer-clean' target, but that is intended mainly
82
     for the package's developers.  If you use it, you may have to get
83
     all sorts of other programs in order to regenerate files that came
84
     with the distribution.
85
 
86
Compilers and Options
87
=====================
88
 
89
   Some systems require unusual options for compilation or linking that
90
the `configure' script does not know about.  You can give `configure'
91
initial values for variables by setting them in the environment.  Using
92
a Bourne-compatible shell, you can do that on the command line like
93
this:
94
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
95
 
96
Or on systems that have the `env' program, you can do it like this:
97
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
98
 
99
Compiling For Multiple Architectures
100
====================================
101
 
102
   You can compile the package for more than one kind of computer at the
103
same time, by placing the object files for each architecture in their
104
own directory.  To do this, you must use a version of `make' that
105
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
106
directory where you want the object files and executables to go and run
107
the `configure' script.  `configure' automatically checks for the
108
source code in the directory that `configure' is in and in `..'.
109
 
110
   If you have to use a `make' that does not supports the `VPATH'
111
variable, you have to compile the package for one architecture at a time
112
in the source code directory.  After you have installed the package for
113
one architecture, use `make distclean' before reconfiguring for another
114
architecture.
115
 
116
Installation Names
117
==================
118
 
119
   By default, `make install' will install the package's files in
120
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
121
installation prefix other than `/usr/local' by giving `configure' the
122
option `--prefix=PATH'.
123
 
124
   You can specify separate installation prefixes for
125
architecture-specific files and architecture-independent files.  If you
126
give `configure' the option `--exec-prefix=PATH', the package will use
127
PATH as the prefix for installing programs and libraries.
128
Documentation and other data files will still use the regular prefix.
129
 
130
   In addition, if you use an unusual directory layout you can give
131
options like `--bindir=PATH' to specify different values for particular
132
kinds of files.  Run `configure --help' for a list of the directories
133
you can set and what kinds of files go in them.
134
 
135
   If the package supports it, you can cause programs to be installed
136
with an extra prefix or suffix on their names by giving `configure' the
137
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
138
 
139
Optional Features
140
=================
141
 
142
   Some packages pay attention to `--enable-FEATURE' options to
143
`configure', where FEATURE indicates an optional part of the package.
144
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
145
is something like `gnu-as' or `x' (for the X Window System).  The
146
`README' should mention any `--enable-' and `--with-' options that the
147
package recognizes.
148
 
149
   For packages that use the X Window System, `configure' can usually
150
find the X include and library files automatically, but if it doesn't,
151
you can use the `configure' options `--x-includes=DIR' and
152
`--x-libraries=DIR' to specify their locations.
153
 
154
Specifying the System Type
155
==========================
156
 
157
   There may be some features `configure' can not figure out
158
automatically, but needs to determine by the type of host the package
159
will run on.  Usually `configure' can figure that out, but if it prints
160
a message saying it can not guess the host type, give it the
161
`--host=TYPE' option.  TYPE can either be a short name for the system
162
type, such as `sun4', or a canonical name with three fields:
163
     CPU-COMPANY-SYSTEM
164
 
165
See the file `config.sub' for the possible values of each field.  If
166
`config.sub' isn't included in this package, then this package doesn't
167
need to know the host type.
168
 
169
   If you are building compiler tools for cross-compiling, you can also
170
use the `--target=TYPE' option to select the type of system they will
171
produce code for and the `--build=TYPE' option to select the type of
172
system on which you are compiling the package.
173
 
174
Sharing Defaults
175
================
176
 
177
   If you want to set default values for `configure' scripts to share,
178
you can create a site shell script called `config.site' that gives
179
default values for variables like `CC', `cache_file', and `prefix'.
180
`configure' looks for `PREFIX/share/config.site' if it exists, then
181
`PREFIX/etc/config.site' if it exists.  Or, you can set the
182
`CONFIG_SITE' environment variable to the location of the site script.
183
A warning: not all `configure' scripts look for a site script.
184
 
185
Operation Controls
186
==================
187
 
188
   `configure' recognizes the following options to control how it
189
operates.
190
 
191
`--cache-file=FILE'
192
     Use and save the results of the tests in FILE instead of
193
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
194
     debugging `configure'.
195
 
196
`--help'
197
     Print a summary of the options to `configure', and exit.
198
 
199
`--quiet'
200
`--silent'
201
`-q'
202
     Do not print messages saying which checks are being made.  To
203
     suppress all normal output, redirect it to `/dev/null' (any error
204
     messages will still be shown).
205
 
206
`--srcdir=DIR'
207
     Look for the package's source code in directory DIR.  Usually
208
     `configure' can determine that directory automatically.
209
 
210
`--version'
211
     Print the version of Autoconf used to generate the `configure'
212
     script, and exit.
213
 
214
`configure' also accepts some other, not widely useful, options.