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