annotate fft/fftw/fftw-3.3.4/INSTALL @ 40:223f770b5341 kissfft-double tip

Try a double-precision kissfft
author Chris Cannam
date Wed, 07 Sep 2016 10:40:32 +0100
parents 26056e866c29
children
rev   line source
Chris@19 1 Installation Instructions
Chris@19 2 *************************
Chris@19 3
Chris@19 4 Copyright (C) 1994-1996, 1999-2002, 2004-2013 Free Software Foundation,
Chris@19 5 Inc.
Chris@19 6
Chris@19 7 Copying and distribution of this file, with or without modification,
Chris@19 8 are permitted in any medium without royalty provided the copyright
Chris@19 9 notice and this notice are preserved. This file is offered as-is,
Chris@19 10 without warranty of any kind.
Chris@19 11
Chris@19 12 Basic Installation
Chris@19 13 ==================
Chris@19 14
Chris@19 15 Briefly, the shell commands `./configure; make; make install' should
Chris@19 16 configure, build, and install this package. The following
Chris@19 17 more-detailed instructions are generic; see the `README' file for
Chris@19 18 instructions specific to this package. Some packages provide this
Chris@19 19 `INSTALL' file but do not implement all of the features documented
Chris@19 20 below. The lack of an optional feature in a given package is not
Chris@19 21 necessarily a bug. More recommendations for GNU packages can be found
Chris@19 22 in *note Makefile Conventions: (standards)Makefile Conventions.
Chris@19 23
Chris@19 24 The `configure' shell script attempts to guess correct values for
Chris@19 25 various system-dependent variables used during compilation. It uses
Chris@19 26 those values to create a `Makefile' in each directory of the package.
Chris@19 27 It may also create one or more `.h' files containing system-dependent
Chris@19 28 definitions. Finally, it creates a shell script `config.status' that
Chris@19 29 you can run in the future to recreate the current configuration, and a
Chris@19 30 file `config.log' containing compiler output (useful mainly for
Chris@19 31 debugging `configure').
Chris@19 32
Chris@19 33 It can also use an optional file (typically called `config.cache'
Chris@19 34 and enabled with `--cache-file=config.cache' or simply `-C') that saves
Chris@19 35 the results of its tests to speed up reconfiguring. Caching is
Chris@19 36 disabled by default to prevent problems with accidental use of stale
Chris@19 37 cache files.
Chris@19 38
Chris@19 39 If you need to do unusual things to compile the package, please try
Chris@19 40 to figure out how `configure' could check whether to do them, and mail
Chris@19 41 diffs or instructions to the address given in the `README' so they can
Chris@19 42 be considered for the next release. If you are using the cache, and at
Chris@19 43 some point `config.cache' contains results you don't want to keep, you
Chris@19 44 may remove or edit it.
Chris@19 45
Chris@19 46 The file `configure.ac' (or `configure.in') is used to create
Chris@19 47 `configure' by a program called `autoconf'. You need `configure.ac' if
Chris@19 48 you want to change it or regenerate `configure' using a newer version
Chris@19 49 of `autoconf'.
Chris@19 50
Chris@19 51 The simplest way to compile this package is:
Chris@19 52
Chris@19 53 1. `cd' to the directory containing the package's source code and type
Chris@19 54 `./configure' to configure the package for your system.
Chris@19 55
Chris@19 56 Running `configure' might take a while. While running, it prints
Chris@19 57 some messages telling which features it is checking for.
Chris@19 58
Chris@19 59 2. Type `make' to compile the package.
Chris@19 60
Chris@19 61 3. Optionally, type `make check' to run any self-tests that come with
Chris@19 62 the package, generally using the just-built uninstalled binaries.
Chris@19 63
Chris@19 64 4. Type `make install' to install the programs and any data files and
Chris@19 65 documentation. When installing into a prefix owned by root, it is
Chris@19 66 recommended that the package be configured and built as a regular
Chris@19 67 user, and only the `make install' phase executed with root
Chris@19 68 privileges.
Chris@19 69
Chris@19 70 5. Optionally, type `make installcheck' to repeat any self-tests, but
Chris@19 71 this time using the binaries in their final installed location.
Chris@19 72 This target does not install anything. Running this target as a
Chris@19 73 regular user, particularly if the prior `make install' required
Chris@19 74 root privileges, verifies that the installation completed
Chris@19 75 correctly.
Chris@19 76
Chris@19 77 6. You can remove the program binaries and object files from the
Chris@19 78 source code directory by typing `make clean'. To also remove the
Chris@19 79 files that `configure' created (so you can compile the package for
Chris@19 80 a different kind of computer), type `make distclean'. There is
Chris@19 81 also a `make maintainer-clean' target, but that is intended mainly
Chris@19 82 for the package's developers. If you use it, you may have to get
Chris@19 83 all sorts of other programs in order to regenerate files that came
Chris@19 84 with the distribution.
Chris@19 85
Chris@19 86 7. Often, you can also type `make uninstall' to remove the installed
Chris@19 87 files again. In practice, not all packages have tested that
Chris@19 88 uninstallation works correctly, even though it is required by the
Chris@19 89 GNU Coding Standards.
Chris@19 90
Chris@19 91 8. Some packages, particularly those that use Automake, provide `make
Chris@19 92 distcheck', which can by used by developers to test that all other
Chris@19 93 targets like `make install' and `make uninstall' work correctly.
Chris@19 94 This target is generally not run by end users.
Chris@19 95
Chris@19 96 Compilers and Options
Chris@19 97 =====================
Chris@19 98
Chris@19 99 Some systems require unusual options for compilation or linking that
Chris@19 100 the `configure' script does not know about. Run `./configure --help'
Chris@19 101 for details on some of the pertinent environment variables.
Chris@19 102
Chris@19 103 You can give `configure' initial values for configuration parameters
Chris@19 104 by setting variables in the command line or in the environment. Here
Chris@19 105 is an example:
Chris@19 106
Chris@19 107 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
Chris@19 108
Chris@19 109 *Note Defining Variables::, for more details.
Chris@19 110
Chris@19 111 Compiling For Multiple Architectures
Chris@19 112 ====================================
Chris@19 113
Chris@19 114 You can compile the package for more than one kind of computer at the
Chris@19 115 same time, by placing the object files for each architecture in their
Chris@19 116 own directory. To do this, you can use GNU `make'. `cd' to the
Chris@19 117 directory where you want the object files and executables to go and run
Chris@19 118 the `configure' script. `configure' automatically checks for the
Chris@19 119 source code in the directory that `configure' is in and in `..'. This
Chris@19 120 is known as a "VPATH" build.
Chris@19 121
Chris@19 122 With a non-GNU `make', it is safer to compile the package for one
Chris@19 123 architecture at a time in the source code directory. After you have
Chris@19 124 installed the package for one architecture, use `make distclean' before
Chris@19 125 reconfiguring for another architecture.
Chris@19 126
Chris@19 127 On MacOS X 10.5 and later systems, you can create libraries and
Chris@19 128 executables that work on multiple system types--known as "fat" or
Chris@19 129 "universal" binaries--by specifying multiple `-arch' options to the
Chris@19 130 compiler but only a single `-arch' option to the preprocessor. Like
Chris@19 131 this:
Chris@19 132
Chris@19 133 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
Chris@19 134 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
Chris@19 135 CPP="gcc -E" CXXCPP="g++ -E"
Chris@19 136
Chris@19 137 This is not guaranteed to produce working output in all cases, you
Chris@19 138 may have to build one architecture at a time and combine the results
Chris@19 139 using the `lipo' tool if you have problems.
Chris@19 140
Chris@19 141 Installation Names
Chris@19 142 ==================
Chris@19 143
Chris@19 144 By default, `make install' installs the package's commands under
Chris@19 145 `/usr/local/bin', include files under `/usr/local/include', etc. You
Chris@19 146 can specify an installation prefix other than `/usr/local' by giving
Chris@19 147 `configure' the option `--prefix=PREFIX', where PREFIX must be an
Chris@19 148 absolute file name.
Chris@19 149
Chris@19 150 You can specify separate installation prefixes for
Chris@19 151 architecture-specific files and architecture-independent files. If you
Chris@19 152 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
Chris@19 153 PREFIX as the prefix for installing programs and libraries.
Chris@19 154 Documentation and other data files still use the regular prefix.
Chris@19 155
Chris@19 156 In addition, if you use an unusual directory layout you can give
Chris@19 157 options like `--bindir=DIR' to specify different values for particular
Chris@19 158 kinds of files. Run `configure --help' for a list of the directories
Chris@19 159 you can set and what kinds of files go in them. In general, the
Chris@19 160 default for these options is expressed in terms of `${prefix}', so that
Chris@19 161 specifying just `--prefix' will affect all of the other directory
Chris@19 162 specifications that were not explicitly provided.
Chris@19 163
Chris@19 164 The most portable way to affect installation locations is to pass the
Chris@19 165 correct locations to `configure'; however, many packages provide one or
Chris@19 166 both of the following shortcuts of passing variable assignments to the
Chris@19 167 `make install' command line to change installation locations without
Chris@19 168 having to reconfigure or recompile.
Chris@19 169
Chris@19 170 The first method involves providing an override variable for each
Chris@19 171 affected directory. For example, `make install
Chris@19 172 prefix=/alternate/directory' will choose an alternate location for all
Chris@19 173 directory configuration variables that were expressed in terms of
Chris@19 174 `${prefix}'. Any directories that were specified during `configure',
Chris@19 175 but not in terms of `${prefix}', must each be overridden at install
Chris@19 176 time for the entire installation to be relocated. The approach of
Chris@19 177 makefile variable overrides for each directory variable is required by
Chris@19 178 the GNU Coding Standards, and ideally causes no recompilation.
Chris@19 179 However, some platforms have known limitations with the semantics of
Chris@19 180 shared libraries that end up requiring recompilation when using this
Chris@19 181 method, particularly noticeable in packages that use GNU Libtool.
Chris@19 182
Chris@19 183 The second method involves providing the `DESTDIR' variable. For
Chris@19 184 example, `make install DESTDIR=/alternate/directory' will prepend
Chris@19 185 `/alternate/directory' before all installation names. The approach of
Chris@19 186 `DESTDIR' overrides is not required by the GNU Coding Standards, and
Chris@19 187 does not work on platforms that have drive letters. On the other hand,
Chris@19 188 it does better at avoiding recompilation issues, and works well even
Chris@19 189 when some directory options were not specified in terms of `${prefix}'
Chris@19 190 at `configure' time.
Chris@19 191
Chris@19 192 Optional Features
Chris@19 193 =================
Chris@19 194
Chris@19 195 If the package supports it, you can cause programs to be installed
Chris@19 196 with an extra prefix or suffix on their names by giving `configure' the
Chris@19 197 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Chris@19 198
Chris@19 199 Some packages pay attention to `--enable-FEATURE' options to
Chris@19 200 `configure', where FEATURE indicates an optional part of the package.
Chris@19 201 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
Chris@19 202 is something like `gnu-as' or `x' (for the X Window System). The
Chris@19 203 `README' should mention any `--enable-' and `--with-' options that the
Chris@19 204 package recognizes.
Chris@19 205
Chris@19 206 For packages that use the X Window System, `configure' can usually
Chris@19 207 find the X include and library files automatically, but if it doesn't,
Chris@19 208 you can use the `configure' options `--x-includes=DIR' and
Chris@19 209 `--x-libraries=DIR' to specify their locations.
Chris@19 210
Chris@19 211 Some packages offer the ability to configure how verbose the
Chris@19 212 execution of `make' will be. For these packages, running `./configure
Chris@19 213 --enable-silent-rules' sets the default to minimal output, which can be
Chris@19 214 overridden with `make V=1'; while running `./configure
Chris@19 215 --disable-silent-rules' sets the default to verbose, which can be
Chris@19 216 overridden with `make V=0'.
Chris@19 217
Chris@19 218 Particular systems
Chris@19 219 ==================
Chris@19 220
Chris@19 221 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
Chris@19 222 CC is not installed, it is recommended to use the following options in
Chris@19 223 order to use an ANSI C compiler:
Chris@19 224
Chris@19 225 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
Chris@19 226
Chris@19 227 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
Chris@19 228
Chris@19 229 HP-UX `make' updates targets which have the same time stamps as
Chris@19 230 their prerequisites, which makes it generally unusable when shipped
Chris@19 231 generated files such as `configure' are involved. Use GNU `make'
Chris@19 232 instead.
Chris@19 233
Chris@19 234 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
Chris@19 235 parse its `<wchar.h>' header file. The option `-nodtk' can be used as
Chris@19 236 a workaround. If GNU CC is not installed, it is therefore recommended
Chris@19 237 to try
Chris@19 238
Chris@19 239 ./configure CC="cc"
Chris@19 240
Chris@19 241 and if that doesn't work, try
Chris@19 242
Chris@19 243 ./configure CC="cc -nodtk"
Chris@19 244
Chris@19 245 On Solaris, don't put `/usr/ucb' early in your `PATH'. This
Chris@19 246 directory contains several dysfunctional programs; working variants of
Chris@19 247 these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
Chris@19 248 in your `PATH', put it _after_ `/usr/bin'.
Chris@19 249
Chris@19 250 On Haiku, software installed for all users goes in `/boot/common',
Chris@19 251 not `/usr/local'. It is recommended to use the following options:
Chris@19 252
Chris@19 253 ./configure --prefix=/boot/common
Chris@19 254
Chris@19 255 Specifying the System Type
Chris@19 256 ==========================
Chris@19 257
Chris@19 258 There may be some features `configure' cannot figure out
Chris@19 259 automatically, but needs to determine by the type of machine the package
Chris@19 260 will run on. Usually, assuming the package is built to be run on the
Chris@19 261 _same_ architectures, `configure' can figure that out, but if it prints
Chris@19 262 a message saying it cannot guess the machine type, give it the
Chris@19 263 `--build=TYPE' option. TYPE can either be a short name for the system
Chris@19 264 type, such as `sun4', or a canonical name which has the form:
Chris@19 265
Chris@19 266 CPU-COMPANY-SYSTEM
Chris@19 267
Chris@19 268 where SYSTEM can have one of these forms:
Chris@19 269
Chris@19 270 OS
Chris@19 271 KERNEL-OS
Chris@19 272
Chris@19 273 See the file `config.sub' for the possible values of each field. If
Chris@19 274 `config.sub' isn't included in this package, then this package doesn't
Chris@19 275 need to know the machine type.
Chris@19 276
Chris@19 277 If you are _building_ compiler tools for cross-compiling, you should
Chris@19 278 use the option `--target=TYPE' to select the type of system they will
Chris@19 279 produce code for.
Chris@19 280
Chris@19 281 If you want to _use_ a cross compiler, that generates code for a
Chris@19 282 platform different from the build platform, you should specify the
Chris@19 283 "host" platform (i.e., that on which the generated programs will
Chris@19 284 eventually be run) with `--host=TYPE'.
Chris@19 285
Chris@19 286 Sharing Defaults
Chris@19 287 ================
Chris@19 288
Chris@19 289 If you want to set default values for `configure' scripts to share,
Chris@19 290 you can create a site shell script called `config.site' that gives
Chris@19 291 default values for variables like `CC', `cache_file', and `prefix'.
Chris@19 292 `configure' looks for `PREFIX/share/config.site' if it exists, then
Chris@19 293 `PREFIX/etc/config.site' if it exists. Or, you can set the
Chris@19 294 `CONFIG_SITE' environment variable to the location of the site script.
Chris@19 295 A warning: not all `configure' scripts look for a site script.
Chris@19 296
Chris@19 297 Defining Variables
Chris@19 298 ==================
Chris@19 299
Chris@19 300 Variables not defined in a site shell script can be set in the
Chris@19 301 environment passed to `configure'. However, some packages may run
Chris@19 302 configure again during the build, and the customized values of these
Chris@19 303 variables may be lost. In order to avoid this problem, you should set
Chris@19 304 them in the `configure' command line, using `VAR=value'. For example:
Chris@19 305
Chris@19 306 ./configure CC=/usr/local2/bin/gcc
Chris@19 307
Chris@19 308 causes the specified `gcc' to be used as the C compiler (unless it is
Chris@19 309 overridden in the site shell script).
Chris@19 310
Chris@19 311 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
Chris@19 312 an Autoconf limitation. Until the limitation is lifted, you can use
Chris@19 313 this workaround:
Chris@19 314
Chris@19 315 CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash
Chris@19 316
Chris@19 317 `configure' Invocation
Chris@19 318 ======================
Chris@19 319
Chris@19 320 `configure' recognizes the following options to control how it
Chris@19 321 operates.
Chris@19 322
Chris@19 323 `--help'
Chris@19 324 `-h'
Chris@19 325 Print a summary of all of the options to `configure', and exit.
Chris@19 326
Chris@19 327 `--help=short'
Chris@19 328 `--help=recursive'
Chris@19 329 Print a summary of the options unique to this package's
Chris@19 330 `configure', and exit. The `short' variant lists options used
Chris@19 331 only in the top level, while the `recursive' variant lists options
Chris@19 332 also present in any nested packages.
Chris@19 333
Chris@19 334 `--version'
Chris@19 335 `-V'
Chris@19 336 Print the version of Autoconf used to generate the `configure'
Chris@19 337 script, and exit.
Chris@19 338
Chris@19 339 `--cache-file=FILE'
Chris@19 340 Enable the cache: use and save the results of the tests in FILE,
Chris@19 341 traditionally `config.cache'. FILE defaults to `/dev/null' to
Chris@19 342 disable caching.
Chris@19 343
Chris@19 344 `--config-cache'
Chris@19 345 `-C'
Chris@19 346 Alias for `--cache-file=config.cache'.
Chris@19 347
Chris@19 348 `--quiet'
Chris@19 349 `--silent'
Chris@19 350 `-q'
Chris@19 351 Do not print messages saying which checks are being made. To
Chris@19 352 suppress all normal output, redirect it to `/dev/null' (any error
Chris@19 353 messages will still be shown).
Chris@19 354
Chris@19 355 `--srcdir=DIR'
Chris@19 356 Look for the package's source code in directory DIR. Usually
Chris@19 357 `configure' can determine that directory automatically.
Chris@19 358
Chris@19 359 `--prefix=DIR'
Chris@19 360 Use DIR as the installation prefix. *note Installation Names::
Chris@19 361 for more details, including other options available for fine-tuning
Chris@19 362 the installation locations.
Chris@19 363
Chris@19 364 `--no-create'
Chris@19 365 `-n'
Chris@19 366 Run the configure checks, but stop before creating any output
Chris@19 367 files.
Chris@19 368
Chris@19 369 `configure' also accepts some other, not widely useful, options. Run
Chris@19 370 `configure --help' for more details.