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

Press p or to see the previous file or, n or to see the next file