INSTALL

   1 Installation Instructions
   2 *************************
   3
   4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
   5 Software Foundation, Inc.
   6 Copyright (C) 2007-2008 Krzysztof Foltman
   7
   8 This file is free documentation; the Free Software Foundation gives
   9 unlimited permission to copy, distribute and modify it.
  10
  11 Prerequisites
  12 =============
  13
  14 To compile and install Calf, you need:
  15
  16 - POSIX-compliant operating system
  17 - G++ version 4.0 or higher (tested with 4.1.3)
  18 - GTK+2 headers and libraries (glib 2.10, gtk+ 2.12)
  19
  20 Optional but recommended:
  21 - JACK header and libraries (tested with 0.109.0)
  22 - LADSPA header
  23 - DSSI header
  24 - LV2 core
  25
  26 Basic Installation
  27 ==================
  28
  29 These are generic installation instructions.
  30
  31    The `configure' shell script attempts to guess correct values for
  32 various system-dependent variables used during compilation.  It uses
  33 those values to create a `Makefile' in each directory of the package.
  34 It may also create one or more `.h' files containing system-dependent
  35 definitions.  Finally, it creates a shell script `config.status' that
  36 you can run in the future to recreate the current configuration, and a
  37 file `config.log' containing compiler output (useful mainly for
  38 debugging `configure').
  39
  40    It can also use an optional file (typically called `config.cache'
  41 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  42 the results of its tests to speed up reconfiguring.  (Caching is
  43 disabled by default to prevent problems with accidental use of stale
  44 cache files.)
  45
  46    If you need to do unusual things to compile the package, please try
  47 to figure out how `configure' could check whether to do them, and mail
  48 diffs or instructions to the address given in the `README' so they can
  49 be considered for the next release.  If you are using the cache, and at
  50 some point `config.cache' contains results you don't want to keep, you
  51 may remove or edit it.
  52
  53    The file `configure.ac' (or `configure.in') is used to create
  54 `configure' by a program called `autoconf'.  You only need
  55 `configure.ac' if you want to change it or regenerate `configure' using
  56 a newer version of `autoconf'.
  57
  58 The simplest way to compile this package is:
  59
  60   1. `cd' to the directory containing the package's source code and type
  61      `./configure' to configure the package for your system.  If you're
  62      using `csh' on an old version of System V, you might need to type
  63      `sh ./configure' instead to prevent `csh' from trying to execute
  64      `configure' itself.
  65
  66      Running `configure' takes awhile.  While running, it prints some
  67      messages telling which features it is checking for.
  68
  69   2. Type `make' to compile the package.
  70
  71   3. Optionally, type `make check' to run any self-tests that come with
  72      the package.
  73
  74   4. Type `make install' to install the programs and any data files and
  75      documentation.
  76
  77   5. You can remove the program binaries and object files from the
  78      source code directory by typing `make clean'.  To also remove the
  79      files that `configure' created (so you can compile the package for
  80      a different kind of computer), type `make distclean'.  There is
  81      also a `make maintainer-clean' target, but that is intended mainly
  82      for the package's developers.  If you use it, you may have to get
  83      all sorts of other programs in order to regenerate files that came
  84      with the distribution.
  85
  86 Compilers and Options
  87 =====================
  88
  89 Some systems require unusual options for compilation or linking that the
  90 `configure' script does not know about.  Run `./configure --help' for
  91 details on some of the pertinent environment variables.
  92
  93    You can give `configure' initial values for configuration parameters
  94 by setting variables in the command line or in the environment.  Here
  95 is an example:
  96
  97      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  98
  99    *Note Defining Variables::, for more details.
 100
 101 Compiling For Multiple Architectures
 102 ====================================
 103
 104 You can compile the package for more than one kind of computer at the
 105 same time, by placing the object files for each architecture in their
 106 own directory.  To do this, you must use a version of `make' that
 107 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 108 directory where you want the object files and executables to go and run
 109 the `configure' script.  `configure' automatically checks for the
 110 source code in the directory that `configure' is in and in `..'.
 111
 112    If you have to use a `make' that does not support the `VPATH'
 113 variable, you have to compile the package for one architecture at a
 114 time in the source code directory.  After you have installed the
 115 package for one architecture, use `make distclean' before reconfiguring
 116 for another architecture.
 117
 118 Installation Names
 119 ==================
 120
 121 By default, `make install' installs the package's commands under
 122 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 123 can specify an installation prefix other than `/usr/local' by giving
 124 `configure' the option `--prefix=PREFIX'.
 125
 126    You can specify separate installation prefixes for
 127 architecture-specific files and architecture-independent files.  If you
 128 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 129 PREFIX as the prefix for installing programs and libraries.
 130 Documentation and other data files still use the regular prefix.
 131
 132    In addition, if you use an unusual directory layout you can give
 133 options like `--bindir=DIR' to specify different values for particular
 134 kinds of files.  Run `configure --help' for a list of the directories
 135 you can set and what kinds of files go in them.
 136
 137    If the package supports it, you can cause programs to be installed
 138 with an extra prefix or suffix on their names by giving `configure' the
 139 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 140
 141 Optional Features
 142 =================
 143
 144 Some packages pay attention to `--enable-FEATURE' options to
 145 `configure', where FEATURE indicates an optional part of the package.
 146 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 147 is something like `gnu-as' or `x' (for the X Window System).  The
 148 `README' should mention any `--enable-' and `--with-' options that the
 149 package recognizes.
 150
 151    For packages that use the X Window System, `configure' can usually
 152 find the X include and library files automatically, but if it doesn't,
 153 you can use the `configure' options `--x-includes=DIR' and
 154 `--x-libraries=DIR' to specify their locations.
 155
 156 Specifying the System Type
 157 ==========================
 158
 159 There may be some features `configure' cannot figure out automatically,
 160 but needs to determine by the type of machine the package will run on.
 161 Usually, assuming the package is built to be run on the _same_
 162 architectures, `configure' can figure that out, but if it prints a
 163 message saying it cannot guess the machine type, give it the
 164 `--build=TYPE' option.  TYPE can either be a short name for the system
 165 type, such as `sun4', or a canonical name which has the form:
 166
 167      CPU-COMPANY-SYSTEM
 168
 169 where SYSTEM can have one of these forms:
 170
 171      OS KERNEL-OS
 172
 173    See the file `config.sub' for the possible values of each field.  If
 174 `config.sub' isn't included in this package, then this package doesn't
 175 need to know the machine type.
 176
 177    If you are _building_ compiler tools for cross-compiling, you should
 178 use the option `--target=TYPE' to select the type of system they will
 179 produce code for.
 180
 181    If you want to _use_ a cross compiler, that generates code for a
 182 platform different from the build platform, you should specify the
 183 "host" platform (i.e., that on which the generated programs will
 184 eventually be run) with `--host=TYPE'.
 185
 186 Sharing Defaults
 187 ================
 188
 189 If you want to set default values for `configure' scripts to share, you
 190 can create a site shell script called `config.site' that gives default
 191 values for variables like `CC', `cache_file', and `prefix'.
 192 `configure' looks for `PREFIX/share/config.site' if it exists, then
 193 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 194 `CONFIG_SITE' environment variable to the location of the site script.
 195 A warning: not all `configure' scripts look for a site script.
 196
 197 Defining Variables
 198 ==================
 199
 200 Variables not defined in a site shell script can be set in the
 201 environment passed to `configure'.  However, some packages may run
 202 configure again during the build, and the customized values of these
 203 variables may be lost.  In order to avoid this problem, you should set
 204 them in the `configure' command line, using `VAR=value'.  For example:
 205
 206      ./configure CC=/usr/local2/bin/gcc
 207
 208 causes the specified `gcc' to be used as the C compiler (unless it is
 209 overridden in the site shell script).  Here is a another example:
 210
 211      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 212
 213 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 214 configuration-related scripts to be executed by `/bin/bash'.
 215
 216 `configure' Invocation
 217 ======================
 218
 219 `configure' recognizes the following options to control how it operates.
 220
 221 `--help'
 222 `-h'
 223      Print a summary of the options to `configure', and exit.
 224
 225 `--version'
 226 `-V'
 227      Print the version of Autoconf used to generate the `configure'
 228      script, and exit.
 229
 230 `--cache-file=FILE'
 231      Enable the cache: use and save the results of the tests in FILE,
 232      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 233      disable caching.
 234
 235 `--config-cache'
 236 `-C'
 237      Alias for `--cache-file=config.cache'.
 238
 239 `--quiet'
 240 `--silent'
 241 `-q'
 242      Do not print messages saying which checks are being made.  To
 243      suppress all normal output, redirect it to `/dev/null' (any error
 244      messages will still be shown).
 245
 246 `--srcdir=DIR'
 247      Look for the package's source code in directory DIR.  Usually
 248      `configure' can determine that directory automatically.
 249
 250 `configure' also accepts some other, not widely useful, options.  Run
 251 `configure --help' for more details.
 252