INSTALL

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