INSTALL.generic 7.6 KB

  1. Basic Installation
  2. ==================
  3. These are generic installation instructions.
  4. The `configure' shell script attempts to guess correct values for
  5. various system-dependent variables used during compilation. It uses
  6. those values to create a `Makefile' in each directory of the package.
  7. It may also create one or more `.h' files containing system-dependent
  8. definitions. Finally, it creates a shell script `config.status' that
  9. you can run in the future to recreate the current configuration, a file
  10. `config.cache' that saves the results of its tests to speed up
  11. reconfiguring, and a file `config.log' containing compiler output
  12. (useful mainly for debugging `configure').
  13. If you need to do unusual things to compile the package, please try
  14. to figure out how `configure' could check whether to do them, and mail
  15. diffs or instructions to the address given in the `README' so they can
  16. be considered for the next release. If at some point `config.cache'
  17. contains results you don't want to keep, you may remove or edit it.
  18. The file `' is used to create `configure' by a program
  19. called `autoconf'. You only need `' if you want to change
  20. it or regenerate `configure' using a newer version of `autoconf'.
  21. The simplest way to compile this package is:
  22. 1. `cd' to the directory containing the package's source code and type
  23. `./configure' to configure the package for your system. If you're
  24. using `csh' on an old version of System V, you might need to type
  25. `sh ./configure' instead to prevent `csh' from trying to execute
  26. `configure' itself.
  27. Running `configure' takes awhile. While running, it prints some
  28. messages telling which features it is checking for.
  29. 2. Type `make' to compile the package.
  30. 3. Optionally, type `make check' to run any self-tests that come with
  31. the package.
  32. 4. Type `make install' to install the programs and any data files and
  33. documentation.
  34. 5. You can remove the program binaries and object files from the
  35. source code directory by typing `make clean'. To also remove the
  36. files that `configure' created (so you can compile the package for
  37. a different kind of computer), type `make distclean'. There is
  38. also a `make maintainer-clean' target, but that is intended mainly
  39. for the package's developers. If you use it, you may have to get
  40. all sorts of other programs in order to regenerate files that came
  41. with the distribution.
  42. Compilers and Options
  43. =====================
  44. Some systems require unusual options for compilation or linking that
  45. the `configure' script does not know about. You can give `configure'
  46. initial values for variables by setting them in the environment. Using
  47. a Bourne-compatible shell, you can do that on the command line like
  48. this:
  49. CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  50. Or on systems that have the `env' program, you can do it like this:
  51. env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
  52. Compiling For Multiple Architectures
  53. ====================================
  54. You can compile the package for more than one kind of computer at the
  55. same time, by placing the object files for each architecture in their
  56. own directory. To do this, you must use a version of `make' that
  57. supports the `VPATH' variable, such as GNU `make'. `cd' to the
  58. directory where you want the object files and executables to go and run
  59. the `configure' script. `configure' automatically checks for the
  60. source code in the directory that `configure' is in and in `..'.
  61. If you have to use a `make' that does not supports the `VPATH'
  62. variable, you have to compile the package for one architecture at a time
  63. in the source code directory. After you have installed the package for
  64. one architecture, use `make distclean' before reconfiguring for another
  65. architecture.
  66. Installation Names
  67. ==================
  68. By default, `make install' will install the package's files in
  69. `/usr/local/bin', `/usr/local/man', etc. You can specify an
  70. installation prefix other than `/usr/local' by giving `configure' the
  71. option `--prefix=PATH'.
  72. You can specify separate installation prefixes for
  73. architecture-specific files and architecture-independent files. If you
  74. give `configure' the option `--exec-prefix=PATH', the package will use
  75. PATH as the prefix for installing programs and libraries.
  76. Documentation and other data files will still use the regular prefix.
  77. In addition, if you use an unusual directory layout you can give
  78. options like `--bindir=PATH' to specify different values for particular
  79. kinds of files. Run `configure --help' for a list of the directories
  80. you can set and what kinds of files go in them.
  81. If the package supports it, you can cause programs to be installed
  82. with an extra prefix or suffix on their names by giving `configure' the
  83. option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  84. Optional Features
  85. =================
  86. Some packages pay attention to `--enable-FEATURE' options to
  87. `configure', where FEATURE indicates an optional part of the package.
  88. They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  89. is something like `gnu-as' or `x' (for the X Window System). The
  90. `README' should mention any `--enable-' and `--with-' options that the
  91. package recognizes.
  92. For packages that use the X Window System, `configure' can usually
  93. find the X include and library files automatically, but if it doesn't,
  94. you can use the `configure' options `--x-includes=DIR' and
  95. `--x-libraries=DIR' to specify their locations.
  96. Specifying the System Type
  97. ==========================
  98. There may be some features `configure' can not figure out
  99. automatically, but needs to determine by the type of host the package
  100. will run on. Usually `configure' can figure that out, but if it prints
  101. a message saying it can not guess the host type, give it the
  102. `--host=TYPE' option. TYPE can either be a short name for the system
  103. type, such as `sun4', or a canonical name with three fields:
  105. See the file `config.sub' for the possible values of each field. If
  106. `config.sub' isn't included in this package, then this package doesn't
  107. need to know the host type.
  108. If you are building compiler tools for cross-compiling, you can also
  109. use the `--target=TYPE' option to select the type of system they will
  110. produce code for and the `--build=TYPE' option to select the type of
  111. system on which you are compiling the package.
  112. Sharing Defaults
  113. ================
  114. If you want to set default values for `configure' scripts to share,
  115. you can create a site shell script called `' that gives
  116. default values for variables like `CC', `cache_file', and `prefix'.
  117. `configure' looks for `PREFIX/share/' if it exists, then
  118. `PREFIX/etc/' if it exists. Or, you can set the
  119. `CONFIG_SITE' environment variable to the location of the site script.
  120. A warning: not all `configure' scripts look for a site script.
  121. Operation Controls
  122. ==================
  123. `configure' recognizes the following options to control how it
  124. operates.
  125. `--cache-file=FILE'
  126. Use and save the results of the tests in FILE instead of
  127. `./config.cache'. Set FILE to `/dev/null' to disable caching, for
  128. debugging `configure'.
  129. `--help'
  130. Print a summary of the options to `configure', and exit.
  131. `--quiet'
  132. `--silent'
  133. `-q'
  134. Do not print messages saying which checks are being made. To
  135. suppress all normal output, redirect it to `/dev/null' (any error
  136. messages will still be shown).
  137. `--srcdir=DIR'
  138. Look for the package's source code in directory DIR. Usually
  139. `configure' can determine that directory automatically.
  140. `--version'
  141. Print the version of Autoconf used to generate the `configure'
  142. script, and exit.
  143. `configure' also accepts some other, not widely useful, options.