gst-gmyth/INSTALL
author renatofilho
Tue May 01 16:31:26 2007 +0100 (2007-05-01)
branchtrunk
changeset 609 4aac30345986
child 611 aa1f309ec686
permissions -rw-r--r--
[svn r615] added concat element
renatofilho@608
     1
Basic Installation
renatofilho@608
     2
==================
renatofilho@608
     3
renatofilho@608
     4
   These are generic installation instructions.
renatofilho@608
     5
renatofilho@608
     6
   The `configure' shell script attempts to guess correct values for
renatofilho@608
     7
various system-dependent variables used during compilation.  It uses
renatofilho@608
     8
those values to create a `Makefile' in each directory of the package.
renatofilho@608
     9
It may also create one or more `.h' files containing system-dependent
renatofilho@608
    10
definitions.  Finally, it creates a shell script `config.status' that
renatofilho@608
    11
you can run in the future to recreate the current configuration, a file
renatofilho@608
    12
`config.cache' that saves the results of its tests to speed up
renatofilho@608
    13
reconfiguring, and a file `config.log' containing compiler output
renatofilho@608
    14
(useful mainly for debugging `configure').
renatofilho@608
    15
renatofilho@608
    16
   If you need to do unusual things to compile the package, please try
renatofilho@608
    17
to figure out how `configure' could check whether to do them, and mail
renatofilho@608
    18
diffs or instructions to the address given in the `README' so they can
renatofilho@608
    19
be considered for the next release.  If at some point `config.cache'
renatofilho@608
    20
contains results you don't want to keep, you may remove or edit it.
renatofilho@608
    21
renatofilho@608
    22
   The file `configure.in' is used to create `configure' by a program
renatofilho@608
    23
called `autoconf'.  You only need `configure.in' if you want to change
renatofilho@608
    24
it or regenerate `configure' using a newer version of `autoconf'.
renatofilho@608
    25
renatofilho@608
    26
The simplest way to compile this package is:
renatofilho@608
    27
renatofilho@608
    28
  1. `cd' to the directory containing the package's source code and type
renatofilho@608
    29
     `./configure' to configure the package for your system.  If you're
renatofilho@608
    30
     using `csh' on an old version of System V, you might need to type
renatofilho@608
    31
     `sh ./configure' instead to prevent `csh' from trying to execute
renatofilho@608
    32
     `configure' itself.
renatofilho@608
    33
renatofilho@608
    34
     Running `configure' takes awhile.  While running, it prints some
renatofilho@608
    35
     messages telling which features it is checking for.
renatofilho@608
    36
renatofilho@608
    37
  2. Type `make' to compile the package.
renatofilho@608
    38
renatofilho@608
    39
  3. Optionally, type `make check' to run any self-tests that come with
renatofilho@608
    40
     the package.
renatofilho@608
    41
renatofilho@608
    42
  4. Type `make install' to install the programs and any data files and
renatofilho@608
    43
     documentation.
renatofilho@608
    44
renatofilho@608
    45
  5. You can remove the program binaries and object files from the
renatofilho@608
    46
     source code directory by typing `make clean'.  To also remove the
renatofilho@608
    47
     files that `configure' created (so you can compile the package for
renatofilho@608
    48
     a different kind of computer), type `make distclean'.  There is
renatofilho@608
    49
     also a `make maintainer-clean' target, but that is intended mainly
renatofilho@608
    50
     for the package's developers.  If you use it, you may have to get
renatofilho@608
    51
     all sorts of other programs in order to regenerate files that came
renatofilho@608
    52
     with the distribution.
renatofilho@608
    53
renatofilho@608
    54
Compilers and Options
renatofilho@608
    55
=====================
renatofilho@608
    56
renatofilho@608
    57
   Some systems require unusual options for compilation or linking that
renatofilho@608
    58
the `configure' script does not know about.  You can give `configure'
renatofilho@608
    59
initial values for variables by setting them in the environment.  Using
renatofilho@608
    60
a Bourne-compatible shell, you can do that on the command line like
renatofilho@608
    61
this:
renatofilho@608
    62
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
renatofilho@608
    63
renatofilho@608
    64
Or on systems that have the `env' program, you can do it like this:
renatofilho@608
    65
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
renatofilho@608
    66
renatofilho@608
    67
Compiling For Multiple Architectures
renatofilho@608
    68
====================================
renatofilho@608
    69
renatofilho@608
    70
   You can compile the package for more than one kind of computer at the
renatofilho@608
    71
same time, by placing the object files for each architecture in their
renatofilho@608
    72
own directory.  To do this, you must use a version of `make' that
renatofilho@608
    73
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
renatofilho@608
    74
directory where you want the object files and executables to go and run
renatofilho@608
    75
the `configure' script.  `configure' automatically checks for the
renatofilho@608
    76
source code in the directory that `configure' is in and in `..'.
renatofilho@608
    77
renatofilho@608
    78
   If you have to use a `make' that does not supports the `VPATH'
renatofilho@608
    79
variable, you have to compile the package for one architecture at a time
renatofilho@608
    80
in the source code directory.  After you have installed the package for
renatofilho@608
    81
one architecture, use `make distclean' before reconfiguring for another
renatofilho@608
    82
architecture.
renatofilho@608
    83
renatofilho@608
    84
Installation Names
renatofilho@608
    85
==================
renatofilho@608
    86
renatofilho@608
    87
   By default, `make install' will install the package's files in
renatofilho@608
    88
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
renatofilho@608
    89
installation prefix other than `/usr/local' by giving `configure' the
renatofilho@608
    90
option `--prefix=PATH'.
renatofilho@608
    91
renatofilho@608
    92
   You can specify separate installation prefixes for
renatofilho@608
    93
architecture-specific files and architecture-independent files.  If you
renatofilho@608
    94
give `configure' the option `--exec-prefix=PATH', the package will use
renatofilho@608
    95
PATH as the prefix for installing programs and libraries.
renatofilho@608
    96
Documentation and other data files will still use the regular prefix.
renatofilho@608
    97
renatofilho@608
    98
   In addition, if you use an unusual directory layout you can give
renatofilho@608
    99
options like `--bindir=PATH' to specify different values for particular
renatofilho@608
   100
kinds of files.  Run `configure --help' for a list of the directories
renatofilho@608
   101
you can set and what kinds of files go in them.
renatofilho@608
   102
renatofilho@608
   103
   If the package supports it, you can cause programs to be installed
renatofilho@608
   104
with an extra prefix or suffix on their names by giving `configure' the
renatofilho@608
   105
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
renatofilho@608
   106
renatofilho@608
   107
Optional Features
renatofilho@608
   108
=================
renatofilho@608
   109
renatofilho@608
   110
   Some packages pay attention to `--enable-FEATURE' options to
renatofilho@608
   111
`configure', where FEATURE indicates an optional part of the package.
renatofilho@608
   112
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
renatofilho@608
   113
is something like `gnu-as' or `x' (for the X Window System).  The
renatofilho@608
   114
`README' should mention any `--enable-' and `--with-' options that the
renatofilho@608
   115
package recognizes.
renatofilho@608
   116
renatofilho@608
   117
   For packages that use the X Window System, `configure' can usually
renatofilho@608
   118
find the X include and library files automatically, but if it doesn't,
renatofilho@608
   119
you can use the `configure' options `--x-includes=DIR' and
renatofilho@608
   120
`--x-libraries=DIR' to specify their locations.
renatofilho@608
   121
renatofilho@608
   122
Specifying the System Type
renatofilho@608
   123
==========================
renatofilho@608
   124
renatofilho@608
   125
   There may be some features `configure' can not figure out
renatofilho@608
   126
automatically, but needs to determine by the type of host the package
renatofilho@608
   127
will run on.  Usually `configure' can figure that out, but if it prints
renatofilho@608
   128
a message saying it can not guess the host type, give it the
renatofilho@608
   129
`--host=TYPE' option.  TYPE can either be a short name for the system
renatofilho@608
   130
type, such as `sun4', or a canonical name with three fields:
renatofilho@608
   131
     CPU-COMPANY-SYSTEM
renatofilho@608
   132
renatofilho@608
   133
See the file `config.sub' for the possible values of each field.  If
renatofilho@608
   134
`config.sub' isn't included in this package, then this package doesn't
renatofilho@608
   135
need to know the host type.
renatofilho@608
   136
renatofilho@608
   137
   If you are building compiler tools for cross-compiling, you can also
renatofilho@608
   138
use the `--target=TYPE' option to select the type of system they will
renatofilho@608
   139
produce code for and the `--build=TYPE' option to select the type of
renatofilho@608
   140
system on which you are compiling the package.
renatofilho@608
   141
renatofilho@608
   142
Sharing Defaults
renatofilho@608
   143
================
renatofilho@608
   144
renatofilho@608
   145
   If you want to set default values for `configure' scripts to share,
renatofilho@608
   146
you can create a site shell script called `config.site' that gives
renatofilho@608
   147
default values for variables like `CC', `cache_file', and `prefix'.
renatofilho@608
   148
`configure' looks for `PREFIX/share/config.site' if it exists, then
renatofilho@608
   149
`PREFIX/etc/config.site' if it exists.  Or, you can set the
renatofilho@608
   150
`CONFIG_SITE' environment variable to the location of the site script.
renatofilho@608
   151
A warning: not all `configure' scripts look for a site script.
renatofilho@608
   152
renatofilho@608
   153
Operation Controls
renatofilho@608
   154
==================
renatofilho@608
   155
renatofilho@608
   156
   `configure' recognizes the following options to control how it
renatofilho@608
   157
operates.
renatofilho@608
   158
renatofilho@608
   159
`--cache-file=FILE'
renatofilho@608
   160
     Use and save the results of the tests in FILE instead of
renatofilho@608
   161
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
renatofilho@608
   162
     debugging `configure'.
renatofilho@608
   163
renatofilho@608
   164
`--help'
renatofilho@608
   165
     Print a summary of the options to `configure', and exit.
renatofilho@608
   166
renatofilho@608
   167
`--quiet'
renatofilho@608
   168
`--silent'
renatofilho@608
   169
`-q'
renatofilho@608
   170
     Do not print messages saying which checks are being made.  To
renatofilho@608
   171
     suppress all normal output, redirect it to `/dev/null' (any error
renatofilho@608
   172
     messages will still be shown).
renatofilho@608
   173
renatofilho@608
   174
`--srcdir=DIR'
renatofilho@608
   175
     Look for the package's source code in directory DIR.  Usually
renatofilho@608
   176
     `configure' can determine that directory automatically.
renatofilho@608
   177
renatofilho@608
   178
`--version'
renatofilho@608
   179
     Print the version of Autoconf used to generate the `configure'
renatofilho@608
   180
     script, and exit.
renatofilho@608
   181
renatofilho@608
   182
`configure' also accepts some other, not widely useful, options.