filename | INSTALL |
changeset | 179:18dacd91aa73 |
author | nkeynes |
date | Tue Dec 23 05:48:05 2008 +0000 (15 years ago) |
branch | lxdream-mem |
permissions | -rw-r--r-- |
last change | More refactoring and general cleanup. Most things should be working again now. Split off cache and start real implementation, breaking save states in the process |
file | annotate | diff | log | raw |
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +00001.2 +++ b/INSTALL Tue Dec 23 05:48:05 2008 +00001.3 @@ -0,0 +1,229 @@1.4 +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software1.5 +Foundation, Inc.1.6 +1.7 + This file is free documentation; the Free Software Foundation gives1.8 +unlimited permission to copy, distribute and modify it.1.9 +1.10 +Basic Installation1.11 +==================1.12 +1.13 + These are generic installation instructions.1.14 +1.15 + The `configure' shell script attempts to guess correct values for1.16 +various system-dependent variables used during compilation. It uses1.17 +those values to create a `Makefile' in each directory of the package.1.18 +It may also create one or more `.h' files containing system-dependent1.19 +definitions. Finally, it creates a shell script `config.status' that1.20 +you can run in the future to recreate the current configuration, and a1.21 +file `config.log' containing compiler output (useful mainly for1.22 +debugging `configure').1.23 +1.24 + It can also use an optional file (typically called `config.cache'1.25 +and enabled with `--cache-file=config.cache' or simply `-C') that saves1.26 +the results of its tests to speed up reconfiguring. (Caching is1.27 +disabled by default to prevent problems with accidental use of stale1.28 +cache files.)1.29 +1.30 + If you need to do unusual things to compile the package, please try1.31 +to figure out how `configure' could check whether to do them, and mail1.32 +diffs or instructions to the address given in the `README' so they can1.33 +be considered for the next release. If you are using the cache, and at1.34 +some point `config.cache' contains results you don't want to keep, you1.35 +may remove or edit it.1.36 +1.37 + The file `configure.ac' (or `configure.in') is used to create1.38 +`configure' by a program called `autoconf'. You only need1.39 +`configure.ac' if you want to change it or regenerate `configure' using1.40 +a newer version of `autoconf'.1.41 +1.42 +The simplest way to compile this package is:1.43 +1.44 + 1. `cd' to the directory containing the package's source code and type1.45 + `./configure' to configure the package for your system. If you're1.46 + using `csh' on an old version of System V, you might need to type1.47 + `sh ./configure' instead to prevent `csh' from trying to execute1.48 + `configure' itself.1.49 +1.50 + Running `configure' takes awhile. While running, it prints some1.51 + messages telling which features it is checking for.1.52 +1.53 + 2. Type `make' to compile the package.1.54 +1.55 + 3. Optionally, type `make check' to run any self-tests that come with1.56 + the package.1.57 +1.58 + 4. Type `make install' to install the programs and any data files and1.59 + documentation.1.60 +1.61 + 5. You can remove the program binaries and object files from the1.62 + source code directory by typing `make clean'. To also remove the1.63 + files that `configure' created (so you can compile the package for1.64 + a different kind of computer), type `make distclean'. There is1.65 + also a `make maintainer-clean' target, but that is intended mainly1.66 + for the package's developers. If you use it, you may have to get1.67 + all sorts of other programs in order to regenerate files that came1.68 + with the distribution.1.69 +1.70 +Compilers and Options1.71 +=====================1.72 +1.73 + Some systems require unusual options for compilation or linking that1.74 +the `configure' script does not know about. Run `./configure --help'1.75 +for details on some of the pertinent environment variables.1.76 +1.77 + You can give `configure' initial values for configuration parameters1.78 +by setting variables in the command line or in the environment. Here1.79 +is an example:1.80 +1.81 + ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix1.82 +1.83 + *Note Defining Variables::, for more details.1.84 +1.85 +Compiling For Multiple Architectures1.86 +====================================1.87 +1.88 + You can compile the package for more than one kind of computer at the1.89 +same time, by placing the object files for each architecture in their1.90 +own directory. To do this, you must use a version of `make' that1.91 +supports the `VPATH' variable, such as GNU `make'. `cd' to the1.92 +directory where you want the object files and executables to go and run1.93 +the `configure' script. `configure' automatically checks for the1.94 +source code in the directory that `configure' is in and in `..'.1.95 +1.96 + If you have to use a `make' that does not support the `VPATH'1.97 +variable, you have to compile the package for one architecture at a1.98 +time in the source code directory. After you have installed the1.99 +package for one architecture, use `make distclean' before reconfiguring1.100 +for another architecture.1.101 +1.102 +Installation Names1.103 +==================1.104 +1.105 + By default, `make install' will install the package's files in1.106 +`/usr/local/bin', `/usr/local/man', etc. You can specify an1.107 +installation prefix other than `/usr/local' by giving `configure' the1.108 +option `--prefix=PATH'.1.109 +1.110 + You can specify separate installation prefixes for1.111 +architecture-specific files and architecture-independent files. If you1.112 +give `configure' the option `--exec-prefix=PATH', the package will use1.113 +PATH as the prefix for installing programs and libraries.1.114 +Documentation and other data files will still use the regular prefix.1.115 +1.116 + In addition, if you use an unusual directory layout you can give1.117 +options like `--bindir=PATH' to specify different values for particular1.118 +kinds of files. Run `configure --help' for a list of the directories1.119 +you can set and what kinds of files go in them.1.120 +1.121 + If the package supports it, you can cause programs to be installed1.122 +with an extra prefix or suffix on their names by giving `configure' the1.123 +option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.1.124 +1.125 +Optional Features1.126 +=================1.127 +1.128 + Some packages pay attention to `--enable-FEATURE' options to1.129 +`configure', where FEATURE indicates an optional part of the package.1.130 +They may also pay attention to `--with-PACKAGE' options, where PACKAGE1.131 +is something like `gnu-as' or `x' (for the X Window System). The1.132 +`README' should mention any `--enable-' and `--with-' options that the1.133 +package recognizes.1.134 +1.135 + For packages that use the X Window System, `configure' can usually1.136 +find the X include and library files automatically, but if it doesn't,1.137 +you can use the `configure' options `--x-includes=DIR' and1.138 +`--x-libraries=DIR' to specify their locations.1.139 +1.140 +Specifying the System Type1.141 +==========================1.142 +1.143 + There may be some features `configure' cannot figure out1.144 +automatically, but needs to determine by the type of machine the package1.145 +will run on. Usually, assuming the package is built to be run on the1.146 +_same_ architectures, `configure' can figure that out, but if it prints1.147 +a message saying it cannot guess the machine type, give it the1.148 +`--build=TYPE' option. TYPE can either be a short name for the system1.149 +type, such as `sun4', or a canonical name which has the form:1.150 +1.151 + CPU-COMPANY-SYSTEM1.152 +1.153 +where SYSTEM can have one of these forms:1.154 +1.155 + OS KERNEL-OS1.156 +1.157 + See the file `config.sub' for the possible values of each field. If1.158 +`config.sub' isn't included in this package, then this package doesn't1.159 +need to know the machine type.1.160 +1.161 + If you are _building_ compiler tools for cross-compiling, you should1.162 +use the `--target=TYPE' option to select the type of system they will1.163 +produce code for.1.164 +1.165 + If you want to _use_ a cross compiler, that generates code for a1.166 +platform different from the build platform, you should specify the1.167 +"host" platform (i.e., that on which the generated programs will1.168 +eventually be run) with `--host=TYPE'.1.169 +1.170 +Sharing Defaults1.171 +================1.172 +1.173 + If you want to set default values for `configure' scripts to share,1.174 +you can create a site shell script called `config.site' that gives1.175 +default values for variables like `CC', `cache_file', and `prefix'.1.176 +`configure' looks for `PREFIX/share/config.site' if it exists, then1.177 +`PREFIX/etc/config.site' if it exists. Or, you can set the1.178 +`CONFIG_SITE' environment variable to the location of the site script.1.179 +A warning: not all `configure' scripts look for a site script.1.180 +1.181 +Defining Variables1.182 +==================1.183 +1.184 + Variables not defined in a site shell script can be set in the1.185 +environment passed to `configure'. However, some packages may run1.186 +configure again during the build, and the customized values of these1.187 +variables may be lost. In order to avoid this problem, you should set1.188 +them in the `configure' command line, using `VAR=value'. For example:1.189 +1.190 + ./configure CC=/usr/local2/bin/gcc1.191 +1.192 +will cause the specified gcc to be used as the C compiler (unless it is1.193 +overridden in the site shell script).1.194 +1.195 +`configure' Invocation1.196 +======================1.197 +1.198 + `configure' recognizes the following options to control how it1.199 +operates.1.200 +1.201 +`--help'1.202 +`-h'1.203 + Print a summary of the options to `configure', and exit.1.204 +1.205 +`--version'1.206 +`-V'1.207 + Print the version of Autoconf used to generate the `configure'1.208 + script, and exit.1.209 +1.210 +`--cache-file=FILE'1.211 + Enable the cache: use and save the results of the tests in FILE,1.212 + traditionally `config.cache'. FILE defaults to `/dev/null' to1.213 + disable caching.1.214 +1.215 +`--config-cache'1.216 +`-C'1.217 + Alias for `--cache-file=config.cache'.1.218 +1.219 +`--quiet'1.220 +`--silent'1.221 +`-q'1.222 + Do not print messages saying which checks are being made. To1.223 + suppress all normal output, redirect it to `/dev/null' (any error1.224 + messages will still be shown).1.225 +1.226 +`--srcdir=DIR'1.227 + Look for the package's source code in directory DIR. Usually1.228 + `configure' can determine that directory automatically.1.229 +1.230 +`configure' also accepts some other, not widely useful, options. Run1.231 +`configure --help' for more details.1.232 +
.