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