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