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