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