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