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