PageRenderTime 443ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/tags/rel-1-3-25/SWIG/INSTALL

#
#! | 226 lines | 174 code | 52 blank | 0 comment | 0 complexity | 5a6bb5939c003343446c522f1398a85e MD5 | raw file
Possible License(s): LGPL-2.1, Cube, GPL-3.0, 0BSD, GPL-2.0
  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, and a
  10. file `config.log' containing compiler output (useful mainly for
  11. debugging `configure').
  12. It can also use an optional file (typically called `config.cache'
  13. and enabled with `--cache-file=config.cache' or simply `-C') that saves
  14. the results of its tests to speed up reconfiguring. (Caching is
  15. disabled by default to prevent problems with accidental use of stale
  16. cache files.)
  17. If you need to do unusual things to compile the package, please try
  18. to figure out how `configure' could check whether to do them, and mail
  19. diffs or instructions to the address given in the `README' so they can
  20. be considered for the next release. If you are using the cache, and at
  21. some point `config.cache' contains results you don't want to keep, you
  22. may remove or edit it.
  23. The file `configure.ac' (or `configure.in') is used to create
  24. `configure' by a program called `autoconf'. You only need
  25. `configure.ac' if you want to change it or regenerate `configure' using
  26. 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. Run `./configure --help'
  52. for details on some of the pertinent environment variables.
  53. You can give `configure' initial values for variables by setting
  54. them in the environment. You can do that on the command line like this:
  55. ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
  56. *Note Environment Variables::, for more details.
  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 support 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' cannot 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 cannot guess the host type, give it the
  107. `--build=TYPE' option. TYPE can either be a short name for the system
  108. type, such as `sun4', or a canonical name which has the form:
  109. CPU-COMPANY-SYSTEM
  110. where SYSTEM can have one of these forms:
  111. OS
  112. KERNEL-OS
  113. See the file `config.sub' for the possible values of each field. If
  114. `config.sub' isn't included in this package, then this package doesn't
  115. need to know the host type.
  116. If you are _building_ compiler tools for cross-compiling, you should
  117. use the `--target=TYPE' option to select the type of system they will
  118. produce code for.
  119. If you want to _use_ a cross compiler, that generates code for a
  120. platform different from the build platform, you should specify the host
  121. platform (i.e., that on which the generated programs will eventually be
  122. run) with `--host=TYPE'. In this case, you should also specify the
  123. build platform with `--build=TYPE', because, in this case, it may not
  124. be possible to guess the build platform (it sometimes involves
  125. compiling and running simple test programs, and this can't be done if
  126. the compiler is a cross compiler).
  127. Sharing Defaults
  128. ================
  129. If you want to set default values for `configure' scripts to share,
  130. you can create a site shell script called `config.site' that gives
  131. default values for variables like `CC', `cache_file', and `prefix'.
  132. `configure' looks for `PREFIX/share/config.site' if it exists, then
  133. `PREFIX/etc/config.site' if it exists. Or, you can set the
  134. `CONFIG_SITE' environment variable to the location of the site script.
  135. A warning: not all `configure' scripts look for a site script.
  136. Environment Variables
  137. =====================
  138. Variables not defined in a site shell script can be set in the
  139. environment passed to configure. However, some packages may run
  140. configure again during the build, and the customized values of these
  141. variables may be lost. In order to avoid this problem, you should set
  142. them in the `configure' command line, using `VAR=value'. For example:
  143. ./configure CC=/usr/local2/bin/gcc
  144. will cause the specified gcc to be used as the C compiler (unless it is
  145. overridden in the site shell script).
  146. `configure' Invocation
  147. ======================
  148. `configure' recognizes the following options to control how it
  149. operates.
  150. `--help'
  151. `-h'
  152. Print a summary of the options to `configure', and exit.
  153. `--version'
  154. `-V'
  155. Print the version of Autoconf used to generate the `configure'
  156. script, and exit.
  157. `--cache-file=FILE'
  158. Enable the cache: use and save the results of the tests in FILE,
  159. traditionally `config.cache'. FILE defaults to `/dev/null' to
  160. disable caching.
  161. `--config-cache'
  162. `-C'
  163. Alias for `--cache-file=config.cache'.
  164. `--quiet'
  165. `--silent'
  166. `-q'
  167. Do not print messages saying which checks are being made. To
  168. suppress all normal output, redirect it to `/dev/null' (any error
  169. messages will still be shown).
  170. `--srcdir=DIR'
  171. Look for the package's source code in directory DIR. Usually
  172. `configure' can determine that directory automatically.
  173. `configure' also accepts some other, not widely useful, options. Run
  174. `configure --help' for more details.