1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mythtv_plugin/INSTALL Wed Sep 20 23:59:48 2006 +0100
1.3 @@ -0,0 +1,182 @@
1.4 +Basic Installation
1.5 +==================
1.6 +
1.7 + These are generic installation instructions.
1.8 +
1.9 + The `configure' shell script attempts to guess correct values for
1.10 +various system-dependent variables used during compilation. It uses
1.11 +those values to create a `Makefile' in each directory of the package.
1.12 +It may also create one or more `.h' files containing system-dependent
1.13 +definitions. Finally, it creates a shell script `config.status' that
1.14 +you can run in the future to recreate the current configuration, a file
1.15 +`config.cache' that saves the results of its tests to speed up
1.16 +reconfiguring, and a file `config.log' containing compiler output
1.17 +(useful mainly for debugging `configure').
1.18 +
1.19 + If you need to do unusual things to compile the package, please try
1.20 +to figure out how `configure' could check whether to do them, and mail
1.21 +diffs or instructions to the address given in the `README' so they can
1.22 +be considered for the next release. If at some point `config.cache'
1.23 +contains results you don't want to keep, you may remove or edit it.
1.24 +
1.25 + The file `configure.in' is used to create `configure' by a program
1.26 +called `autoconf'. You only need `configure.in' if you want to change
1.27 +it or regenerate `configure' using a newer version of `autoconf'.
1.28 +
1.29 +The simplest way to compile this package is:
1.30 +
1.31 + 1. `cd' to the directory containing the package's source code and type
1.32 + `./configure' to configure the package for your system. If you're
1.33 + using `csh' on an old version of System V, you might need to type
1.34 + `sh ./configure' instead to prevent `csh' from trying to execute
1.35 + `configure' itself.
1.36 +
1.37 + Running `configure' takes awhile. While running, it prints some
1.38 + messages telling which features it is checking for.
1.39 +
1.40 + 2. Type `make' to compile the package.
1.41 +
1.42 + 3. Optionally, type `make check' to run any self-tests that come with
1.43 + the package.
1.44 +
1.45 + 4. Type `make install' to install the programs and any data files and
1.46 + documentation.
1.47 +
1.48 + 5. You can remove the program binaries and object files from the
1.49 + source code directory by typing `make clean'. To also remove the
1.50 + files that `configure' created (so you can compile the package for
1.51 + a different kind of computer), type `make distclean'. There is
1.52 + also a `make maintainer-clean' target, but that is intended mainly
1.53 + for the package's developers. If you use it, you may have to get
1.54 + all sorts of other programs in order to regenerate files that came
1.55 + with the distribution.
1.56 +
1.57 +Compilers and Options
1.58 +=====================
1.59 +
1.60 + Some systems require unusual options for compilation or linking that
1.61 +the `configure' script does not know about. You can give `configure'
1.62 +initial values for variables by setting them in the environment. Using
1.63 +a Bourne-compatible shell, you can do that on the command line like
1.64 +this:
1.65 + CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
1.66 +
1.67 +Or on systems that have the `env' program, you can do it like this:
1.68 + env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
1.69 +
1.70 +Compiling For Multiple Architectures
1.71 +====================================
1.72 +
1.73 + You can compile the package for more than one kind of computer at the
1.74 +same time, by placing the object files for each architecture in their
1.75 +own directory. To do this, you must use a version of `make' that
1.76 +supports the `VPATH' variable, such as GNU `make'. `cd' to the
1.77 +directory where you want the object files and executables to go and run
1.78 +the `configure' script. `configure' automatically checks for the
1.79 +source code in the directory that `configure' is in and in `..'.
1.80 +
1.81 + If you have to use a `make' that does not supports the `VPATH'
1.82 +variable, you have to compile the package for one architecture at a time
1.83 +in the source code directory. After you have installed the package for
1.84 +one architecture, use `make distclean' before reconfiguring for another
1.85 +architecture.
1.86 +
1.87 +Installation Names
1.88 +==================
1.89 +
1.90 + By default, `make install' will install the package's files in
1.91 +`/usr/local/bin', `/usr/local/man', etc. You can specify an
1.92 +installation prefix other than `/usr/local' by giving `configure' the
1.93 +option `--prefix=PATH'.
1.94 +
1.95 + You can specify separate installation prefixes for
1.96 +architecture-specific files and architecture-independent files. If you
1.97 +give `configure' the option `--exec-prefix=PATH', the package will use
1.98 +PATH as the prefix for installing programs and libraries.
1.99 +Documentation and other data files will still use the regular prefix.
1.100 +
1.101 + In addition, if you use an unusual directory layout you can give
1.102 +options like `--bindir=PATH' to specify different values for particular
1.103 +kinds of files. Run `configure --help' for a list of the directories
1.104 +you can set and what kinds of files go in them.
1.105 +
1.106 + If the package supports it, you can cause programs to be installed
1.107 +with an extra prefix or suffix on their names by giving `configure' the
1.108 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
1.109 +
1.110 +Optional Features
1.111 +=================
1.112 +
1.113 + Some packages pay attention to `--enable-FEATURE' options to
1.114 +`configure', where FEATURE indicates an optional part of the package.
1.115 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE
1.116 +is something like `gnu-as' or `x' (for the X Window System). The
1.117 +`README' should mention any `--enable-' and `--with-' options that the
1.118 +package recognizes.
1.119 +
1.120 + For packages that use the X Window System, `configure' can usually
1.121 +find the X include and library files automatically, but if it doesn't,
1.122 +you can use the `configure' options `--x-includes=DIR' and
1.123 +`--x-libraries=DIR' to specify their locations.
1.124 +
1.125 +Specifying the System Type
1.126 +==========================
1.127 +
1.128 + There may be some features `configure' can not figure out
1.129 +automatically, but needs to determine by the type of host the package
1.130 +will run on. Usually `configure' can figure that out, but if it prints
1.131 +a message saying it can not guess the host type, give it the
1.132 +`--host=TYPE' option. TYPE can either be a short name for the system
1.133 +type, such as `sun4', or a canonical name with three fields:
1.134 + CPU-COMPANY-SYSTEM
1.135 +
1.136 +See the file `config.sub' for the possible values of each field. If
1.137 +`config.sub' isn't included in this package, then this package doesn't
1.138 +need to know the host type.
1.139 +
1.140 + If you are building compiler tools for cross-compiling, you can also
1.141 +use the `--target=TYPE' option to select the type of system they will
1.142 +produce code for and the `--build=TYPE' option to select the type of
1.143 +system on which you are compiling the package.
1.144 +
1.145 +Sharing Defaults
1.146 +================
1.147 +
1.148 + If you want to set default values for `configure' scripts to share,
1.149 +you can create a site shell script called `config.site' that gives
1.150 +default values for variables like `CC', `cache_file', and `prefix'.
1.151 +`configure' looks for `PREFIX/share/config.site' if it exists, then
1.152 +`PREFIX/etc/config.site' if it exists. Or, you can set the
1.153 +`CONFIG_SITE' environment variable to the location of the site script.
1.154 +A warning: not all `configure' scripts look for a site script.
1.155 +
1.156 +Operation Controls
1.157 +==================
1.158 +
1.159 + `configure' recognizes the following options to control how it
1.160 +operates.
1.161 +
1.162 +`--cache-file=FILE'
1.163 + Use and save the results of the tests in FILE instead of
1.164 + `./config.cache'. Set FILE to `/dev/null' to disable caching, for
1.165 + debugging `configure'.
1.166 +
1.167 +`--help'
1.168 + Print a summary of the options to `configure', and exit.
1.169 +
1.170 +`--quiet'
1.171 +`--silent'
1.172 +`-q'
1.173 + Do not print messages saying which checks are being made. To
1.174 + suppress all normal output, redirect it to `/dev/null' (any error
1.175 + messages will still be shown).
1.176 +
1.177 +`--srcdir=DIR'
1.178 + Look for the package's source code in directory DIR. Usually
1.179 + `configure' can determine that directory automatically.
1.180 +
1.181 +`--version'
1.182 + Print the version of Autoconf used to generate the `configure'
1.183 + script, and exit.
1.184 +
1.185 +`configure' also accepts some other, not widely useful, options.