INSTALL

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