INSTALL

   1 Installation Instructions for GNU pspp
   2 **************************************
   3
   4 These instructions are based on the generic GNU installation
   5 instructions, but they have been tailored for PSPP.
   6
   7 Before You Install
   8 ==================
   9
  10 Before you install PSPP, you will need to install certain prerequisite
  11 packages.  You may also want to install other packages that enable
  12 additional functionality in PSPP.
  13
  14 If you do not know whether you have these installed already, you may
  15 proceed to "Basic Installation", below.  The PSPP configuration
  16 process will notify you about required and optional packages that are
  17 not present on your system.
  18
  19 The following packages are required to install PSPP:
  20
  21     * An ANSI C compiler and tool chain.  On Unix-like systems, we
  22       recommend GCC, but any modern compilation environment should
  23       work.  On Microsoft Windows, Cygwin (http://www.cygwin.com/) and
  24       MinGW (http://www.mingw.org/) are known to work.
  25
  26     * The GNU Scientific Library (http://www.gnu.org/software/gsl/),
  27       version 1.6 or later, including libgslcblas included with GSL.
  28
  29     * Perl (http://www.perl.org/), version 5.005_03 or later.  Perl is
  30       required during build but not after installation.
  31
  32     * iconv, which should be installed as part of a Unix-like system.
  33       If you don't have a version already, you can install GNU
  34       libiconv (http://www.gnu.org/software/libiconv/).
  35
  36 The following package is required to enable PSPP's graphing features.
  37 If you cannot arrange to install it, you must run `configure' with
  38 --without-libplot.
  39
  40     * libplot, from GNU plotutils
  41       (http://www.gnu.org/software/plotutils/).
  42
  43 The following packages are required to enable PSPPIRE, the graphical
  44 user interface for PSPP.  If you cannot install them or do not wish to
  45 use the GUI, you must run `configure' with --without-gui.
  46
  47     * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
  48       0.18 and 0.19 have a bug that will prevent library detection,
  49       but other versions should be fine.
  50
  51     * GTK+ (http://www.gtk.org/), version 2.12.0 or later.
  52
  53 Installing the following packages will allow your PSPP binary to read
  54 Gnumeric files.
  55
  56     * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
  57       0.18 and 0.19 have a bug that will prevent library detection,
  58       but other versions should be fine.
  59
  60       To cross-compile PSPP, you will likely need to set the
  61       PKG_CONFIG_LIBDIR environment variable to point to an
  62       appropriate pkg-config for the cross-compilation environment.
  63
  64     * zlib (http://www.zlib.net/).
  65
  66     * libxml2 (http://xmlsoft.org/).
  67
  68 The following packages are optional.
  69
  70     * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
  71       PSPP will assume it is running in an 80x25 terminal.
  72
  73     * libreadline and libhistory
  74       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
  75       them, interactive command editing and history features in the
  76       text-based user interface will be disabled.
  77
  78     * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or
  79       later.  Installing Texinfo will allow you to build PSPP
  80       documentation in PostScript or PDF format.
  81
  82     * libpq, from Postgresql (http://postgresql.org). This enables PSPP
  83       to read Postgresql databases.
  84
  85 Basic Installation
  86 ==================
  87
  88 These are installation instructions specific to PSPP (including PSPPIRE,
  89 the graphic user interface).  These instructions contain the
  90 information most commonly needed by people wishing to build the
  91 program from source.  More detailed information can be found in the
  92 generic autoconf manual which is available at
  93 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
  94
  95    The `configure' shell script attempts to guess correct values for
  96 various system-dependent variables used during compilation.
  97
  98    If you need to do unusual things to compile the package, please
  99 report the problem to bug-gnu-pspp@gnu.org.  We will try to figure out
 100 how `configure' could work better in your situation for the next
 101 release.
 102
 103    The simplest way to compile PSPP is:
 104
 105   1. `cd' to the directory containing the package's source code and type
 106      `./configure' to configure the package for your system.
 107
 108      You may invoke `configure' with --help to see what options are
 109      available.  The most common of these are listed under "Optional
 110      Features", below.
 111
 112      It is best to build and install PSPP in directories whose names do
 113      not contain unusual characters such as spaces or single-quotes, due
 114      to limitations of the tools involved in the build process.
 115
 116      If you installed some of the libraries that PSPP uses in a
 117      non-standard location (on many systems, anywhere other than
 118      /usr), you may need to provide some special flags to `configure'
 119      to tell it where to find them.  For example, on GNU/Linux, if you
 120      installed some libraries in /usr/local, then you need to invoke
 121      it with at least the following options:
 122
 123         ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
 124
 125      Running `configure' takes awhile.  While running, it prints some
 126      messages telling which features it is checking for.
 127
 128      If `configure' completes successfully, it prints the message
 129      "PSPP configured successfully." at the end of its run.
 130      Otherwise, it may stop with a list of packages that you must
 131      install before PSPP.  If it does, you need to install those
 132      packages, then re-run this step.  Some prerequisites may be
 133      omitted by passing a --without-<feature> flag to `configure' (see
 134      "Optional Features", below).  If you use one of these flags, then
 135      the feature that it disables will not be available in your PSPP
 136      installation.
 137
 138      `configure' may also print a list of packages that you should
 139      consider installing.  If you install them, then re-run
 140      `configure', additional features will be available in your PSPP
 141      installation.
 142
 143   2. Type `make' to compile the package.
 144
 145   3. Optionally, type `make check' to run the self-tests that come
 146      with the package.  If any of the self-tests fail, please mail
 147      bug-gnu-pspp@gnu.org with the details, to give the PSPP
 148      developers an opportunity to fix the problem in the next release.
 149
 150   4. Type `make install' to install the programs and any data files
 151      and documentation.  Ordinarily you will need root permissions to
 152      do this.  The "su" and "sudo" commands are common ways to obtain
 153      root permissions.  If you cannot get root permissions, see
 154      "Installation Names", below.
 155
 156   5. You can remove the program binaries and object files from the
 157      source code directory by typing `make clean'.  To also remove the
 158      files that `configure' created (so you can compile the package for
 159      a different kind of computer), type `make distclean'.
 160
 161 Compilers and Options
 162 =====================
 163
 164 Some systems may require unusual options for compilation or linking that the
 165 `configure' script does not know about.  Run `./configure --help' for
 166 details on some of the pertinent environment variables.
 167
 168    You can give `configure' initial values for configuration parameters
 169 by setting variables in the command line or in the environment.  Here
 170 is an example:
 171
 172      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 173
 174    See "Defining Variables", below, for more details.
 175
 176 Installation Names
 177 ==================
 178
 179 By default, `make install' installs PSPP's commands under
 180 `/usr/local/bin', data files under `/usr/local/share', etc.  You
 181 can specify an installation prefix other than `/usr/local' by giving
 182 `configure' the option `--prefix=PREFIX'.
 183
 184    You may wish to install PSPP on a machine where you do not have
 185 root permissions.  To do so, specify a prefix relative within your
 186 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'.  All
 187 PSPP files will be installed under the prefix directory, which `make
 188 install' will create if necessary.  You may run PSPP directly from the
 189 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
 190 under most shells, or for added convenience you can add the
 191 installation directory to your PATH by editing a shell startup file
 192 such as `.bashrc'.
 193
 194    You can specify separate installation prefixes for
 195 architecture-specific files and architecture-independent files.  If you
 196 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 197 PREFIX as the prefix for installing programs and libraries.
 198 Documentation and other data files still use the regular prefix.
 199
 200    In addition, if you use an unusual directory layout you can give
 201 options like `--bindir=DIR' to specify different values for particular
 202 kinds of files.  Run `configure --help' for a list of the directories
 203 you can set and what kinds of files go in them.
 204
 205    You can cause programs to be installed with an extra prefix or
 206 suffix on their names by giving `configure' the  option
 207 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 208
 209 Optional Features
 210 =================
 211
 212 `--without-libplot'
 213     Don't compile in support for charts (using libplot).  This is
 214     useful if your system doesn't have the libplot library.
 215
 216 `--without-gui'
 217     Don't build the PSPPIRE gui.  Use this option if you only want to
 218     build the command line version of PSPP.
 219
 220 `--with-gui-tools'
 221     Build the gui developer tools.  There is no reason to use this
 222     option unless you're involved with the development of PSPP
 223
 224 `--without-lib{xx}'
 225     Optional libraries should normally be detected and the relevant
 226     functionality will be built they exist.  However, on some poorly
 227     configured systems a library may exist, but be totally broken.
 228     In these cases you can use --without-lib{xx} to force configure
 229     to disregard it.
 230
 231 `--enable-anachronistic-dependencies'
 232    If you use this option, some of the checks for dependent libraries
 233    will be relaxed, permitting configure to succeed when older versions
 234    of libraries are detected.   Use of this option is not recommended.
 235    If you use it, some features may be missing and the build may fail
 236    with obscure error messages.
 237
 238 `--enable-relocatable'
 239    This option is useful for building a package which can be installed
 240    into an arbitrary directory and freely copied to any other directory.
 241    If you use this option, you will probably want to install the pspp
 242    with a command similar to "make install DESTDIR=<distination>".
 243
 244 Defining Variables
 245 ==================
 246
 247 Variables not defined in a site shell script can be set in the
 248 environment passed to `configure'.  However, some packages may run
 249 configure again during the build, and the customized values of these
 250 variables may be lost.  In order to avoid this problem, you should set
 251 them in the `configure' command line, using `VAR=value'.  For example:
 252
 253      ./configure CC=/usr/local2/bin/gcc
 254
 255 causes the specified `gcc' to be used as the C compiler (unless it is
 256 overridden in the site shell script).  Here is another example:
 257
 258      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 259
 260 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 261 configuration-related scripts to be executed by `/bin/bash'.
 262
 263 Generic `configure' Options
 264 ===========================
 265
 266 `configure' also recognizes the following options to control how it operates.
 267
 268 `--help'
 269 `-h'
 270      Print a summary of the options to `configure', and exit.
 271
 272 `--version'
 273 `-V'
 274      Print the version of Autoconf used to generate the `configure'
 275      script, and exit.
 276
 277 `--cache-file=FILE'
 278      Enable the cache: use and save the results of the tests in FILE,
 279      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 280      disable caching.
 281
 282 `--config-cache'
 283 `-C'
 284      Alias for `--cache-file=config.cache'.
 285
 286 `--quiet'
 287 `--silent'
 288 `-q'
 289      Do not print messages saying which checks are being made.  To
 290      suppress all normal output, redirect it to `/dev/null' (any error
 291      messages will still be shown).
 292
 293 `--srcdir=DIR'
 294      Look for the package's source code in directory DIR.  Usually
 295      `configure' can determine that directory automatically.
 296
 297 `configure' also accepts some other, not widely useful, options.  Run
 298 `configure --help' for more details.
 299
 300 ----------------------------------------------------------------------
 301 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
 302 Software Foundation, Inc.
 303
 304 This file is free documentation; the Free Software Foundation gives
 305 unlimited permission to copy, distribute and modify it.
 306