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