home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / grep20.zip / INSTALL < prev    next >
Text File  |  1992-09-28  |  5KB  |  111 lines

  1. This is a generic INSTALL file for utilities distributions.
  2. If this package does not come with, e.g., installable documentation or
  3. data files, please ignore the references to them below.
  4.  
  5. To compile this package:
  6.  
  7. 1.  Configure the package for your system.  In the directory that this
  8. file is in, type `./configure'.  If you're using `csh' on an old
  9. version of System V, you might need to type `sh configure' instead to
  10. prevent `csh' from trying to execute `configure' itself.
  11.  
  12. The `configure' shell script attempts to guess correct values for
  13. various system-dependent variables used during compilation, and
  14. creates the Makefile(s) (one in each subdirectory of the source
  15. directory).  In some packages it creates a C header file containing
  16. system-dependent definitions.  It also creates a file `config.status'
  17. that you can run in the future to recreate the current configuration.
  18.  
  19. Running `configure' takes a minute or two.  While it is running, it
  20. prints some messages that tell what it is doing.  If you don't want to
  21. see the messages, run `configure' with its standard output redirected
  22. to `/dev/null'; for example, `./configure >/dev/null'.
  23.  
  24. To compile the package in a different directory from the one
  25. containing the source code, you must use a version of make that
  26. supports the VPATH variable, such as GNU make.  `cd' to the directory
  27. where you want the object files and executables to go and run
  28. `configure' with the option `--srcdir=DIR', where DIR is the directory
  29. that contains the source code.  Using this option is actually
  30. unnecessary if the source code is in the parent directory of the one
  31. in which you are compiling; `configure' automatically checks for the
  32. source code in `..' if it does not find it in the current directory.
  33.  
  34. By default, `make install' will install the package's files in
  35. /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
  36. an installation prefix other than /usr/local by giving `configure' the
  37. option `--prefix=PATH'.  Alternately, you can do so by changing the
  38. `prefix' variable in the Makefile that `configure' creates (the
  39. Makefile in the top-level directory, if the package contains
  40. subdirectories).
  41.  
  42. You can specify separate installation prefixes for
  43. architecture-specific files and architecture-independent files.  If
  44. you give `configure' the option `--exec_prefix=PATH', the package will
  45. use PATH as the prefix for installing programs and libraries.  Data
  46. files and documentation will still use the regular prefix.  Normally,
  47. all files are installed using the regular prefix.
  48.  
  49. You can tell `configure' to figure out the configuration for your
  50. system, and record it in `config.status', without actually configuring
  51. the package (creating `Makefile's and perhaps a configuration header
  52. file).  To do this, give `configure' the `--no-create' option.  Later,
  53. you can run `./config.status' to actually configure the package.  This
  54. option is useful mainly in `Makefile' rules for updating `config.status'
  55. and `Makefile'.  You can also give `config.status' the `--recheck'
  56. option, which makes it re-run `configure' with the same arguments you
  57. used before.  This is useful if you change `configure'.
  58.  
  59. `configure' ignores any other arguments that you give it.
  60.  
  61. If your system requires unusual options for compilation or linking
  62. that `configure' doesn't know about, you can give `configure' initial
  63. values for some variables by setting them in the environment.  In
  64. Bourne-compatible shells, you can do that on the command line like
  65. this:
  66.     CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
  67.  
  68. The `make' variables that you might want to override with environment
  69. variables when running `configure' are:
  70.  
  71. (For these variables, any value given in the environment overrides the
  72. value that `configure' would choose:)
  73. CC        C compiler program.
  74.         Default is `cc', or `gcc' if `gcc' is in your PATH.
  75. INSTALL        Program to use to install files.
  76.         Default is `install' if you have it, `cp' otherwise.
  77.  
  78. (For these variables, any value given in the environment is added to
  79. the value that `configure' chooses:)
  80. DEFS        Configuration options, in the form `-Dfoo -Dbar ...'
  81. LIBS        Libraries to link with, in the form `-lfoo -lbar ...'
  82.  
  83. If you need to do unusual things to compile the package, we encourage
  84. you to figure out how `configure' could check whether to do them, and
  85. mail diffs or instructions to the address given in the README so we
  86. can include them in the next release.
  87.  
  88. 2.  Type `make' to compile the package.  If you want, you can override
  89. the `make' variables CFLAGS and LDFLAGS like this:
  90.  
  91.     make CFLAGS=-O2 LDFLAGS=-s
  92.  
  93. 3.  If the package comes with self-tests and you want to run them,
  94. type `make check'.  If you're not sure whether there are any, try it;
  95. if `make' responds with something like
  96.     make: *** No way to make target `check'.  Stop.
  97. then the package does not come with self-tests.
  98.  
  99. 4.  Type `make install' to install programs, data files, and
  100. documentation.
  101.  
  102. 5.  You can remove the program binaries and object files from the
  103. source directory by typing `make clean'.  To also remove the
  104. Makefile(s), the header file containing system-dependent definitions
  105. (if the package uses one), and `config.status' (all the files that
  106. `configure' created), type `make distclean'.
  107.  
  108. The file `configure.in' is used as a template to create `configure' by
  109. a program called `autoconf'.  You will only need it if you want to
  110. regenerate `configure' using a newer version of `autoconf'.
  111.