History

Update INSTALL file to be more specific to libsamplerate.

Erik de Castro Lopo committed 21 years ago

Commit 2b478011 parent 5c58a211 file · +111 −226Browse files

Unified · Split

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

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t