1
=======================================================================
2
*** Ecasound - INSTALL ***
3
=======================================================================
5
The `configure' shell script attempts to guess correct values for
6
various system-dependent variables used during compilation. It uses
7
those values to create a `Makefile' in each directory of the package.
8
It also creates the file `config.h' in the top-level source directory.
9
This file contains system-dependent definitions. Finally, it creates
10
a shell script `config.status' that you can run in the future to
11
recreate the current configuration, a file `config.cache' that saves
12
the results of its tests to speed up reconfiguring, and a file
13
`config.log' containing compiler output (useful mainly for debugging
16
If you need to do unusual things to compile the package, please try
17
to figure out how `configure' could check whether to do them, and mail
18
diffs or instructions to the address given in the `README' so they can
19
be considered for the next release. If at some point `config.cache'
20
contains results you don't want to keep, you may remove or edit it.
22
The file `configure.in' is used to create `configure' by a program
23
called `autoconf'. You only need `configure.in' if you want to change
24
it or regenerate `configure' using a newer version of `autoconf'.
26
The simplest way to compile this package is:
28
1. `cd' to the directory containing the package's source code and type
29
`./configure' to configure the package for your system. If you're
30
using `csh' on an old version of System V, you might need to type
31
`sh ./configure' instead to prevent `csh' from trying to execute
34
Running `configure' takes awhile. While running, it prints some
35
messages telling which features it is checking for.
37
2. Type `make' to compile the package.
39
3. Type `make install' to install the programs and any data files and
42
4. If you have not specified an alternative install prefix with --prefix
43
option, make sure that you have `/usr/local/lib� in your
44
`/etc/ld.so.conf' and then run `/sbin/ldconfig� (as root).
46
5. You can remove the program binaries and object files from the
47
source code directory by typing `make clean'. To also remove the
48
files that `configure' created (so you can compile the package for
49
a different kind of computer), type `make distclean'. There is
50
also a `make maintainer-clean' target, but that is intended mainly
51
for the package's developers. If you use it, you may have to get
52
all sorts of other programs in order to regenerate files that came
53
with the distribution.
55
Ecasound specific options
56
=========================
59
Build static binaries that are not linked against any
60
shared libraries. Disabled by default. Note! This is
61
an experimental option and may not work in all
65
Disables optimizations and other things preventing
66
efficient debugging. Created executables and libraries
67
have a "_debug" suffix. Disabled by default.
69
`--enable-experimental'
70
Turns on some suspicious features. Not recommended.
73
`--enable-python-force-site-packages'
74
Force install of python modules into site-packages
75
directory even when it doesn't exist. Disabled by
78
`--enable-sys-readline'
79
If installed, link to system's default libreadline.
83
Don't compile support for ALSA-drivers (otherwise
84
links to libasound). By default ALSA support is
85
enabled if all the necessary header and library
89
Don't compile aRts client support. See http://www.arts-project.org
90
for more info about aRts. By default aRts support is
91
enabled if all the necessary header and library
95
Don't link to libaudiofile. By default libaudiofile support is
96
enabled if all the necessary header and library
100
Don't check design-by-contract assertions. Enabled by default.
103
Build ecasound without effect and controller components.
107
Don't compile JACK client support. See
108
http://jackit.sf.net for more info about JACK.
109
By default JACK support is enabled if all the
110
necessary header and library files are found.
112
`--disable-libsamplerate'
113
Don't compile libsamplerate support. See
114
http://www.mega-nerd.com/SRC for more info about
115
libsamplerate. By default libsamplerate support is
116
enabled if all the necessary header and library files
120
Don't link against ncurses (known bug: even if this is
121
specified, you're still required to have a working
122
ncurses/termcap installation to compile). Enabled
126
Don't compile support for OSS-drivers. Enabled by
129
`--disable-osstrigger'
130
Disable the use of OSS trigger functions. Enabled
134
Don't link to libsndfile. By default libsndfile support is
135
enabled if all the necessary header and library
138
`--with-jack=JACK_PREFIX'
139
Enable JACK support and compile against JACK installed
142
`--with-libsamplerate=LIBSAMPLERATE_PREFIX'
143
Enable libsamplerate support and compile against libsamplerate
144
installed in 'LIBSAMPLERATE_PREFIX'.
147
Compile with support for large files (>2GB). Disabled
150
`--enable-pyecasound={c,python,none}'
151
Enable pyecasound and select which implementation to use.
152
Default value based on target platform.
154
`--with-python-includes=DIR'
155
Python include files are located in 'DIR'.
157
`--with-python-modules=DIR'
158
Python modules should be installed to 'DIR'.
160
`--enable-rubyecasound={yes,no}'
161
Enable rubyecasound. Defaults to yes if Ruby interpreter
162
is found on the system.
165
Supported automake/autoconf features
166
====================================
168
Ecasound uses the autotools (automake, automake and libtool)
169
build system framework. Standard practises (see below for
170
references) are followed where applicable.
172
Some features offered by the autotools do not work without
173
explicit support from the package. Following is a short list of
174
features that Ecasound _does_ support. If you encounter any
175
problems in using these features with Ecasound, please report
178
1. Building Ecasound in a directory separate from the source
180
Example: "mkdir objdir ; cd objdir ; ../configure ; make"
182
2. 'uninstall' make target
183
You should be able to uninstall Ecasound by running "make uninstall".
184
Note that if you override any make variable when running "make install",
185
you should specify the same variables also when running "make uninstall".
186
Reference: Automake manual (see below)
188
3. 'DESTDIR' make variable for staging installs
189
Reference: http://sources.redhat.com/automake/automake.html#Install
191
4. 'prefix', 'datadir', pkgdatadir' make variables
192
You should be able to override any of the make variables
193
on the make command-line. But remember to always override
194
the same variables when you switch between make targets (see
196
Example: make prefix=/tmp/ecasound-foobar install
198
5. Overriding CPPFLAGS, CFLAGS, CXXFLAGS, etc variables.
199
It is possible to override these parameters both before
200
running the configure script (specify new values as
201
environment variables), or at make time (specify new
202
values on the make command-line). Note that these
203
mechanisms are exclusive to each other.
208
http://sources.redhat.com/automake/automake.html
211
http://www.gnu.org/software/autoconf/manual/
213
o GNU Coding Standards
214
http://www.gnu.org/prep/standards/
217
Specifying the System Type
218
==========================
220
There may be some features `configure' can not figure out
221
automatically, but needs to determine by the type of host the package
222
will run on. Usually `configure' can figure that out, but if it prints
223
a message saying it can not guess the host type, give it the
224
`--host=TYPE' option. TYPE can either be a short name for the system
225
type, such as `sun4', or a canonical name with three fields:
228
See the file `config.sub' for the possible values of each field. If
229
`config.sub' isn't included in this package, then this package doesn't
230
need to know the host type.
232
If you are building compiler tools for cross-compiling, you can also
233
use the `--target=TYPE' option to select the type of system they will
234
produce code for and the `--build=TYPE' option to select the type of
235
system on which you are compiling the package.
240
`configure' recognizes the following options to control how it
244
Use and save the results of the tests in FILE instead of
245
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
246
debugging `configure'.
249
Print a summary of the options to `configure', and exit.
254
Do not print messages saying which checks are being made. To
255
suppress all normal output, redirect it to `/dev/null' (any error
256
messages will still be shown).
259
Look for the package's source code in directory DIR. Usually
260
`configure' can determine that directory automatically.
263
Print the version of Autoconf used to generate the `configure'
266
`configure' also accepts some other, not widely useful, options.