INSTALL 7.8 KB

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