INSTALL 8.0 KB

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