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