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