INSTALL

   1 Release Notes
   2 =============
   3
   4 PSPP has the following library dependencies;
   5
   6     * The GNU Scientific Library (libgsl), version 1.6 or later.
   7
   8     * libplot from GNU plotutils is optional.  Without it, the new
   9       graphing features will not work.  If you do not have it
  10       installed, you must run `configure' with --without-libplot.
  11
  12     * ncurses and GNU readline are optional.  They make for a more pleasant
  13       command line interface.
  14
  15 PSPP also has the following build dependencies:
  16
  17     * perl 5.6 or later.
  18
  19     * GNU diff, for `make check' to complete properly.  (We intend to
  20       eliminate this dependency in a later release.)
  21
  22 A few system-specific issues have been noted.  These may be PSPP bugs
  23 or system bugs; we have not yet been able to track them down precisely:
  24
  25     * On Solaris, one or more tests may fail `make check'.  We have
  26       only seen this reported on Solaris 9 with GCC 3.4.2.  Our
  27       reporter says that turning off optimization (with -O0) at least
  28       masked the symptoms.
  29
  30     * On Mac OS X, GCC 4.0.0 build 4061 has been observed to cause
  31       some tests to fail.  Later builds should work fine.
  32
  33 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
  34 Foundation, Inc.
  35
  36    This file is free documentation; the Free Software Foundation gives
  37 unlimited permission to copy, distribute and modify it.
  38
  39 Basic Installation
  40 ==================
  41
  42    These are generic installation instructions.
  43
  44    The `configure' shell script attempts to guess correct values for
  45 various system-dependent variables used during compilation.  It uses
  46 those values to create a `Makefile' in each directory of the package.
  47 It may also create one or more `.h' files containing system-dependent
  48 definitions.  Finally, it creates a shell script `config.status' that
  49 you can run in the future to recreate the current configuration, and a
  50 file `config.log' containing compiler output (useful mainly for
  51 debugging `configure').
  52
  53    It can also use an optional file (typically called `config.cache'
  54 and enabled with `--cache-file=config.cache' or simply `-C') that saves
  55 the results of its tests to speed up reconfiguring.  (Caching is
  56 disabled by default to prevent problems with accidental use of stale
  57 cache files.)
  58
  59    If you need to do unusual things to compile the package, please try
  60 to figure out how `configure' could check whether to do them, and mail
  61 diffs or instructions to the address given in the `README' so they can
  62 be considered for the next release.  If you are using the cache, and at
  63 some point `config.cache' contains results you don't want to keep, you
  64 may remove or edit it.
  65
  66    The file `configure.ac' (or `configure.in') is used to create
  67 `configure' by a program called `autoconf'.  You only need
  68 `configure.ac' if you want to change it or regenerate `configure' using
  69 a newer version of `autoconf'.
  70
  71 The simplest way to compile this package is:
  72
  73   1. `cd' to the directory containing the package's source code and type
  74      `./configure' to configure the package for your system.  If you're
  75      using `csh' on an old version of System V, you might need to type
  76      `sh ./configure' instead to prevent `csh' from trying to execute
  77      `configure' itself.
  78
  79      Running `configure' takes awhile.  While running, it prints some
  80      messages telling which features it is checking for.
  81
  82   2. Type `make' to compile the package.
  83
  84   3. Optionally, type `make check' to run any self-tests that come with
  85      the package.
  86
  87   4. Type `make install' to install the programs and any data files and
  88      documentation.
  89
  90   5. You can remove the program binaries and object files from the
  91      source code directory by typing `make clean'.  To also remove the
  92      files that `configure' created (so you can compile the package for
  93      a different kind of computer), type `make distclean'.  There is
  94      also a `make maintainer-clean' target, but that is intended mainly
  95      for the package's developers.  If you use it, you may have to get
  96      all sorts of other programs in order to regenerate files that came
  97      with the distribution.
  98
  99 Compilers and Options
 100 =====================
 101
 102    Some systems require unusual options for compilation or linking that
 103 the `configure' script does not know about.  Run `./configure --help'
 104 for details on some of the pertinent environment variables.
 105
 106    You can give `configure' initial values for configuration parameters
 107 by setting variables in the command line or in the environment.  Here
 108 is an example:
 109
 110      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 111
 112    *Note Defining Variables::, for more details.
 113
 114 Compiling For Multiple Architectures
 115 ====================================
 116
 117    You can compile the package for more than one kind of computer at the
 118 same time, by placing the object files for each architecture in their
 119 own directory.  To do this, you must use a version of `make' that
 120 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 121 directory where you want the object files and executables to go and run
 122 the `configure' script.  `configure' automatically checks for the
 123 source code in the directory that `configure' is in and in `..'.
 124
 125    If you have to use a `make' that does not support the `VPATH'
 126 variable, you have to compile the package for one architecture at a
 127 time in the source code directory.  After you have installed the
 128 package for one architecture, use `make distclean' before reconfiguring
 129 for another architecture.
 130
 131 Installation Names
 132 ==================
 133
 134    By default, `make install' will install the package's files in
 135 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 136 installation prefix other than `/usr/local' by giving `configure' the
 137 option `--prefix=PATH'.
 138
 139    You can specify separate installation prefixes for
 140 architecture-specific files and architecture-independent files.  If you
 141 give `configure' the option `--exec-prefix=PATH', the package will use
 142 PATH as the prefix for installing programs and libraries.
 143 Documentation and other data files will still use the regular prefix.
 144
 145    In addition, if you use an unusual directory layout you can give
 146 options like `--bindir=PATH' to specify different values for particular
 147 kinds of files.  Run `configure --help' for a list of the directories
 148 you can set and what kinds of files go in them.
 149
 150    If the package supports it, you can cause programs to be installed
 151 with an extra prefix or suffix on their names by giving `configure' the
 152 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 153
 154 Optional Features
 155 =================
 156
 157    Some packages pay attention to `--enable-FEATURE' options to
 158 `configure', where FEATURE indicates an optional part of the package.
 159 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 160 is something like `gnu-as' or `x' (for the X Window System).  The
 161 `README' should mention any `--enable-' and `--with-' options that the
 162 package recognizes.
 163
 164    For packages that use the X Window System, `configure' can usually
 165 find the X include and library files automatically, but if it doesn't,
 166 you can use the `configure' options `--x-includes=DIR' and
 167 `--x-libraries=DIR' to specify their locations.
 168
 169 Specifying the System Type
 170 ==========================
 171
 172    There may be some features `configure' cannot figure out
 173 automatically, but needs to determine by the type of machine the package
 174 will run on.  Usually, assuming the package is built to be run on the
 175 _same_ architectures, `configure' can figure that out, but if it prints
 176 a message saying it cannot guess the machine type, give it the
 177 `--build=TYPE' option.  TYPE can either be a short name for the system
 178 type, such as `sun4', or a canonical name which has the form:
 179
 180      CPU-COMPANY-SYSTEM
 181
 182 where SYSTEM can have one of these forms:
 183
 184      OS KERNEL-OS
 185
 186    See the file `config.sub' for the possible values of each field.  If
 187 `config.sub' isn't included in this package, then this package doesn't
 188 need to know the machine type.
 189
 190    If you are _building_ compiler tools for cross-compiling, you should
 191 use the `--target=TYPE' option to select the type of system they will
 192 produce code for.
 193
 194    If you want to _use_ a cross compiler, that generates code for a
 195 platform different from the build platform, you should specify the
 196 "host" platform (i.e., that on which the generated programs will
 197 eventually be run) with `--host=TYPE'.
 198
 199 Sharing Defaults
 200 ================
 201
 202    If you want to set default values for `configure' scripts to share,
 203 you can create a site shell script called `config.site' that gives
 204 default values for variables like `CC', `cache_file', and `prefix'.
 205 `configure' looks for `PREFIX/share/config.site' if it exists, then
 206 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 207 `CONFIG_SITE' environment variable to the location of the site script.
 208 A warning: not all `configure' scripts look for a site script.
 209
 210 Defining Variables
 211 ==================
 212
 213    Variables not defined in a site shell script can be set in the
 214 environment passed to `configure'.  However, some packages may run
 215 configure again during the build, and the customized values of these
 216 variables may be lost.  In order to avoid this problem, you should set
 217 them in the `configure' command line, using `VAR=value'.  For example:
 218
 219      ./configure CC=/usr/local2/bin/gcc
 220
 221 will cause the specified gcc to be used as the C compiler (unless it is
 222 overridden in the site shell script).
 223
 224 `configure' Invocation
 225 ======================
 226
 227    `configure' recognizes the following options to control how it
 228 operates.
 229
 230 `--help'
 231 `-h'
 232      Print a summary of the options to `configure', and exit.
 233
 234 `--version'
 235 `-V'
 236      Print the version of Autoconf used to generate the `configure'
 237      script, and exit.
 238
 239 `--cache-file=FILE'
 240      Enable the cache: use and save the results of the tests in FILE,
 241      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 242      disable caching.
 243
 244 `--config-cache'
 245 `-C'
 246      Alias for `--cache-file=config.cache'.
 247
 248 `--quiet'
 249 `--silent'
 250 `-q'
 251      Do not print messages saying which checks are being made.  To
 252      suppress all normal output, redirect it to `/dev/null' (any error
 253      messages will still be shown).
 254
 255 `--srcdir=DIR'
 256      Look for the package's source code in directory DIR.  Usually
 257      `configure' can determine that directory automatically.
 258
 259 `configure' also accepts some other, not widely useful, options.  Run
 260 `configure --help' for more details.
 261