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