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