INSTALL 15 KB

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