INSTALL

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