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      You may invoke `configure' with --help to see what options are
 112      available.  The most common of these are listed under "Optional
 113      Features", below.
 114
 115      If you installed some of the libraries that PSPP uses in a
 116      non-standard location (on many systems, anywhere other than
 117      /usr), you may need to provide some special flags to `configure'
 118      to tell it where to find them.  For example, on GNU/Linux, if you
 119      installed some libraries in /usr/local, then you need to invoke
 120      it with at least the following options:
 121
 122         ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
 123
 124      Running `configure' takes awhile.  While running, it prints some
 125      messages telling which features it is checking for.
 126
 127      If `configure' completes successfully, it prints the message
 128      "PSPP configured successfully." at the end of its run.
 129      Otherwise, it may stop with a list of packages that you must
 130      install before PSPP.  If it does, you need to install those
 131      packages, then re-run this step.  Some prerequisites may be
 132      omitted by passing a --without-<feature> flag to `configure' (see
 133      "Optional Features", below).  If you use one of these flags, then
 134      the feature that it disables will not be available in your PSPP
 135      installation.
 136
 137      `configure' may also print a list of packages that you should
 138      consider installing.  If you install them, then re-run
 139      `configure', additional features will be available in your PSPP
 140      installation.
 141
 142   2. Type `make' to compile the package.
 143
 144   3. Optionally, type `make check' to run the self-tests that come
 145      with the package.  If any of the self-tests fail, please mail
 146      bug-gnu-pspp@gnu.org with the details, to give the PSPP
 147      developers an opportunity to fix the problem in the next release.
 148
 149   4. Type `make install' to install the programs and any data files
 150      and documentation.  Ordinarily you will need root permissions to
 151      do this; if you cannot get root permissions, see "Installation
 152      Names", below.
 153
 154   5. You can remove the program binaries and object files from the
 155      source code directory by typing `make clean'.  To also remove the
 156      files that `configure' created (so you can compile the package for
 157      a different kind of computer), type `make distclean'.
 158
 159 Compilers and Options
 160 =====================
 161
 162 Some systems may require unusual options for compilation or linking that the
 163 `configure' script does not know about.  Run `./configure --help' for
 164 details on some of the pertinent environment variables.
 165
 166    You can give `configure' initial values for configuration parameters
 167 by setting variables in the command line or in the environment.  Here
 168 is an example:
 169
 170      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 171
 172    See "Defining Variables", below, for more details.
 173
 174 Installation Names
 175 ==================
 176
 177 By default, `make install' installs PSPP's commands under
 178 `/usr/local/bin', data files under `/usr/local/share', etc.  You
 179 can specify an installation prefix other than `/usr/local' by giving
 180 `configure' the option `--prefix=PREFIX'.
 181
 182    You may wish to install PSPP on a machine where you do not have
 183 root permissions.  To do so, specify a prefix relative within your
 184 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'.  All
 185 PSPP files will be installed under the prefix directory, which `make
 186 install' will create if necessary.  You may run PSPP directly from the
 187 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
 188 under most shells, or for added convenience you can add the
 189 installation directory to your PATH by editing a shell startup file
 190 such as `.bashrc'.
 191
 192    You can specify separate installation prefixes for
 193 architecture-specific files and architecture-independent files.  If you
 194 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 195 PREFIX as the prefix for installing programs and libraries.
 196 Documentation and other data files still use the regular prefix.
 197
 198    In addition, if you use an unusual directory layout you can give
 199 options like `--bindir=DIR' to specify different values for particular
 200 kinds of files.  Run `configure --help' for a list of the directories
 201 you can set and what kinds of files go in them.
 202
 203    You can cause programs to be installed with an extra prefix or
 204 suffix on their names by giving `configure' the  option
 205 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 206
 207 Optional Features
 208 =================
 209
 210 `--without-libplot'
 211     Don't compile in support for charts (using libplot).  This is
 212     useful if your system doesn't have the libplot library.
 213
 214 `--without-gui'
 215     Don't build the PSPPIRE gui.  Use this option if you only want to
 216     build the command line version of PSPP.
 217
 218 `--with-gui-tools'
 219     Build the gui developer tools.  There is no reason to use this
 220     option unless you're involved with the development of PSPP
 221
 222 `--without-lib{xx}'
 223     Optional libraries should normally be detected and the relevant
 224     functionality will be built they exist.  However, on some poorly
 225     configured systems a library may exist, but be totally broken.
 226     In these cases you can use --without-lib{xx} to force configure
 227     to disregard it.
 228
 229 `--enable-anachronistic-dependencies'
 230    If you use this option, some of the checks for dependent libraries
 231    will be relaxed, permitting configure to succeed when older versions
 232    of libraries are detected.   Use of this option is not recommended.
 233    If you use it, some features may be missing and the build may fail
 234    with obscure error messages.
 235
 236
 237 Defining Variables
 238 ==================
 239
 240 Variables not defined in a site shell script can be set in the
 241 environment passed to `configure'.  However, some packages may run
 242 configure again during the build, and the customized values of these
 243 variables may be lost.  In order to avoid this problem, you should set
 244 them in the `configure' command line, using `VAR=value'.  For example:
 245
 246      ./configure CC=/usr/local2/bin/gcc
 247
 248 causes the specified `gcc' to be used as the C compiler (unless it is
 249 overridden in the site shell script).  Here is another example:
 250
 251      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 252
 253 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 254 configuration-related scripts to be executed by `/bin/bash'.
 255
 256 Generic `configure' Options
 257 ===========================
 258
 259 `configure' also recognizes the following options to control how it operates.
 260
 261 `--help'
 262 `-h'
 263      Print a summary of the options to `configure', and exit.
 264
 265 `--version'
 266 `-V'
 267      Print the version of Autoconf used to generate the `configure'
 268      script, and exit.
 269
 270 `--cache-file=FILE'
 271      Enable the cache: use and save the results of the tests in FILE,
 272      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 273      disable caching.
 274
 275 `--config-cache'
 276 `-C'
 277      Alias for `--cache-file=config.cache'.
 278
 279 `--quiet'
 280 `--silent'
 281 `-q'
 282      Do not print messages saying which checks are being made.  To
 283      suppress all normal output, redirect it to `/dev/null' (any error
 284      messages will still be shown).
 285
 286 `--srcdir=DIR'
 287      Look for the package's source code in directory DIR.  Usually
 288      `configure' can determine that directory automatically.
 289
 290 `configure' also accepts some other, not widely useful, options.  Run
 291 `configure --help' for more details.
 292
 293 ----------------------------------------------------------------------
 294 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
 295 Software Foundation, Inc.
 296
 297 This file is free documentation; the Free Software Foundation gives
 298 unlimited permission to copy, distribute and modify it.
 299