Reinstate INSTALL - I need a better way to keep INSTALL from getting destroyed

This commit is contained in:
rocky
2011-11-30 06:09:27 -05:00
parent f5a2c6666f
commit 6183d10207

114
INSTALL
View File

@@ -12,14 +12,13 @@ without warranty of any kind.
Basic Installation Basic Installation
================== ==================
Briefly, the shell commands `./configure; make; make install' should If you are compiling from git sources, see README.develop.
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for Briefly, the shell command:
instructions specific to this package. Some packages provide this ./configure && make && sudo make install
`INSTALL' file but do not implement all of the features documented
below. The lack of an optional feature in a given package is not should configure, build, and install this package. "sudo" may not be
necessarily a bug. More recommendations for GNU packages can be found in situations where "root" access is not needed to install software.
in *note Makefile Conventions: (standards)Makefile Conventions.
The `configure' shell script attempts to guess correct values for The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses various system-dependent variables used during compilation. It uses
@@ -30,23 +29,13 @@ you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for file `config.log' containing compiler output (useful mainly for
debugging `configure'). debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail to figure out how `configure' could check whether to do them, and send
diffs or instructions to the address given in the `README' so they can patches to https://savannah.gnu.org/patch/?group=libcdio
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create The file `configure.ac' is used to create `configure' by a program
`configure' by a program called `autoconf'. You need `configure.ac' if called `autoconf'. You need `configure.ac' if you want to change it
you want to change it or regenerate `configure' using a newer version or regenerate `configure' using a newer version of `autoconf'.
of `autoconf'.
The simplest way to compile this package is: The simplest way to compile this package is:
@@ -56,7 +45,8 @@ of `autoconf'.
Running `configure' might take a while. While running, it prints Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for. some messages telling which features it is checking for.
2. Type `make' to compile the package. 2. Type `make' or `remake' (GNU make with better error reporting,
tracing and a debugger) to compile the package.
3. Optionally, type `make check' to run any self-tests that come with 3. Optionally, type `make check' to run any self-tests that come with
the package, generally using the just-built uninstalled binaries. the package, generally using the just-built uninstalled binaries.
@@ -76,22 +66,23 @@ of `autoconf'.
6. You can remove the program binaries and object files from the 6. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for files that `configure' created (so you can compile the package
a different kind of computer), type `make distclean'. There is for a different kind of computer), type `make distclean'. There
also a `make maintainer-clean' target, but that is intended mainly is also a `make maintainer-clean' target, but that is intended
for the package's developers. If you use it, you may have to get mainly for the package's developers. If you use it, you may have
all sorts of other programs in order to regenerate files that came to get all sorts of other programs listed in README.develop in
with the distribution. order to regenerate files that came with the distribution.
7. Often, you can also type `make uninstall' to remove the installed 7. You can also type `make uninstall' to remove the installed
files again. In practice, not all packages have tested that files again.
uninstallation works correctly, even though it is required by the
GNU Coding Standards.
8. Some packages, particularly those that use Automake, provide `make 8. `make distcheck', which can by used by developers to test that
distcheck', which can by used by developers to test that all other all other targets like `make install' and `make uninstall' work
targets like `make install' and `make uninstall' work correctly. correctly. This target is generally not run by end users.
This target is generally not run by end users.
9. For a list of all targets if you have remake installed, `remake
--tasks' will give a list.
Compilers and Options Compilers and Options
===================== =====================
@@ -108,36 +99,6 @@ is an example:
*Note Defining Variables::, for more details. *Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'. This
is known as a "VPATH" build.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
On MacOS X 10.5 and later systems, you can create libraries and
executables that work on multiple system types--known as "fat" or
"universal" binaries--by specifying multiple `-arch' options to the
compiler but only a single `-arch' option to the preprocessor. Like
this:
./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
CPP="gcc -E" CXXCPP="g++ -E"
This is not guaranteed to produce working output in all cases, you
may have to build one architecture at a time and combine the results
using the `lipo' tool if you have problems.
Installation Names Installation Names
================== ==================
@@ -196,17 +157,12 @@ Optional Features
with an extra prefix or suffix on their names by giving `configure' the with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Some packages pay attention to `--enable-FEATURE' options to Pay attention to `--enable-FEATURE' options to `configure', where
`configure', where FEATURE indicates an optional part of the package. FEATURE indicates an optional part of the package. Also pay attention
They may also pay attention to `--with-PACKAGE' options, where PACKAGE to `--with-PACKAGE' options, where PACKAGE is something like `cddb'
is something like `gnu-as' or `x' (for the X Window System). The (CDDB lookup support) or `vcd-info' (for enabling VCD support). The
`README' should mention any `--enable-' and `--with-' options that the botom of file `README.libcdio' has a list of `--enable-' and `--with-'
package recognizes. options recognized.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Some packages offer the ability to configure how verbose the Some packages offer the ability to configure how verbose the
execution of `make' will be. For these packages, running `./configure execution of `make' will be. For these packages, running `./configure