home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / gnurx.zip / INSTALL < prev    next >
Text File  |  1995-12-31  |  5KB  |  115 lines
  1. Recommended short-cut when using a generic make(1) program.
  2.  
  3.     % tar -zxvf <this-dist>.tar.gz
  4.     % cd <this-dist>
  5.     % mkdir =inst
  6.     % ./configure --prefix=`pwd`/=inst
  7.     % make install
  8.  
  9. That will compile everything and install under ./=inst.  For example,
  10. `pwd`/=inst/bin will contain the executables.
  11.  
  12.  
  13. Recommended short-cut when using GNU Make.  This uses the VPATH
  14. feature to keep the intermediate files apart from the source files.
  15.  
  16.     % tar -zxvf <this-dist>.tar.gz
  17.     % cd <this-dist>
  18.     % mkdir =inst
  19.     % mkdir =build
  20.     % cd =build
  21.     % ../configure --prefix=`pwd`/../=inst
  22.     % make install
  23.  
  24. That will also install everything in =inst, but the object
  25. files will all be contained under =build.
  26.  
  27.  
  28. The rest of this file is generic INSTALL documentation for utilities
  29. distributions.
  30.  
  31. To compile this package:
  32.  
  33. 1.  Configure the package for your system.  In the directory that this
  34. file is in, type `./configure'.  If you're using `csh' on an old
  35. version of System V, you might need to type `sh configure' instead to
  36. prevent `csh' from trying to execute `configure' itself.
  37.  
  38. The `configure' shell script attempts to guess correct values for
  39. various system-dependent variables used during compilation, and
  40. creates the Makefile(s) (one in each subdirectory of the source
  41. directory).  In some packages it creates a C header file containing
  42. system-dependent definitions.  It also creates a file `config.status'
  43. that you can run in the future to recreate the current configuration.
  44. Running `configure' takes a minute or two.
  45.  
  46. To compile the package in a different directory from the one
  47. containing the source code, you must use GNU make.  `cd' to the
  48. directory where you want the object files and executables to go and
  49. run `configure' with the option `--srcdir=DIR', where DIR is the
  50. directory that contains the source code.  Using this option is
  51. actually unnecessary if the source code is in the parent directory of
  52. the one in which you are compiling; `configure' automatically checks
  53. for the source code in `..' if it does not find it in the current
  54. directory.
  55.  
  56. By default, `make install' will install the package's files in
  57. /usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
  58. an installation prefix other than /usr/local by giving `configure' the
  59. option `--prefix=PATH'.  Alternately, you can do so by changing the
  60. `prefix' variable in the Makefile that `configure' creates (the
  61. Makefile in the top-level directory, if the package contains
  62. subdirectories).
  63.  
  64. You can specify separate installation prefixes for machine-specific
  65. files and machine-independent files.  If you give `configure' the
  66. option `--exec_prefix=PATH', the package will use PATH as the prefix
  67. for installing programs and libraries.  Normally, all files are
  68. installed using the same prefix.
  69.  
  70. `configure' ignores any other arguments that you give it.
  71.  
  72. If your system requires unusual options for compilation or linking
  73. that `configure' doesn't know about, you can give `configure' initial
  74. values for some variables by setting them in the environment.  In
  75. Bourne-compatible shells, you can do that on the command line like
  76. this:
  77.     CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
  78.  
  79. The `make' variables that you might want to override with environment
  80. variables when running `configure' are:
  81.  
  82. (For these variables, any value given in the environment overrides the
  83. value that `configure' would choose:)
  84. CC        C compiler program.
  85.         Default is `cc', or `gcc' if `gcc' is in your PATH.
  86. INSTALL        Program to use to install files.
  87.         Default is `install' if you have it, `cp' otherwise.
  88. INCLUDEDIR    Directory for `configure' to search for include files.
  89.         Default is /usr/include.
  90.  
  91. (For these variables, any value given in the environment is added to
  92. the value that `configure' chooses:)
  93. DEFS        Configuration options, in the form '-Dfoo -Dbar ...'
  94. LIBS        Libraries to link with, in the form '-lfoo -lbar ...'
  95.  
  96. If you need to do unusual things to compile the package, we encourage
  97. you to teach `configure' how to do them and mail the diffs to the
  98. address given in the README so we can include them in the next
  99. release.
  100.  
  101. 2.  Type `make' to compile the package.
  102.  
  103. 3.  Type `make install' to install programs, data files, and
  104. documentation.
  105.  
  106. 4.  You can remove the program binaries and object files from the
  107. source directory by typing `make clean'.  To also remove the
  108. Makefile(s), the header file containing system-dependent definitions
  109. (if the package uses one), and `config.status' (all the files that
  110. `configure' created), type `make distclean'.
  111.  
  112. The file `configure.in' is used as a template to create `configure' by
  113. a program called `autoconf'.  You will only need it if you want to
  114. regenerate `configure' using a newer version of `autoconf'.
  115.