maemo-ui/INSTALL
branchtrunk
changeset 203 a43fed947ec8
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/maemo-ui/INSTALL	Wed Dec 06 13:50:55 2006 +0000
     1.3 @@ -0,0 +1,236 @@
     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 +
    1.18 +   The `configure' shell script attempts to guess correct values for
    1.19 +various system-dependent variables used during compilation.  It uses
    1.20 +those values to create a `Makefile' in each directory of the package.
    1.21 +It may also create one or more `.h' files containing system-dependent
    1.22 +definitions.  Finally, it creates a shell script `config.status' that
    1.23 +you can run in the future to recreate the current configuration, and a
    1.24 +file `config.log' containing compiler output (useful mainly for
    1.25 +debugging `configure').
    1.26 +
    1.27 +   It can also use an optional file (typically called `config.cache'
    1.28 +and enabled with `--cache-file=config.cache' or simply `-C') that saves
    1.29 +the results of its tests to speed up reconfiguring.  (Caching is
    1.30 +disabled by default to prevent problems with accidental use of stale
    1.31 +cache files.)
    1.32 +
    1.33 +   If you need to do unusual things to compile the package, please try
    1.34 +to figure out how `configure' could check whether to do them, and mail
    1.35 +diffs or instructions to the address given in the `README' so they can
    1.36 +be considered for the next release.  If you are using the cache, and at
    1.37 +some point `config.cache' contains results you don't want to keep, you
    1.38 +may remove or edit it.
    1.39 +
    1.40 +   The file `configure.ac' (or `configure.in') is used to create
    1.41 +`configure' by a program called `autoconf'.  You only need
    1.42 +`configure.ac' if you want to change it or regenerate `configure' using
    1.43 +a newer version of `autoconf'.
    1.44 +
    1.45 +The simplest way to compile this package is:
    1.46 +
    1.47 +  1. `cd' to the directory containing the package's source code and type
    1.48 +     `./configure' to configure the package for your system.  If you're
    1.49 +     using `csh' on an old version of System V, you might need to type
    1.50 +     `sh ./configure' instead to prevent `csh' from trying to execute
    1.51 +     `configure' itself.
    1.52 +
    1.53 +     Running `configure' takes awhile.  While running, it prints some
    1.54 +     messages telling which features it is checking for.
    1.55 +
    1.56 +  2. Type `make' to compile the package.
    1.57 +
    1.58 +  3. Optionally, type `make check' to run any self-tests that come with
    1.59 +     the package.
    1.60 +
    1.61 +  4. Type `make install' to install the programs and any data files and
    1.62 +     documentation.
    1.63 +
    1.64 +  5. You can remove the program binaries and object files from the
    1.65 +     source code directory by typing `make clean'.  To also remove the
    1.66 +     files that `configure' created (so you can compile the package for
    1.67 +     a different kind of computer), type `make distclean'.  There is
    1.68 +     also a `make maintainer-clean' target, but that is intended mainly
    1.69 +     for the package's developers.  If you use it, you may have to get
    1.70 +     all sorts of other programs in order to regenerate files that came
    1.71 +     with the distribution.
    1.72 +
    1.73 +Compilers and Options
    1.74 +=====================
    1.75 +
    1.76 +Some systems require unusual options for compilation or linking that the
    1.77 +`configure' script does not know about.  Run `./configure --help' for
    1.78 +details on some of the pertinent environment variables.
    1.79 +
    1.80 +   You can give `configure' initial values for configuration parameters
    1.81 +by setting variables in the command line or in the environment.  Here
    1.82 +is an example:
    1.83 +
    1.84 +     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
    1.85 +
    1.86 +   *Note Defining Variables::, for more details.
    1.87 +
    1.88 +Compiling For Multiple Architectures
    1.89 +====================================
    1.90 +
    1.91 +You can compile the package for more than one kind of computer at the
    1.92 +same time, by placing the object files for each architecture in their
    1.93 +own directory.  To do this, you must use a version of `make' that
    1.94 +supports the `VPATH' variable, such as GNU `make'.  `cd' to the
    1.95 +directory where you want the object files and executables to go and run
    1.96 +the `configure' script.  `configure' automatically checks for the
    1.97 +source code in the directory that `configure' is in and in `..'.
    1.98 +
    1.99 +   If you have to use a `make' that does not support the `VPATH'
   1.100 +variable, you have to compile the package for one architecture at a
   1.101 +time in the source code directory.  After you have installed the
   1.102 +package for one architecture, use `make distclean' before reconfiguring
   1.103 +for another architecture.
   1.104 +
   1.105 +Installation Names
   1.106 +==================
   1.107 +
   1.108 +By default, `make install' installs the package's commands under
   1.109 +`/usr/local/bin', include files under `/usr/local/include', etc.  You
   1.110 +can specify an installation prefix other than `/usr/local' by giving
   1.111 +`configure' the option `--prefix=PREFIX'.
   1.112 +
   1.113 +   You can specify separate installation prefixes for
   1.114 +architecture-specific files and architecture-independent files.  If you
   1.115 +pass the option `--exec-prefix=PREFIX' to `configure', the package uses
   1.116 +PREFIX as the prefix for installing programs and libraries.
   1.117 +Documentation and other data files still use the regular prefix.
   1.118 +
   1.119 +   In addition, if you use an unusual directory layout you can give
   1.120 +options like `--bindir=DIR' to specify different values for particular
   1.121 +kinds of files.  Run `configure --help' for a list of the directories
   1.122 +you can set and what kinds of files go in them.
   1.123 +
   1.124 +   If the package supports it, you can cause programs to be installed
   1.125 +with an extra prefix or suffix on their names by giving `configure' the
   1.126 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
   1.127 +
   1.128 +Optional Features
   1.129 +=================
   1.130 +
   1.131 +Some packages pay attention to `--enable-FEATURE' options to
   1.132 +`configure', where FEATURE indicates an optional part of the package.
   1.133 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE
   1.134 +is something like `gnu-as' or `x' (for the X Window System).  The
   1.135 +`README' should mention any `--enable-' and `--with-' options that the
   1.136 +package recognizes.
   1.137 +
   1.138 +   For packages that use the X Window System, `configure' can usually
   1.139 +find the X include and library files automatically, but if it doesn't,
   1.140 +you can use the `configure' options `--x-includes=DIR' and
   1.141 +`--x-libraries=DIR' to specify their locations.
   1.142 +
   1.143 +Specifying the System Type
   1.144 +==========================
   1.145 +
   1.146 +There may be some features `configure' cannot figure out automatically,
   1.147 +but needs to determine by the type of machine the package will run on.
   1.148 +Usually, assuming the package is built to be run on the _same_
   1.149 +architectures, `configure' can figure that out, but if it prints a
   1.150 +message saying it cannot guess the machine type, give it the
   1.151 +`--build=TYPE' option.  TYPE can either be a short name for the system
   1.152 +type, such as `sun4', or a canonical name which has the form:
   1.153 +
   1.154 +     CPU-COMPANY-SYSTEM
   1.155 +
   1.156 +where SYSTEM can have one of these forms:
   1.157 +
   1.158 +     OS KERNEL-OS
   1.159 +
   1.160 +   See the file `config.sub' for the possible values of each field.  If
   1.161 +`config.sub' isn't included in this package, then this package doesn't
   1.162 +need to know the machine type.
   1.163 +
   1.164 +   If you are _building_ compiler tools for cross-compiling, you should
   1.165 +use the option `--target=TYPE' to select the type of system they will
   1.166 +produce code for.
   1.167 +
   1.168 +   If you want to _use_ a cross compiler, that generates code for a
   1.169 +platform different from the build platform, you should specify the
   1.170 +"host" platform (i.e., that on which the generated programs will
   1.171 +eventually be run) with `--host=TYPE'.
   1.172 +
   1.173 +Sharing Defaults
   1.174 +================
   1.175 +
   1.176 +If you want to set default values for `configure' scripts to share, you
   1.177 +can create a site shell script called `config.site' that gives default
   1.178 +values for variables like `CC', `cache_file', and `prefix'.
   1.179 +`configure' looks for `PREFIX/share/config.site' if it exists, then
   1.180 +`PREFIX/etc/config.site' if it exists.  Or, you can set the
   1.181 +`CONFIG_SITE' environment variable to the location of the site script.
   1.182 +A warning: not all `configure' scripts look for a site script.
   1.183 +
   1.184 +Defining Variables
   1.185 +==================
   1.186 +
   1.187 +Variables not defined in a site shell script can be set in the
   1.188 +environment passed to `configure'.  However, some packages may run
   1.189 +configure again during the build, and the customized values of these
   1.190 +variables may be lost.  In order to avoid this problem, you should set
   1.191 +them in the `configure' command line, using `VAR=value'.  For example:
   1.192 +
   1.193 +     ./configure CC=/usr/local2/bin/gcc
   1.194 +
   1.195 +causes the specified `gcc' to be used as the C compiler (unless it is
   1.196 +overridden in the site shell script).  Here is a another example:
   1.197 +
   1.198 +     /bin/bash ./configure CONFIG_SHELL=/bin/bash
   1.199 +
   1.200 +Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
   1.201 +configuration-related scripts to be executed by `/bin/bash'.
   1.202 +
   1.203 +`configure' Invocation
   1.204 +======================
   1.205 +
   1.206 +`configure' recognizes the following options to control how it operates.
   1.207 +
   1.208 +`--help'
   1.209 +`-h'
   1.210 +     Print a summary of the options to `configure', and exit.
   1.211 +
   1.212 +`--version'
   1.213 +`-V'
   1.214 +     Print the version of Autoconf used to generate the `configure'
   1.215 +     script, and exit.
   1.216 +
   1.217 +`--cache-file=FILE'
   1.218 +     Enable the cache: use and save the results of the tests in FILE,
   1.219 +     traditionally `config.cache'.  FILE defaults to `/dev/null' to
   1.220 +     disable caching.
   1.221 +
   1.222 +`--config-cache'
   1.223 +`-C'
   1.224 +     Alias for `--cache-file=config.cache'.
   1.225 +
   1.226 +`--quiet'
   1.227 +`--silent'
   1.228 +`-q'
   1.229 +     Do not print messages saying which checks are being made.  To
   1.230 +     suppress all normal output, redirect it to `/dev/null' (any error
   1.231 +     messages will still be shown).
   1.232 +
   1.233 +`--srcdir=DIR'
   1.234 +     Look for the package's source code in directory DIR.  Usually
   1.235 +     `configure' can determine that directory automatically.
   1.236 +
   1.237 +`configure' also accepts some other, not widely useful, options.  Run
   1.238 +`configure --help' for more details.
   1.239 +