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