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