annotate src/libsndfile-1.0.25/INSTALL @ 23:619f715526df sv_v2.1

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