INSTALL 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. Installation Instructions
  2. *************************
  3. Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 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 `configure.ac' (or `configure.in') is used to create
  30. `configure' by a program called `autoconf'. You only need
  31. `configure.ac' 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, generally using the just-built uninstalled binaries.
  44. 4. Type `make install' to install the programs and any data files and
  45. documentation. When installing into a prefix owned by root, it is
  46. recommended that the package be configured and built as a regular
  47. user, and only the `make install' phase executed with root
  48. privileges.
  49. 5. Optionally, type `make installcheck' to repeat any self-tests, but
  50. this time using the binaries in their final installed location.
  51. This target does not install anything. Running this target as a
  52. regular user, particularly if the prior `make install' required
  53. root privileges, verifies that the installation completed
  54. correctly.
  55. 6. You can remove the program binaries and object files from the
  56. source code directory by typing `make clean'. To also remove the
  57. files that `configure' created (so you can compile the package for
  58. a different kind of computer), type `make distclean'. There is
  59. also a `make maintainer-clean' target, but that is intended mainly
  60. for the package's developers. If you use it, you may have to get
  61. all sorts of other programs in order to regenerate files that came
  62. with the distribution.
  63. Compilers and Options
  64. =====================
  65. Some systems require unusual options for compilation or linking that the
  66. `configure' script does not know about. Run `./configure --help' for
  67. details on some of the pertinent environment variables.
  68. You can give `configure' initial values for configuration parameters
  69. by setting variables in the command line or in the environment. Here
  70. is an example:
  71. ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  72. *Note Defining Variables::, for more details.
  73. Compiling For Multiple Architectures
  74. ====================================
  75. You can compile the package for more than one kind of computer at the
  76. same time, by placing the object files for each architecture in their
  77. own directory. To do this, you must use a version of `make' that
  78. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  79. directory where you want the object files and executables to go and run
  80. the `configure' script. `configure' automatically checks for the
  81. source code in the directory that `configure' is in and in `..'. This
  82. is known as a "VPATH" build.
  83. If you have to use a `make' that does not support the `VPATH'
  84. variable, you have to compile the package for one architecture at a
  85. time in the source code directory. After you have installed the
  86. package for one architecture, use `make distclean' before reconfiguring
  87. for another architecture.
  88. Installation Names
  89. ==================
  90. By default, `make install' installs the package's commands under
  91. `/usr/local/bin', include files under `/usr/local/include', etc. You
  92. can specify an installation prefix other than `/usr/local' by giving
  93. `configure' the option `--prefix=PREFIX', where PREFIX must be an
  94. absolute file name.
  95. You can specify separate installation prefixes for
  96. architecture-specific files and architecture-independent files. If you
  97. pass the option `--exec-prefix=PREFIX' to `configure', the package uses
  98. PREFIX as the prefix for installing programs and libraries.
  99. Documentation and other data files still use the regular prefix.
  100. In addition, if you use an unusual directory layout you can give
  101. options like `--bindir=DIR' to specify different values for particular
  102. kinds of files. Run `configure --help' for a list of the directories
  103. you can set and what kinds of files go in them.
  104. If the package supports it, you can cause programs to be installed
  105. with an extra prefix or suffix on their names by giving `configure' the
  106. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  107. Optional Features
  108. =================
  109. Some packages pay attention to `--enable-FEATURE' options to
  110. `configure', where FEATURE indicates an optional part of the package.
  111. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  112. is something like `gnu-as' or `x' (for the X Window System). The
  113. `README' should mention any `--enable-' and `--with-' options that the
  114. package recognizes.
  115. For packages that use the X Window System, `configure' can usually
  116. find the X include and library files automatically, but if it doesn't,
  117. you can use the `configure' options `--x-includes=DIR' and
  118. `--x-libraries=DIR' to specify their locations.
  119. On Solaris, don't put `/usr/ucb' early in your `PATH'. This
  120. directory contains several dysfunctional programs; working variants of
  121. these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
  122. in your `PATH', put it _after_ `/usr/bin'.
  123. On Haiku, software installed for all users goes in `/boot/common',
  124. not `/usr/local'. It is recommended to use the following options:
  125. ./configure --prefix=/boot/common
  126. Specifying the System Type
  127. ==========================
  128. There may be some features `configure' cannot figure out automatically,
  129. but needs to determine by the type of machine the package will run on.
  130. Usually, assuming the package is built to be run on the _same_
  131. architectures, `configure' can figure that out, but if it prints a
  132. message saying it cannot guess the machine type, give it the
  133. `--build=TYPE' option. TYPE can either be a short name for the system
  134. type, such as `sun4', or a canonical name which has the form:
  135. CPU-COMPANY-SYSTEM
  136. where SYSTEM can have one of these forms:
  137. OS
  138. KERNEL-OS
  139. See the file `config.sub' for the possible values of each field. If
  140. `config.sub' isn't included in this package, then this package doesn't
  141. need to know the machine type.
  142. If you are _building_ compiler tools for cross-compiling, you should
  143. use the option `--target=TYPE' to select the type of system they will
  144. produce code for.
  145. If you want to _use_ a cross compiler, that generates code for a
  146. platform different from the build platform, you should specify the
  147. "host" platform (i.e., that on which the generated programs will
  148. eventually be run) with `--host=TYPE'.
  149. Sharing Defaults
  150. ================
  151. If you want to set default values for `configure' scripts to share, you
  152. can create a site shell script called `config.site' that gives default
  153. values for variables like `CC', `cache_file', and `prefix'.
  154. `configure' looks for `PREFIX/share/config.site' if it exists, then
  155. `PREFIX/etc/config.site' if it exists. Or, you can set the
  156. `CONFIG_SITE' environment variable to the location of the site script.
  157. A warning: not all `configure' scripts look for a site script.
  158. Defining Variables
  159. ==================
  160. Variables not defined in a site shell script can be set in the
  161. environment passed to `configure'. However, some packages may run
  162. configure again during the build, and the customized values of these
  163. variables may be lost. In order to avoid this problem, you should set
  164. them in the `configure' command line, using `VAR=value'. For example:
  165. ./configure CC=/usr/local2/bin/gcc
  166. causes the specified `gcc' to be used as the C compiler (unless it is
  167. overridden in the site shell script). Here is a another example:
  168. /bin/bash ./configure CONFIG_SHELL=/bin/bash
  169. Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
  170. configuration-related scripts to be executed by `/bin/bash'.
  171. `configure' Invocation
  172. ======================
  173. `configure' recognizes the following options to control how it operates.
  174. `--help'
  175. `-h'
  176. Print a summary of the options to `configure', and exit.
  177. `--version'
  178. `-V'
  179. Print the version of Autoconf used to generate the `configure'
  180. script, and exit.
  181. `--cache-file=FILE'
  182. Enable the cache: use and save the results of the tests in FILE,
  183. traditionally `config.cache'. FILE defaults to `/dev/null' to
  184. disable caching.
  185. `--config-cache'
  186. `-C'
  187. Alias for `--cache-file=config.cache'.
  188. `--quiet'
  189. `--silent'
  190. `-q'
  191. Do not print messages saying which checks are being made. To
  192. suppress all normal output, redirect it to `/dev/null' (any error
  193. messages will still be shown).
  194. `--srcdir=DIR'
  195. Look for the package's source code in directory DIR. Usually
  196. `configure' can determine that directory automatically.
  197. `configure' also accepts some other, not widely useful, options. Run
  198. `configure --help' for more details.