Mercurial > hg > sv-dependency-builds

annotate src/portaudio/bindings/cpp/INSTALL @ 105:c83a7e2af39c

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