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