INSTALL 10.0 KB

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