INSTALL

   1 -*- Text -*-
   2
   3 This is the PUPA.  Welcome.
   4
   5 This file contains instructions for compiling and installing the PUPA.
   6
   7 The Requirements
   8 ================
   9
  10 PUPA depends on some software packages installed into your system. If
  11 you don't have any of them, please obtain and install them before
  12 configuring the PUPA.
  13
  14 * GCC 2.95 or later
  15 * GNU Make
  16 * GNU binutils 2.9.1.0.23 or later
  17 * Other standard GNU/Unix tools
  18
  19 If you'd like to develop PUPA, these below are also required.
  20
  21 * Ruby 1.6 or later
  22 * Autoconf 2.53 or later
  23
  24 Configuring the PUPA
  25 ====================
  26
  27 The `configure' shell script attempts to guess correct values for
  28 various system-dependent variables used during compilation.  It uses
  29 those values to create a `Makefile' in each directory of the package.
  30 It may also create one or more `.h' files containing system-dependent
  31 definitions.  Finally, it creates a shell script `config.status' that
  32 you can run in the future to recreate the current configuration, a
  33 file `config.cache' that saves the results of its tests to speed up
  34 reconfiguring, and a file `config.log' containing compiler output
  35 (useful mainly for debugging `configure').
  36
  37 If you need to do unusual things to compile the package, please try to
  38 figure out how `configure' could check whether to do them, and mail
  39 diffs or instructions to the address given in the `README' so they can
  40 be considered for the next release.  If at some point `config.cache'
  41 contains results you don't want to keep, you may remove or edit it.
  42
  43 The file `configure.ac' is used to create `configure' by a program
  44 called `autoconf'.  You only need `configure.in' if you want to change
  45 it or regenerate `configure' using a newer version of `autoconf'.
  46
  47
  48 Building the PUPA
  49 =================
  50
  51 The simplest way to compile this package is:
  52
  53   1. `cd' to the directory containing the package's source code and
  54      type `./configure' to configure the package for your system.  If
  55      you're using `csh' on an old version of System V, you might need
  56      to type `sh ./configure' instead to prevent `csh' from trying to
  57      execute `configure' itself.
  58
  59      Running `configure' takes awhile.  While running, it prints some
  60      messages telling which features it is checking for.
  61
  62   2. Type `make' to compile the package.
  63
  64   3. Optionally, type `make check' to run any self-tests that come with
  65      the package.
  66
  67   4. Type `make install' to install the programs and any data files and
  68      documentation.
  69
  70   5. You can remove the program binaries and object files from the
  71      source code directory by typing `make clean'.  To also remove the
  72      files that `configure' created (so you can compile the package for
  73      a different kind of computer), type `make distclean'.  There is
  74      also a `make maintainer-clean' target, but that is intended mainly
  75      for the package's developers.  If you use it, you may have to get
  76      all sorts of other programs in order to regenerate files that came
  77      with the distribution.
  78
  79
  80 Compiling For Multiple Architectures
  81 ====================================
  82
  83 You can compile the package for more than one kind of computer at the
  84 same time, by placing the object files for each architecture in their
  85 own directory.  `cd' to the directory where you want the object files
  86 and executables to go and run the `configure' script.  `configure'
  87 automatically checks for the source code in the directory that
  88 `configure' is in and in `..'.
  89
  90
  91 Installation Names
  92 ==================
  93
  94 By default, `make install' will install the package's files in
  95 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
  96 installation prefix by giving `configure' the option `--prefix=PATH'.
  97
  98 You can specify separate installation prefixes for
  99 architecture-specific files and architecture-independent files.  If
 100 you give `configure' the option `--exec-prefix=PATH', the package will
 101 use PATH as the prefix for installing programs and libraries.
 102 Documentation and other data files will still use the regular prefix.
 103
 104 In addition, if you use an unusual directory layout you can give
 105 options like `--bindir=PATH' to specify different values for
 106 particular kinds of files.  Run `configure --help' for a list of the
 107 directories you can set and what kinds of files go in them.
 108
 109 If the package supports it, you can cause programs to be installed
 110 with an extra prefix or suffix on their names by giving `configure'
 111 the option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 112
 113 Please note, however, that the PUPA knows where it is located in the
 114 filesystem.  If you have installed it in an unusual location, the
 115 system might not work properly, or at all.  The chief utility of these
 116 options for the PUPA is to allow you to "install" in some alternate
 117 location, and then copy these to the actual root filesystem later.
 118
 119
 120 Sharing Defaults
 121 ================
 122
 123 If you want to set default values for `configure' scripts to share,
 124 you can create a site shell script called `config.site' that gives
 125 default values for variables like `CC', `cache_file', and `prefix'.
 126 `configure' looks for `PREFIX/share/config.site' if it exists, then
 127 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 128 `CONFIG_SITE' environment variable to the location of the site script.
 129 A warning: not all `configure' scripts look for a site script.
 130
 131
 132 Operation Controls
 133 ==================
 134
 135    `configure' recognizes the following options to control how it
 136 operates.
 137
 138 `--cache-file=FILE'
 139      Use and save the results of the tests in FILE instead of
 140      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 141      debugging `configure'.
 142
 143 `--help'
 144      Print a summary of the options to `configure', and exit.
 145
 146 `--quiet'
 147 `--silent'
 148 `-q'
 149      Do not print messages saying which checks are being made.
 150
 151 `--srcdir=DIR'
 152      Look for the package's source code in directory DIR.  Usually
 153      `configure' can determine that directory automatically.
 154
 155 `--version'
 156      Print the version of Autoconf used to generate the `configure'
 157      script, and exit.