annotate INSTALL @ 15:4b455313327d

fixed typos in the lua Makefile.am
author Robert McIntyre <rlm@mit.edu>
date Sat, 03 Mar 2012 11:38:08 -0600
parents 08a8e09ca414
children
rev   line source
rlm@8 1 Installation Instructions
rlm@8 2 *************************
rlm@8 3
rlm@8 4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
rlm@8 5 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
rlm@8 6
rlm@8 7 Copying and distribution of this file, with or without modification,
rlm@8 8 are permitted in any medium without royalty provided the copyright
rlm@8 9 notice and this notice are preserved. This file is offered as-is,
rlm@8 10 without warranty of any kind.
rlm@8 11
rlm@8 12 Basic Installation
rlm@8 13 ==================
rlm@8 14
rlm@8 15 Briefly, the shell commands `./configure; make; make install' should
rlm@8 16 configure, build, and install this package. The following
rlm@8 17 more-detailed instructions are generic; see the `README' file for
rlm@8 18 instructions specific to this package. Some packages provide this
rlm@8 19 `INSTALL' file but do not implement all of the features documented
rlm@8 20 below. The lack of an optional feature in a given package is not
rlm@8 21 necessarily a bug. More recommendations for GNU packages can be found
rlm@8 22 in *note Makefile Conventions: (standards)Makefile Conventions.
rlm@8 23
rlm@8 24 The `configure' shell script attempts to guess correct values for
rlm@8 25 various system-dependent variables used during compilation. It uses
rlm@8 26 those values to create a `Makefile' in each directory of the package.
rlm@8 27 It may also create one or more `.h' files containing system-dependent
rlm@8 28 definitions. Finally, it creates a shell script `config.status' that
rlm@8 29 you can run in the future to recreate the current configuration, and a
rlm@8 30 file `config.log' containing compiler output (useful mainly for
rlm@8 31 debugging `configure').
rlm@8 32
rlm@8 33 It can also use an optional file (typically called `config.cache'
rlm@8 34 and enabled with `--cache-file=config.cache' or simply `-C') that saves
rlm@8 35 the results of its tests to speed up reconfiguring. Caching is
rlm@8 36 disabled by default to prevent problems with accidental use of stale
rlm@8 37 cache files.
rlm@8 38
rlm@8 39 If you need to do unusual things to compile the package, please try
rlm@8 40 to figure out how `configure' could check whether to do them, and mail
rlm@8 41 diffs or instructions to the address given in the `README' so they can
rlm@8 42 be considered for the next release. If you are using the cache, and at
rlm@8 43 some point `config.cache' contains results you don't want to keep, you
rlm@8 44 may remove or edit it.
rlm@8 45
rlm@8 46 The file `configure.ac' (or `configure.in') is used to create
rlm@8 47 `configure' by a program called `autoconf'. You need `configure.ac' if
rlm@8 48 you want to change it or regenerate `configure' using a newer version
rlm@8 49 of `autoconf'.
rlm@8 50
rlm@8 51 The simplest way to compile this package is:
rlm@8 52
rlm@8 53 1. `cd' to the directory containing the package's source code and type
rlm@8 54 `./configure' to configure the package for your system.
rlm@8 55
rlm@8 56 Running `configure' might take a while. While running, it prints
rlm@8 57 some messages telling which features it is checking for.
rlm@8 58
rlm@8 59 2. Type `make' to compile the package.
rlm@8 60
rlm@8 61 3. Optionally, type `make check' to run any self-tests that come with
rlm@8 62 the package, generally using the just-built uninstalled binaries.
rlm@8 63
rlm@8 64 4. Type `make install' to install the programs and any data files and
rlm@8 65 documentation. When installing into a prefix owned by root, it is
rlm@8 66 recommended that the package be configured and built as a regular
rlm@8 67 user, and only the `make install' phase executed with root
rlm@8 68 privileges.
rlm@8 69
rlm@8 70 5. Optionally, type `make installcheck' to repeat any self-tests, but
rlm@8 71 this time using the binaries in their final installed location.
rlm@8 72 This target does not install anything. Running this target as a
rlm@8 73 regular user, particularly if the prior `make install' required
rlm@8 74 root privileges, verifies that the installation completed
rlm@8 75 correctly.
rlm@8 76
rlm@8 77 6. You can remove the program binaries and object files from the
rlm@8 78 source code directory by typing `make clean'. To also remove the
rlm@8 79 files that `configure' created (so you can compile the package for
rlm@8 80 a different kind of computer), type `make distclean'. There is
rlm@8 81 also a `make maintainer-clean' target, but that is intended mainly
rlm@8 82 for the package's developers. If you use it, you may have to get
rlm@8 83 all sorts of other programs in order to regenerate files that came
rlm@8 84 with the distribution.
rlm@8 85
rlm@8 86 7. Often, you can also type `make uninstall' to remove the installed
rlm@8 87 files again. In practice, not all packages have tested that
rlm@8 88 uninstallation works correctly, even though it is required by the
rlm@8 89 GNU Coding Standards.
rlm@8 90
rlm@8 91 8. Some packages, particularly those that use Automake, provide `make
rlm@8 92 distcheck', which can by used by developers to test that all other
rlm@8 93 targets like `make install' and `make uninstall' work correctly.
rlm@8 94 This target is generally not run by end users.
rlm@8 95
rlm@8 96 Compilers and Options
rlm@8 97 =====================
rlm@8 98
rlm@8 99 Some systems require unusual options for compilation or linking that
rlm@8 100 the `configure' script does not know about. Run `./configure --help'
rlm@8 101 for details on some of the pertinent environment variables.
rlm@8 102
rlm@8 103 You can give `configure' initial values for configuration parameters
rlm@8 104 by setting variables in the command line or in the environment. Here
rlm@8 105 is an example:
rlm@8 106
rlm@8 107 ./configure CC=c99 CFLAGS=-g LIBS=-lposix
rlm@8 108
rlm@8 109 *Note Defining Variables::, for more details.
rlm@8 110
rlm@8 111 Compiling For Multiple Architectures
rlm@8 112 ====================================
rlm@8 113
rlm@8 114 You can compile the package for more than one kind of computer at the
rlm@8 115 same time, by placing the object files for each architecture in their
rlm@8 116 own directory. To do this, you can use GNU `make'. `cd' to the
rlm@8 117 directory where you want the object files and executables to go and run
rlm@8 118 the `configure' script. `configure' automatically checks for the
rlm@8 119 source code in the directory that `configure' is in and in `..'. This
rlm@8 120 is known as a "VPATH" build.
rlm@8 121
rlm@8 122 With a non-GNU `make', it is safer to compile the package for one
rlm@8 123 architecture at a time in the source code directory. After you have
rlm@8 124 installed the package for one architecture, use `make distclean' before
rlm@8 125 reconfiguring for another architecture.
rlm@8 126
rlm@8 127 On MacOS X 10.5 and later systems, you can create libraries and
rlm@8 128 executables that work on multiple system types--known as "fat" or
rlm@8 129 "universal" binaries--by specifying multiple `-arch' options to the
rlm@8 130 compiler but only a single `-arch' option to the preprocessor. Like
rlm@8 131 this:
rlm@8 132
rlm@8 133 ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
rlm@8 134 CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
rlm@8 135 CPP="gcc -E" CXXCPP="g++ -E"
rlm@8 136
rlm@8 137 This is not guaranteed to produce working output in all cases, you
rlm@8 138 may have to build one architecture at a time and combine the results
rlm@8 139 using the `lipo' tool if you have problems.
rlm@8 140
rlm@8 141 Installation Names
rlm@8 142 ==================
rlm@8 143
rlm@8 144 By default, `make install' installs the package's commands under
rlm@8 145 `/usr/local/bin', include files under `/usr/local/include', etc. You
rlm@8 146 can specify an installation prefix other than `/usr/local' by giving
rlm@8 147 `configure' the option `--prefix=PREFIX', where PREFIX must be an
rlm@8 148 absolute file name.
rlm@8 149
rlm@8 150 You can specify separate installation prefixes for
rlm@8 151 architecture-specific files and architecture-independent files. If you
rlm@8 152 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
rlm@8 153 PREFIX as the prefix for installing programs and libraries.
rlm@8 154 Documentation and other data files still use the regular prefix.
rlm@8 155
rlm@8 156 In addition, if you use an unusual directory layout you can give
rlm@8 157 options like `--bindir=DIR' to specify different values for particular
rlm@8 158 kinds of files. Run `configure --help' for a list of the directories
rlm@8 159 you can set and what kinds of files go in them. In general, the
rlm@8 160 default for these options is expressed in terms of `${prefix}', so that
rlm@8 161 specifying just `--prefix' will affect all of the other directory
rlm@8 162 specifications that were not explicitly provided.
rlm@8 163
rlm@8 164 The most portable way to affect installation locations is to pass the
rlm@8 165 correct locations to `configure'; however, many packages provide one or
rlm@8 166 both of the following shortcuts of passing variable assignments to the
rlm@8 167 `make install' command line to change installation locations without
rlm@8 168 having to reconfigure or recompile.
rlm@8 169
rlm@8 170 The first method involves providing an override variable for each
rlm@8 171 affected directory. For example, `make install
rlm@8 172 prefix=/alternate/directory' will choose an alternate location for all
rlm@8 173 directory configuration variables that were expressed in terms of
rlm@8 174 `${prefix}'. Any directories that were specified during `configure',
rlm@8 175 but not in terms of `${prefix}', must each be overridden at install
rlm@8 176 time for the entire installation to be relocated. The approach of
rlm@8 177 makefile variable overrides for each directory variable is required by
rlm@8 178 the GNU Coding Standards, and ideally causes no recompilation.
rlm@8 179 However, some platforms have known limitations with the semantics of
rlm@8 180 shared libraries that end up requiring recompilation when using this
rlm@8 181 method, particularly noticeable in packages that use GNU Libtool.
rlm@8 182
rlm@8 183 The second method involves providing the `DESTDIR' variable. For
rlm@8 184 example, `make install DESTDIR=/alternate/directory' will prepend
rlm@8 185 `/alternate/directory' before all installation names. The approach of
rlm@8 186 `DESTDIR' overrides is not required by the GNU Coding Standards, and
rlm@8 187 does not work on platforms that have drive letters. On the other hand,
rlm@8 188 it does better at avoiding recompilation issues, and works well even
rlm@8 189 when some directory options were not specified in terms of `${prefix}'
rlm@8 190 at `configure' time.
rlm@8 191
rlm@8 192 Optional Features
rlm@8 193 =================
rlm@8 194
rlm@8 195 If the package supports it, you can cause programs to be installed
rlm@8 196 with an extra prefix or suffix on their names by giving `configure' the
rlm@8 197 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
rlm@8 198
rlm@8 199 Some packages pay attention to `--enable-FEATURE' options to
rlm@8 200 `configure', where FEATURE indicates an optional part of the package.
rlm@8 201 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
rlm@8 202 is something like `gnu-as' or `x' (for the X Window System). The
rlm@8 203 `README' should mention any `--enable-' and `--with-' options that the
rlm@8 204 package recognizes.
rlm@8 205
rlm@8 206 For packages that use the X Window System, `configure' can usually
rlm@8 207 find the X include and library files automatically, but if it doesn't,
rlm@8 208 you can use the `configure' options `--x-includes=DIR' and
rlm@8 209 `--x-libraries=DIR' to specify their locations.
rlm@8 210
rlm@8 211 Some packages offer the ability to configure how verbose the
rlm@8 212 execution of `make' will be. For these packages, running `./configure
rlm@8 213 --enable-silent-rules' sets the default to minimal output, which can be
rlm@8 214 overridden with `make V=1'; while running `./configure
rlm@8 215 --disable-silent-rules' sets the default to verbose, which can be
rlm@8 216 overridden with `make V=0'.
rlm@8 217
rlm@8 218 Particular systems
rlm@8 219 ==================
rlm@8 220
rlm@8 221 On HP-UX, the default C compiler is not ANSI C compatible. If GNU
rlm@8 222 CC is not installed, it is recommended to use the following options in
rlm@8 223 order to use an ANSI C compiler:
rlm@8 224
rlm@8 225 ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
rlm@8 226
rlm@8 227 and if that doesn't work, install pre-built binaries of GCC for HP-UX.
rlm@8 228
rlm@8 229 On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
rlm@8 230 parse its `<wchar.h>' header file. The option `-nodtk' can be used as
rlm@8 231 a workaround. If GNU CC is not installed, it is therefore recommended
rlm@8 232 to try
rlm@8 233
rlm@8 234 ./configure CC="cc"
rlm@8 235
rlm@8 236 and if that doesn't work, try
rlm@8 237
rlm@8 238 ./configure CC="cc -nodtk"
rlm@8 239
rlm@8 240 On Solaris, don't put `/usr/ucb' early in your `PATH'. This
rlm@8 241 directory contains several dysfunctional programs; working variants of
rlm@8 242 these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
rlm@8 243 in your `PATH', put it _after_ `/usr/bin'.
rlm@8 244
rlm@8 245 On Haiku, software installed for all users goes in `/boot/common',
rlm@8 246 not `/usr/local'. It is recommended to use the following options:
rlm@8 247
rlm@8 248 ./configure --prefix=/boot/common
rlm@8 249
rlm@8 250 Specifying the System Type
rlm@8 251 ==========================
rlm@8 252
rlm@8 253 There may be some features `configure' cannot figure out
rlm@8 254 automatically, but needs to determine by the type of machine the package
rlm@8 255 will run on. Usually, assuming the package is built to be run on the
rlm@8 256 _same_ architectures, `configure' can figure that out, but if it prints
rlm@8 257 a message saying it cannot guess the machine type, give it the
rlm@8 258 `--build=TYPE' option. TYPE can either be a short name for the system
rlm@8 259 type, such as `sun4', or a canonical name which has the form:
rlm@8 260
rlm@8 261 CPU-COMPANY-SYSTEM
rlm@8 262
rlm@8 263 where SYSTEM can have one of these forms:
rlm@8 264
rlm@8 265 OS
rlm@8 266 KERNEL-OS
rlm@8 267
rlm@8 268 See the file `config.sub' for the possible values of each field. If
rlm@8 269 `config.sub' isn't included in this package, then this package doesn't
rlm@8 270 need to know the machine type.
rlm@8 271
rlm@8 272 If you are _building_ compiler tools for cross-compiling, you should
rlm@8 273 use the option `--target=TYPE' to select the type of system they will
rlm@8 274 produce code for.
rlm@8 275
rlm@8 276 If you want to _use_ a cross compiler, that generates code for a
rlm@8 277 platform different from the build platform, you should specify the
rlm@8 278 "host" platform (i.e., that on which the generated programs will
rlm@8 279 eventually be run) with `--host=TYPE'.
rlm@8 280
rlm@8 281 Sharing Defaults
rlm@8 282 ================
rlm@8 283
rlm@8 284 If you want to set default values for `configure' scripts to share,
rlm@8 285 you can create a site shell script called `config.site' that gives
rlm@8 286 default values for variables like `CC', `cache_file', and `prefix'.
rlm@8 287 `configure' looks for `PREFIX/share/config.site' if it exists, then
rlm@8 288 `PREFIX/etc/config.site' if it exists. Or, you can set the
rlm@8 289 `CONFIG_SITE' environment variable to the location of the site script.
rlm@8 290 A warning: not all `configure' scripts look for a site script.
rlm@8 291
rlm@8 292 Defining Variables
rlm@8 293 ==================
rlm@8 294
rlm@8 295 Variables not defined in a site shell script can be set in the
rlm@8 296 environment passed to `configure'. However, some packages may run
rlm@8 297 configure again during the build, and the customized values of these
rlm@8 298 variables may be lost. In order to avoid this problem, you should set
rlm@8 299 them in the `configure' command line, using `VAR=value'. For example:
rlm@8 300
rlm@8 301 ./configure CC=/usr/local2/bin/gcc
rlm@8 302
rlm@8 303 causes the specified `gcc' to be used as the C compiler (unless it is
rlm@8 304 overridden in the site shell script).
rlm@8 305
rlm@8 306 Unfortunately, this technique does not work for `CONFIG_SHELL' due to
rlm@8 307 an Autoconf bug. Until the bug is fixed you can use this workaround:
rlm@8 308
rlm@8 309 CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
rlm@8 310
rlm@8 311 `configure' Invocation
rlm@8 312 ======================
rlm@8 313
rlm@8 314 `configure' recognizes the following options to control how it
rlm@8 315 operates.
rlm@8 316
rlm@8 317 `--help'
rlm@8 318 `-h'
rlm@8 319 Print a summary of all of the options to `configure', and exit.
rlm@8 320
rlm@8 321 `--help=short'
rlm@8 322 `--help=recursive'
rlm@8 323 Print a summary of the options unique to this package's
rlm@8 324 `configure', and exit. The `short' variant lists options used
rlm@8 325 only in the top level, while the `recursive' variant lists options
rlm@8 326 also present in any nested packages.
rlm@8 327
rlm@8 328 `--version'
rlm@8 329 `-V'
rlm@8 330 Print the version of Autoconf used to generate the `configure'
rlm@8 331 script, and exit.
rlm@8 332
rlm@8 333 `--cache-file=FILE'
rlm@8 334 Enable the cache: use and save the results of the tests in FILE,
rlm@8 335 traditionally `config.cache'. FILE defaults to `/dev/null' to
rlm@8 336 disable caching.
rlm@8 337
rlm@8 338 `--config-cache'
rlm@8 339 `-C'
rlm@8 340 Alias for `--cache-file=config.cache'.
rlm@8 341
rlm@8 342 `--quiet'
rlm@8 343 `--silent'
rlm@8 344 `-q'
rlm@8 345 Do not print messages saying which checks are being made. To
rlm@8 346 suppress all normal output, redirect it to `/dev/null' (any error
rlm@8 347 messages will still be shown).
rlm@8 348
rlm@8 349 `--srcdir=DIR'
rlm@8 350 Look for the package's source code in directory DIR. Usually
rlm@8 351 `configure' can determine that directory automatically.
rlm@8 352
rlm@8 353 `--prefix=DIR'
rlm@8 354 Use DIR as the installation prefix. *note Installation Names::
rlm@8 355 for more details, including other options available for fine-tuning
rlm@8 356 the installation locations.
rlm@8 357
rlm@8 358 `--no-create'
rlm@8 359 `-n'
rlm@8 360 Run the configure checks, but stop before creating any output
rlm@8 361 files.
rlm@8 362
rlm@8 363 `configure' also accepts some other, not widely useful, options. Run
rlm@8 364 `configure --help' for more details.
rlm@8 365