1. Installation Instructions
  2. *************************
  3. Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
  4. 2006, 2007, 2008, 2009 Free 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. Briefly, the shell commands `./configure; make; make install' should
  10. configure, build, and install this package. The following
  11. more-detailed instructions are generic; see the `README' file for
  12. instructions specific to this package.
  13. The `configure' shell script attempts to guess correct values for
  14. various system-dependent variables used during compilation. It uses
  15. those values to create a `Makefile' in each directory of the package.
  16. It may also create one or more `.h' files containing system-dependent
  17. definitions. Finally, it creates a shell script `config.status' that
  18. you can run in the future to recreate the current configuration, and a
  19. file `config.log' containing compiler output (useful mainly for
  20. debugging `configure').
  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. If you need to do unusual things to compile the package, please try
  27. to figure out how `configure' could check whether to do them, and mail
  28. diffs or instructions to the address given in the `README' so they can
  29. be considered for the next release. If you are using the cache, and at
  30. some point `config.cache' contains results you don't want to keep, you
  31. may remove or edit it.
  32. The file `' (or `') is used to create
  33. `configure' by a program called `autoconf'. You need `' if
  34. you want to change it or regenerate `configure' using a newer version
  35. of `autoconf'.
  36. The simplest way to compile this package is:
  37. 1. `cd' to the directory containing the package's source code and type
  38. `./configure' to configure the package for your system.
  39. Running `configure' might take a while. While running, it prints
  40. some 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. 6. Often, you can also type `make uninstall' to remove the installed
  55. files again.
  56. Compilers and Options
  57. =====================
  58. Some systems require unusual options for compilation or linking that
  59. the `configure' script does not know about. Run `./configure --help'
  60. for details on some of the pertinent environment variables.
  61. You can give `configure' initial values for configuration parameters
  62. by setting variables in the command line or in the environment. Here
  63. is an example:
  64. ./configure CC=c99 CFLAGS=-g LIBS=-lposix
  65. *Note Defining Variables::, for more details.
  66. Compiling For Multiple Architectures
  67. ====================================
  68. You can compile the package for more than one kind of computer at the
  69. same time, by placing the object files for each architecture in their
  70. own directory. To do this, you can use GNU `make'. `cd' to the
  71. directory where you want the object files and executables to go and run
  72. the `configure' script. `configure' automatically checks for the
  73. source code in the directory that `configure' is in and in `..'.
  74. With a non-GNU `make', it is safer to compile the package for one
  75. architecture at a time in the source code directory. After you have
  76. installed the package for one architecture, use `make distclean' before
  77. reconfiguring for another architecture.
  78. On MacOS X 10.5 and later systems, you can create libraries and
  79. executables that work on multiple system types--known as "fat" or
  80. "universal" binaries--by specifying multiple `-arch' options to the
  81. compiler but only a single `-arch' option to the preprocessor. Like
  82. this:
  83. ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  84. CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
  85. CPP="gcc -E" CXXCPP="g++ -E"
  86. This is not guaranteed to produce working output in all cases, you
  87. may have to build one architecture at a time and combine the results
  88. using the `lipo' tool if you have problems.
  89. Installation Names
  90. ==================
  91. By default, `make install' installs the package's commands under
  92. `/usr/local/bin', include files under `/usr/local/include', etc. You
  93. can specify an installation prefix other than `/usr/local' by giving
  94. `configure' the option `--prefix=PREFIX'.
  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. Particular systems
  120. ==================
  121. On HP-UX, the default C compiler is not ANSI C compatible. If GNU
  122. CC is not installed, it is recommended to use the following options in
  123. order to use an ANSI C compiler:
  124. ./configure CC="cc -Ae -D_XOPEN_SOURCE=500"
  125. and if that doesn't work, install pre-built binaries of GCC for HP-UX.
  126. On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
  127. parse its `<wchar.h>' header file. The option `-nodtk' can be used as
  128. a workaround. If GNU CC is not installed, it is therefore recommended
  129. to try
  130. ./configure CC="cc"
  131. and if that doesn't work, try
  132. ./configure CC="cc -nodtk"
  133. On Solaris, don't put `/usr/ucb' early in your `PATH'. This
  134. directory contains several dysfunctional programs; working variants of
  135. these programs are available in `/usr/bin'. So, if you need `/usr/ucb'
  136. in your `PATH', put it _after_ `/usr/bin'.
  137. On Haiku, software installed for all users goes in `/boot/common',
  138. not `/usr/local'. It is recommended to use the following options:
  139. ./configure --prefix=/boot/common
  140. Specifying the System Type
  141. ==========================
  142. There may be some features `configure' cannot figure out
  143. automatically, but needs to determine by the type of machine the package
  144. will run on. Usually, assuming the package is built to be run on the
  145. _same_ architectures, `configure' can figure that out, but if it prints
  146. a message saying it cannot guess the machine type, give it the
  147. `--build=TYPE' option. TYPE can either be a short name for the system
  148. type, such as `sun4', or a canonical name which has the form:
  150. where SYSTEM can have one of these forms:
  151. OS
  152. KERNEL-OS
  153. See the file `config.sub' for the possible values of each field. If
  154. `config.sub' isn't included in this package, then this package doesn't
  155. need to know the machine type.
  156. If you are _building_ compiler tools for cross-compiling, you should
  157. use the option `--target=TYPE' to select the type of system they will
  158. produce code for.
  159. If you want to _use_ a cross compiler, that generates code for a
  160. platform different from the build platform, you should specify the
  161. "host" platform (i.e., that on which the generated programs will
  162. eventually be run) with `--host=TYPE'.
  163. Sharing Defaults
  164. ================
  165. If you want to set default values for `configure' scripts to share,
  166. you can create a site shell script called `' that gives
  167. default values for variables like `CC', `cache_file', and `prefix'.
  168. `configure' looks for `PREFIX/share/' if it exists, then
  169. `PREFIX/etc/' if it exists. Or, you can set the
  170. `CONFIG_SITE' environment variable to the location of the site script.
  171. A warning: not all `configure' scripts look for a site script.
  172. Defining Variables
  173. ==================
  174. Variables not defined in a site shell script can be set in the
  175. environment passed to `configure'. However, some packages may run
  176. configure again during the build, and the customized values of these
  177. variables may be lost. In order to avoid this problem, you should set
  178. them in the `configure' command line, using `VAR=value'. For example:
  179. ./configure CC=/usr/local2/bin/gcc
  180. causes the specified `gcc' to be used as the C compiler (unless it is
  181. overridden in the site shell script).
  182. Unfortunately, this technique does not work for `CONFIG_SHELL' due to
  183. an Autoconf bug. Until the bug is fixed you can use this workaround:
  184. CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
  185. `configure' Invocation
  186. ======================
  187. `configure' recognizes the following options to control how it
  188. operates.
  189. `--help'
  190. `-h'
  191. Print a summary of all of the options to `configure', and exit.
  192. `--help=short'
  193. `--help=recursive'
  194. Print a summary of the options unique to this package's
  195. `configure', and exit. The `short' variant lists options used
  196. only in the top level, while the `recursive' variant lists options
  197. also present in any nested packages.
  198. `--version'
  199. `-V'
  200. Print the version of Autoconf used to generate the `configure'
  201. script, and exit.
  202. `--cache-file=FILE'
  203. Enable the cache: use and save the results of the tests in FILE,
  204. traditionally `config.cache'. FILE defaults to `/dev/null' to
  205. disable caching.
  206. `--config-cache'
  207. `-C'
  208. Alias for `--cache-file=config.cache'.
  209. `--quiet'
  210. `--silent'
  211. `-q'
  212. Do not print messages saying which checks are being made. To
  213. suppress all normal output, redirect it to `/dev/null' (any error
  214. messages will still be shown).
  215. `--srcdir=DIR'
  216. Look for the package's source code in directory DIR. Usually
  217. `configure' can determine that directory automatically.
  218. `--prefix=DIR'
  219. Use DIR as the installation prefix. *Note Installation Names::
  220. for more details, including other options available for fine-tuning
  221. the installation locations.
  222. `--no-create'
  223. `-n'
  224. Run the configure checks, but stop before creating any output
  225. files.
  226. `configure' also accepts some other, not widely useful, options. Run
  227. `configure --help' for more details.