annotate src/portaudio_20161030_catalina_patch/bindings/cpp/INSTALL @ 83:ae30d91d2ffe

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