INSTALL

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