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     * libglade (http://www.jamesh.id.au/software/libglade/), version
  54       2.6 or later.
  55
  56 Installing the following packages will allow your PSPP binary to read
  57 Gnumeric files.
  58
  59     * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
  60       0.18 and 0.19 have a bug that will prevent library detection,
  61       but other versions should be fine.
  62
  63       To cross-compile PSPP, you will likely need to set the
  64       PKG_CONFIG_LIBDIR environment variable to point to an
  65       appropriate pkg-config for the cross-compilation environment.
  66
  67     * zlib (http://www.zlib.net/).
  68
  69     * libxml2 (http://xmlsoft.org/).
  70
  71 The following packages are optional.
  72
  73     * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
  74       PSPP will assume it is running in an 80x25 terminal.
  75
  76     * libreadline and libhistory
  77       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
  78       them, interactive command editing and history features in the
  79       text-based user interface will be disabled.
  80
  81     * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or
  82       later.  Installing Texinfo will allow you to build PSPP
  83       documentation in PostScript or PDF format.
  84
  85     * libpq, from Postgresql (http://postgresql.org). This enables PSPP
  86       to read Postgresql databases.
  87
  88 Basic Installation
  89 ==================
  90
  91 These are installation instructions specific to PSPP (including PSPPIRE,
  92 the graphic user interface).  These instructions contain the
  93 information most commonly needed by people wishing to build the
  94 program from source.  More detailed information can be found in the
  95 generic autoconf manual which is available at
  96 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
  97
  98    The `configure' shell script attempts to guess correct values for
  99 various system-dependent variables used during compilation.
 100
 101    If you need to do unusual things to compile the package, please
 102 report the problem to bug-gnu-pspp@gnu.org.  We will try to figure out
 103 how `configure' could work better in your situation for the next
 104 release.
 105
 106    The simplest way to compile PSPP is:
 107
 108   1. `cd' to the directory containing the package's source code and type
 109      `./configure' to configure the package for your system.
 110
 111      Running `configure' takes awhile.  While running, it prints some
 112      messages telling which features it is checking for.
 113
 114      If `configure' completes successfully, it prints the message
 115      "PSPP configured successfully." at the end of its run.
 116      Otherwise, it may stop with a list of packages that you must
 117      install before PSPP.  If it does, you need to install those
 118      packages, then re-run this step.  Some prerequisites may be
 119      omitted by passing a --without-<feature> flag to `configure' (see
 120      "Optional Features", below).  If you use one of these flags, then
 121      the feature that it disables will not be available in your PSPP
 122      installation.
 123
 124      `configure' may also print a list of packages that you should
 125      consider installing.  If you install them, then re-run
 126      `configure', additional features will be available in your PSPP
 127      installation.
 128
 129   2. Type `make' to compile the package.
 130
 131   3. Optionally, type `make check' to run the self-tests that come
 132      with the package.  If any of the self-tests fail, please mail
 133      bug-gnu-pspp@gnu.org with the details, to give the PSPP
 134      developers an opportunity to fix the problem in the next release.
 135
 136   4. Type `make install' to install the programs and any data files
 137      and documentation.  Ordinarily you will need root permissions to
 138      do this; if you cannot get root permissions, see "Installation
 139      Names", below.
 140
 141   5. You can remove the program binaries and object files from the
 142      source code directory by typing `make clean'.  To also remove the
 143      files that `configure' created (so you can compile the package for
 144      a different kind of computer), type `make distclean'.
 145
 146 Compilers and Options
 147 =====================
 148
 149 Some systems may require unusual options for compilation or linking that the
 150 `configure' script does not know about.  Run `./configure --help' for
 151 details on some of the pertinent environment variables.
 152
 153    You can give `configure' initial values for configuration parameters
 154 by setting variables in the command line or in the environment.  Here
 155 is an example:
 156
 157      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 158
 159    See "Defining Variables", below, for more details.
 160
 161 Installation Names
 162 ==================
 163
 164 By default, `make install' installs PSPP's commands under
 165 `/usr/local/bin', data files under `/usr/local/share', etc.  You
 166 can specify an installation prefix other than `/usr/local' by giving
 167 `configure' the option `--prefix=PREFIX'.
 168
 169    You may wish to install PSPP on a machine where you do not have
 170 root permissions.  To do so, specify a prefix relative within your
 171 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'.  All
 172 PSPP files will be installed under the prefix directory, which `make
 173 install' will create if necessary.  You may run PSPP directly from the
 174 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
 175 under most shells, or for added convenience you can add the
 176 installation directory to your PATH by editing a shell startup file
 177 such as `.bashrc'.
 178
 179    You can specify separate installation prefixes for
 180 architecture-specific files and architecture-independent files.  If you
 181 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 182 PREFIX as the prefix for installing programs and libraries.
 183 Documentation and other data files still use the regular prefix.
 184
 185    In addition, if you use an unusual directory layout you can give
 186 options like `--bindir=DIR' to specify different values for particular
 187 kinds of files.  Run `configure --help' for a list of the directories
 188 you can set and what kinds of files go in them.
 189
 190    You can cause programs to be installed with an extra prefix or
 191 suffix on their names by giving `configure' the  option
 192 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 193
 194 Optional Features
 195 =================
 196
 197 `--without-libplot'
 198     Don't compile in support for charts (using libplot).  This is
 199     useful if your system doesn't have the libplot library.
 200
 201 `--without-gui'
 202     Don't build the PSPPIRE gui.  Use this option if you only want to
 203     build the command line version of PSPP.
 204
 205 `--with-gui-tools'
 206     Build the gui developer tools.  There is no reason to use this
 207     option unless you're involved with the development of PSPP
 208
 209 `--without-lib{xx}'
 210     Optional libraries should normally be detected and the relevant
 211     functionality will be built they exist.  However, on some poorly
 212     configured systems a library may exist, but be totally broken.
 213     In these cases you can use --without-lib{xx} to force configure
 214     to disregard it.
 215
 216 `--enable-anachronistic-dependencies'
 217    If you use this option, some of the checks for dependent libraries
 218    will be relaxed, permitting configure to succeed when older versions
 219    of libraries are detected.   Use of this option is not recommended.
 220    If you use it, some features may be missing and the build may fail
 221    with obscure error messages.
 222
 223
 224 Defining Variables
 225 ==================
 226
 227 Variables not defined in a site shell script can be set in the
 228 environment passed to `configure'.  However, some packages may run
 229 configure again during the build, and the customized values of these
 230 variables may be lost.  In order to avoid this problem, you should set
 231 them in the `configure' command line, using `VAR=value'.  For example:
 232
 233      ./configure CC=/usr/local2/bin/gcc
 234
 235 causes the specified `gcc' to be used as the C compiler (unless it is
 236 overridden in the site shell script).  Here is another example:
 237
 238      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 239
 240 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 241 configuration-related scripts to be executed by `/bin/bash'.
 242
 243 Generic `configure' Options
 244 ===========================
 245
 246 `configure' also recognizes the following options to control how it 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
 280 ----------------------------------------------------------------------
 281 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
 282 Software Foundation, Inc.
 283
 284 This file is free documentation; the Free Software Foundation gives
 285 unlimited permission to copy, distribute and modify it.
 286