home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / vile-src.zip / vile-8.1 / INSTALL < prev    next >
Text File  |  1998-05-21  |  6KB  |  155 lines
  1.  
  2. This is a generic document provided with most packages which use
  3. the GNU autoconf/configure system to achieve system portability.
  4. For vile-specific build/installation information, see doc/config.doc.
  5.  
  6. $Header: /usr/build/vile/vile/RCS/INSTALL,v 1.6 1998/05/22 00:55:14 tom Exp $
  7. --------------------------------
  8.  
  9.    This is a generic INSTALL file for utilities distributions.
  10. If this package does not come with, e.g., installable documentation or
  11. data files, please ignore the references to them below.
  12.  
  13.    The `configure' shell script attempts to guess correct values for
  14. various system-dependent variables used during compilation, and
  15. creates the makefile(s) (one in each subdirectory of the source
  16. directory).  In some packages it creates a C header file containing
  17. system-dependent definitions.  It also creates a file `config.status'
  18. that you can run in the future to recreate the current configuration.
  19.  
  20. To compile this package:
  21.  
  22. 1.  Configure the package for your system.
  23.  
  24.    Normally, you just `cd' to the directory containing the package's
  25. source code and type `./configure'.  If you're using `csh' on an old
  26. version of System V, you might need to type `sh configure' instead to
  27. prevent `csh' from trying to execute `configure' itself.
  28.  
  29.    Running `configure' takes awhile.  While it is running, it
  30. prints some messages that tell what it is doing.  If you don't want to
  31. see any messages, run `configure' with its standard output redirected
  32. to `/dev/null'; for example, `./configure >/dev/null'.
  33.  
  34.    To compile the package in a different directory from the one
  35. containing the source code, you must use a version of `make' that
  36. supports the `VPATH' variable, such as GNU `make'.  `cd' to the
  37. directory where you want the object files and executables to go and run
  38. the `configure' script.  `configure' automatically checks for the
  39. source code in the directory that `configure' is in and in `..'.  If
  40. for some reason `configure' is not in the source code directory that
  41. you are configuring, then it will report that it can't find the source
  42. code.  In that case, run `configure' with the option `--srcdir=DIR',
  43. where DIR is the directory that contains the source code.
  44.  
  45.    By default, `make install' will install the package's files in
  46. `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  47. installation prefix other than `/usr/local' by giving `configure' the
  48. option `--prefix=PATH'.  Alternately, you can do so by consistently
  49. giving a value for the `prefix' variable when you run `make', e.g.,
  50.      make prefix=/usr/gnu
  51.      make prefix=/usr/gnu install
  52.  
  53.    You can specify separate installation prefixes for
  54. architecture-specific files and architecture-independent files.  If you
  55. give `configure' the option `--exec-prefix=PATH' or set the `make'
  56. variable `exec_prefix' to PATH, the package will use PATH as the prefix
  57. for installing programs and libraries.  Data files and documentation
  58. will still use the regular prefix.  Normally, all files are installed
  59. using the same prefix.
  60.  
  61.    Some packages pay attention to `--with-PACKAGE' options to
  62. `configure', where PACKAGE is something like `gnu-as' or `x' (for the
  63. X Window System).  They may also pay attention to `--enable-FEATURE'
  64. options, where FEATURE indicates an optional part of the package.  The
  65. README should mention any `--with-' and `--enable-' options that the
  66. package recognizes.
  67.  
  68.    `configure' also recognizes the following options:
  69.  
  70. `--help'
  71.      Print a summary of the options to `configure', and exit.
  72.  
  73. `--quiet'
  74. `--silent'
  75.      Do not print messages saying which checks are being made.
  76.  
  77. `--verbose'
  78.      Print the results of the checks.
  79.  
  80. `--version'
  81.      Print the version of Autoconf used to generate the `configure'
  82.      script, and exit.
  83.  
  84. `--x-includes=DIR'
  85.      X include files are in DIR.
  86.  
  87. `--x-libraries=DIR'
  88.      X library files are in DIR.
  89.  
  90.    `configure' also accepts and ignores some other options.
  91.  
  92.    On systems that require unusual options for compilation or linking
  93. that the package's `configure' script does not know about, you can give
  94. `configure' initial values for variables by setting them in the
  95. environment.  In Bourne-compatible shells, you can do that on the
  96. command line like this:
  97.  
  98.      CC='gcc -traditional' LIBS=-lposix ./configure
  99.  
  100. On systems that have the `env' program, you can do it like this:
  101.  
  102.      env CC='gcc -traditional' LIBS=-lposix ./configure
  103.  
  104.    Here are the `make' variables that you might want to override with
  105. environment variables when running `configure'.
  106.  
  107.    For these variables, any value given in the environment overrides the
  108. value that `configure' would choose:
  109.  
  110.  - Variable: CC
  111.      C compiler program.  The default is `cc'.
  112.  
  113.  - Variable: INSTALL
  114.      Program to use to install files.  The default is `install' if you
  115.      have it, `cp' otherwise.
  116.  
  117.    For these variables, any value given in the environment is added to
  118. the value that `configure' chooses:
  119.  
  120.  - Variable: DEFS
  121.      Configuration options, in the form `-Dfoo -Dbar...'.  Do not use
  122.      this variable in packages that create a configuration header file.
  123.  
  124.  - Variable: LIBS
  125.      Libraries to link with, in the form `-lfoo -lbar...'.
  126.  
  127.    If you need to do unusual things to compile the package, we encourage
  128. you to figure out how `configure' could check whether to do them, and
  129. mail diffs or instructions to the address given in the README so we
  130. can include them in the next release.
  131.  
  132. 2.  Type `make' to compile the package.  If you want, you can override
  133. the `make' variables CFLAGS and LDFLAGS like this:
  134.  
  135.     make CFLAGS=-O2 LDFLAGS=-s
  136.  
  137. 3.  If the package comes with self-tests and you want to run them,
  138. type `make check'.  If you're not sure whether there are any, try it;
  139. if `make' responds with something like
  140.     make: *** No way to make target `check'.  Stop.
  141. then the package does not come with self-tests.
  142.  
  143. 4.  Type `make install' to install programs, data files, and
  144. documentation.
  145.  
  146. 5.  You can remove the program binaries and object files from the
  147. source directory by typing `make clean'.  To also remove the
  148. makefile(s), the header file containing system-dependent definitions
  149. (if the package uses one), and `config.status' (all the files that
  150. `configure' created), type `make distclean'.
  151.  
  152.    The file `configure.in' is used to create `configure' by a program
  153. called `autoconf'.  You only need it if you want to regenerate
  154. `configure' using a newer version of `autoconf'.
  155.