gst-gmyth/INSTALL
branchtrunk
changeset 611 aa1f309ec686
parent 608 43ce4ea2f9fb
child 709 532370b91652
     1.1 --- a/gst-gmyth/INSTALL	Tue May 01 16:04:02 2007 +0100
     1.2 +++ b/gst-gmyth/INSTALL	Tue May 01 17:03:38 2007 +0100
     1.3 @@ -1,27 +1,43 @@
     1.4 +Installation Instructions
     1.5 +*************************
     1.6 +
     1.7 +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
     1.8 +Software Foundation, Inc.
     1.9 +
    1.10 +This file is free documentation; the Free Software Foundation gives
    1.11 +unlimited permission to copy, distribute and modify it.
    1.12 +
    1.13  Basic Installation
    1.14  ==================
    1.15  
    1.16 -   These are generic installation instructions.
    1.17 +These are generic installation instructions.
    1.18  
    1.19     The `configure' shell script attempts to guess correct values for
    1.20  various system-dependent variables used during compilation.  It uses
    1.21  those values to create a `Makefile' in each directory of the package.
    1.22  It may also create one or more `.h' files containing system-dependent
    1.23  definitions.  Finally, it creates a shell script `config.status' that
    1.24 -you can run in the future to recreate the current configuration, a file
    1.25 -`config.cache' that saves the results of its tests to speed up
    1.26 -reconfiguring, and a file `config.log' containing compiler output
    1.27 -(useful mainly for debugging `configure').
    1.28 +you can run in the future to recreate the current configuration, and a
    1.29 +file `config.log' containing compiler output (useful mainly for
    1.30 +debugging `configure').
    1.31 +
    1.32 +   It can also use an optional file (typically called `config.cache'
    1.33 +and enabled with `--cache-file=config.cache' or simply `-C') that saves
    1.34 +the results of its tests to speed up reconfiguring.  (Caching is
    1.35 +disabled by default to prevent problems with accidental use of stale
    1.36 +cache files.)
    1.37  
    1.38     If you need to do unusual things to compile the package, please try
    1.39  to figure out how `configure' could check whether to do them, and mail
    1.40  diffs or instructions to the address given in the `README' so they can
    1.41 -be considered for the next release.  If at some point `config.cache'
    1.42 -contains results you don't want to keep, you may remove or edit it.
    1.43 +be considered for the next release.  If you are using the cache, and at
    1.44 +some point `config.cache' contains results you don't want to keep, you
    1.45 +may remove or edit it.
    1.46  
    1.47 -   The file `configure.in' is used to create `configure' by a program
    1.48 -called `autoconf'.  You only need `configure.in' if you want to change
    1.49 -it or regenerate `configure' using a newer version of `autoconf'.
    1.50 +   The file `configure.ac' (or `configure.in') is used to create
    1.51 +`configure' by a program called `autoconf'.  You only need
    1.52 +`configure.ac' if you want to change it or regenerate `configure' using
    1.53 +a newer version of `autoconf'.
    1.54  
    1.55  The simplest way to compile this package is:
    1.56  
    1.57 @@ -54,20 +70,22 @@
    1.58  Compilers and Options
    1.59  =====================
    1.60  
    1.61 -   Some systems require unusual options for compilation or linking that
    1.62 -the `configure' script does not know about.  You can give `configure'
    1.63 -initial values for variables by setting them in the environment.  Using
    1.64 -a Bourne-compatible shell, you can do that on the command line like
    1.65 -this:
    1.66 -     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
    1.67 +Some systems require unusual options for compilation or linking that the
    1.68 +`configure' script does not know about.  Run `./configure --help' for
    1.69 +details on some of the pertinent environment variables.
    1.70  
    1.71 -Or on systems that have the `env' program, you can do it like this:
    1.72 -     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
    1.73 +   You can give `configure' initial values for configuration parameters
    1.74 +by setting variables in the command line or in the environment.  Here
    1.75 +is an example:
    1.76 +
    1.77 +     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
    1.78 +
    1.79 +   *Note Defining Variables::, for more details.
    1.80  
    1.81  Compiling For Multiple Architectures
    1.82  ====================================
    1.83  
    1.84 -   You can compile the package for more than one kind of computer at the
    1.85 +You can compile the package for more than one kind of computer at the
    1.86  same time, by placing the object files for each architecture in their
    1.87  own directory.  To do this, you must use a version of `make' that
    1.88  supports the `VPATH' variable, such as GNU `make'.  `cd' to the
    1.89 @@ -75,28 +93,28 @@
    1.90  the `configure' script.  `configure' automatically checks for the
    1.91  source code in the directory that `configure' is in and in `..'.
    1.92  
    1.93 -   If you have to use a `make' that does not supports the `VPATH'
    1.94 -variable, you have to compile the package for one architecture at a time
    1.95 -in the source code directory.  After you have installed the package for
    1.96 -one architecture, use `make distclean' before reconfiguring for another
    1.97 -architecture.
    1.98 +   If you have to use a `make' that does not support the `VPATH'
    1.99 +variable, you have to compile the package for one architecture at a
   1.100 +time in the source code directory.  After you have installed the
   1.101 +package for one architecture, use `make distclean' before reconfiguring
   1.102 +for another architecture.
   1.103  
   1.104  Installation Names
   1.105  ==================
   1.106  
   1.107 -   By default, `make install' will install the package's files in
   1.108 -`/usr/local/bin', `/usr/local/man', etc.  You can specify an
   1.109 -installation prefix other than `/usr/local' by giving `configure' the
   1.110 -option `--prefix=PATH'.
   1.111 +By default, `make install' installs the package's commands under
   1.112 +`/usr/local/bin', include files under `/usr/local/include', etc.  You
   1.113 +can specify an installation prefix other than `/usr/local' by giving
   1.114 +`configure' the option `--prefix=PREFIX'.
   1.115  
   1.116     You can specify separate installation prefixes for
   1.117  architecture-specific files and architecture-independent files.  If you
   1.118 -give `configure' the option `--exec-prefix=PATH', the package will use
   1.119 -PATH as the prefix for installing programs and libraries.
   1.120 -Documentation and other data files will still use the regular prefix.
   1.121 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
   1.122 +PREFIX as the prefix for installing programs and libraries.
   1.123 +Documentation and other data files still use the regular prefix.
   1.124  
   1.125     In addition, if you use an unusual directory layout you can give
   1.126 -options like `--bindir=PATH' to specify different values for particular
   1.127 +options like `--bindir=DIR' to specify different values for particular
   1.128  kinds of files.  Run `configure --help' for a list of the directories
   1.129  you can set and what kinds of files go in them.
   1.130  
   1.131 @@ -107,7 +125,7 @@
   1.132  Optional Features
   1.133  =================
   1.134  
   1.135 -   Some packages pay attention to `--enable-FEATURE' options to
   1.136 +Some packages pay attention to `--enable-FEATURE' options to
   1.137  `configure', where FEATURE indicates an optional part of the package.
   1.138  They may also pay attention to `--with-PACKAGE' options, where PACKAGE
   1.139  is something like `gnu-as' or `x' (for the X Window System).  The
   1.140 @@ -122,47 +140,85 @@
   1.141  Specifying the System Type
   1.142  ==========================
   1.143  
   1.144 -   There may be some features `configure' can not figure out
   1.145 -automatically, but needs to determine by the type of host the package
   1.146 -will run on.  Usually `configure' can figure that out, but if it prints
   1.147 -a message saying it can not guess the host type, give it the
   1.148 -`--host=TYPE' option.  TYPE can either be a short name for the system
   1.149 -type, such as `sun4', or a canonical name with three fields:
   1.150 +There may be some features `configure' cannot figure out automatically,
   1.151 +but needs to determine by the type of machine the package will run on.
   1.152 +Usually, assuming the package is built to be run on the _same_
   1.153 +architectures, `configure' can figure that out, but if it prints a
   1.154 +message saying it cannot guess the machine type, give it the
   1.155 +`--build=TYPE' option.  TYPE can either be a short name for the system
   1.156 +type, such as `sun4', or a canonical name which has the form:
   1.157 +
   1.158       CPU-COMPANY-SYSTEM
   1.159  
   1.160 -See the file `config.sub' for the possible values of each field.  If
   1.161 +where SYSTEM can have one of these forms:
   1.162 +
   1.163 +     OS KERNEL-OS
   1.164 +
   1.165 +   See the file `config.sub' for the possible values of each field.  If
   1.166  `config.sub' isn't included in this package, then this package doesn't
   1.167 -need to know the host type.
   1.168 +need to know the machine type.
   1.169  
   1.170 -   If you are building compiler tools for cross-compiling, you can also
   1.171 -use the `--target=TYPE' option to select the type of system they will
   1.172 -produce code for and the `--build=TYPE' option to select the type of
   1.173 -system on which you are compiling the package.
   1.174 +   If you are _building_ compiler tools for cross-compiling, you should
   1.175 +use the option `--target=TYPE' to select the type of system they will
   1.176 +produce code for.
   1.177 +
   1.178 +   If you want to _use_ a cross compiler, that generates code for a
   1.179 +platform different from the build platform, you should specify the
   1.180 +"host" platform (i.e., that on which the generated programs will
   1.181 +eventually be run) with `--host=TYPE'.
   1.182  
   1.183  Sharing Defaults
   1.184  ================
   1.185  
   1.186 -   If you want to set default values for `configure' scripts to share,
   1.187 -you can create a site shell script called `config.site' that gives
   1.188 -default values for variables like `CC', `cache_file', and `prefix'.
   1.189 +If you want to set default values for `configure' scripts to share, you
   1.190 +can create a site shell script called `config.site' that gives default
   1.191 +values for variables like `CC', `cache_file', and `prefix'.
   1.192  `configure' looks for `PREFIX/share/config.site' if it exists, then
   1.193  `PREFIX/etc/config.site' if it exists.  Or, you can set the
   1.194  `CONFIG_SITE' environment variable to the location of the site script.
   1.195  A warning: not all `configure' scripts look for a site script.
   1.196  
   1.197 -Operation Controls
   1.198 +Defining Variables
   1.199  ==================
   1.200  
   1.201 -   `configure' recognizes the following options to control how it
   1.202 -operates.
   1.203 +Variables not defined in a site shell script can be set in the
   1.204 +environment passed to `configure'.  However, some packages may run
   1.205 +configure again during the build, and the customized values of these
   1.206 +variables may be lost.  In order to avoid this problem, you should set
   1.207 +them in the `configure' command line, using `VAR=value'.  For example:
   1.208 +
   1.209 +     ./configure CC=/usr/local2/bin/gcc
   1.210 +
   1.211 +causes the specified `gcc' to be used as the C compiler (unless it is
   1.212 +overridden in the site shell script).  Here is a another example:
   1.213 +
   1.214 +     /bin/bash ./configure CONFIG_SHELL=/bin/bash
   1.215 +
   1.216 +Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
   1.217 +configuration-related scripts to be executed by `/bin/bash'.
   1.218 +
   1.219 +`configure' Invocation
   1.220 +======================
   1.221 +
   1.222 +`configure' recognizes the following options to control how it operates.
   1.223 +
   1.224 +`--help'
   1.225 +`-h'
   1.226 +     Print a summary of the options to `configure', and exit.
   1.227 +
   1.228 +`--version'
   1.229 +`-V'
   1.230 +     Print the version of Autoconf used to generate the `configure'
   1.231 +     script, and exit.
   1.232  
   1.233  `--cache-file=FILE'
   1.234 -     Use and save the results of the tests in FILE instead of
   1.235 -     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
   1.236 -     debugging `configure'.
   1.237 +     Enable the cache: use and save the results of the tests in FILE,
   1.238 +     traditionally `config.cache'.  FILE defaults to `/dev/null' to
   1.239 +     disable caching.
   1.240  
   1.241 -`--help'
   1.242 -     Print a summary of the options to `configure', and exit.
   1.243 +`--config-cache'
   1.244 +`-C'
   1.245 +     Alias for `--cache-file=config.cache'.
   1.246  
   1.247  `--quiet'
   1.248  `--silent'
   1.249 @@ -175,8 +231,6 @@
   1.250       Look for the package's source code in directory DIR.  Usually
   1.251       `configure' can determine that directory automatically.
   1.252  
   1.253 -`--version'
   1.254 -     Print the version of Autoconf used to generate the `configure'
   1.255 -     script, and exit.
   1.256 +`configure' also accepts some other, not widely useful, options.  Run
   1.257 +`configure --help' for more details.
   1.258  
   1.259 -`configure' also accepts some other, not widely useful, options.