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     * libintl, from GNU gettext (http://ww.gnu.org/software/gettext).
  37       GNU libc includes an integrated libintl, so there is no need to
  38       separately install libintl on a GNU/Linux system.
  39
  40 The following packages are required to enable PSPP's graphing
  41 features.  If you cannot arrange to install them, you must run
  42 `configure' with --without-cairo.
  43
  44     * Cairo (http://cairographics.org/), version 1.5 or later.
  45
  46     * Pango (http://www.pango.org/), version 1.22 or later.
  47
  48 The following packages are required to enable PSPPIRE, the graphical
  49 user interface for PSPP.  If you cannot install them or do not wish to
  50 use the GUI, you must run `configure' with --without-gui.
  51
  52     * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
  53       0.18 and 0.19 have a bug that will prevent library detection,
  54       but other versions should be fine.
  55
  56     * GTK+ (http://www.gtk.org/), version 2.12.0 or later.
  57
  58 To cross-compile PSPP, you will likely need to set the
  59 PKG_CONFIG_LIBDIR environment variable to point to an
  60 appropriate pkg-config for the cross-compilation environment.
  61
  62 Installing the following packages will allow your PSPP binary to read
  63 Gnumeric files.
  64
  65     * zlib (http://www.zlib.net/).
  66
  67     * libxml2 (http://xmlsoft.org/).
  68
  69 Installing the following packages will allow your PSPP binary to write
  70 OpenDocument text (ODT) files:
  71
  72     * libxml2 (http://xmlsoft.org/).
  73
  74 The following packages are optional.
  75
  76     * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
  77       PSPP will assume it is running in an 80x25 terminal.
  78
  79     * libreadline and libhistory
  80       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
  81       them, interactive command editing and history features in the
  82       text-based user interface will be disabled.
  83
  84     * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or
  85       later.  Installing Texinfo will allow you to build PSPP
  86       documentation in PostScript or PDF format.
  87
  88     * libpq, from Postgresql (http://postgresql.org). This enables PSPP
  89       to read Postgresql databases.
  90
  91 Basic Installation
  92 ==================
  93
  94 These are installation instructions specific to PSPP (including PSPPIRE,
  95 the graphic user interface).  These instructions contain the
  96 information most commonly needed by people wishing to build the
  97 program from source.  More detailed information can be found in the
  98 generic autoconf manual which is available at
  99 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
 100
 101    The `configure' shell script attempts to guess correct values for
 102 various system-dependent variables used during compilation.
 103
 104    If you need to do unusual things to compile the package, please
 105 report the problem to bug-gnu-pspp@gnu.org.  We will try to figure out
 106 how `configure' could work better in your situation for the next
 107 release.
 108
 109    The simplest way to compile PSPP is:
 110
 111   1. `cd' to the directory containing the package's source code and type
 112      `./configure' to configure the package for your system.
 113
 114      You may invoke `configure' with --help to see what options are
 115      available.  The most common of these are listed under "Optional
 116      Features", below.
 117
 118      It is best to build and install PSPP in directories whose names do
 119      not contain unusual characters such as spaces or single-quotes, due
 120      to limitations of the tools involved in the build process.
 121
 122      If you installed some of the libraries that PSPP uses in a
 123      non-standard location (on many systems, anywhere other than
 124      /usr), you may need to provide some special flags to `configure'
 125      to tell it where to find them.  For example, on GNU/Linux, if you
 126      installed some libraries in /usr/local, then you need to invoke
 127      it with at least the following options:
 128
 129         ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
 130
 131      Running `configure' takes awhile.  While running, it prints some
 132      messages telling which features it is checking for.
 133
 134      If `configure' completes successfully, it prints the message
 135      "PSPP configured successfully." at the end of its run.
 136      Otherwise, it may stop with a list of packages that you must
 137      install before PSPP.  If it does, you need to install those
 138      packages, then re-run this step.  Some prerequisites may be
 139      omitted by passing a --without-<feature> flag to `configure' (see
 140      "Optional Features", below).  If you use one of these flags, then
 141      the feature that it disables will not be available in your PSPP
 142      installation.
 143
 144      `configure' may also print a list of packages that you should
 145      consider installing.  If you install them, then re-run
 146      `configure', additional features will be available in your PSPP
 147      installation.
 148
 149   2. Type `make' to compile the package.
 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-cairo'
 219     Don't compile in support for charts (using Cairo and Pango).  This
 220     is useful if your system lacks these libraries.
 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     Cairo and Pango required to build the GUI, so --without-cairo
 227     implies --without-gui.
 228
 229 `--with-gui-tools'
 230     Build the gui developer tools.  There is no reason to use this
 231     option unless you're involved with the development of PSPP
 232
 233 `--without-lib{xx}'
 234     Optional libraries should normally be detected and the relevant
 235     functionality will be built they exist.  However, on some poorly
 236     configured systems a library may exist, but be totally broken.
 237     In these cases you can use --without-lib{xx} to force configure
 238     to disregard it.
 239
 240 `--without-perl-module'
 241    Disable building the Perl module, in case it does not build properly
 242    or you do not need it.
 243
 244 `--enable-anachronistic-dependencies'
 245    If you use this option, some of the checks for dependent libraries
 246    will be relaxed, permitting configure to succeed when older versions
 247    of libraries are detected.   Use of this option is not recommended.
 248    If you use it, some features may be missing and the build may fail
 249    with obscure error messages.
 250
 251 `--enable-relocatable'
 252    This option is useful for building a package which can be installed
 253    into an arbitrary directory and freely copied to any other directory.
 254    If you use this option, you will probably want to install the pspp
 255    with a command similar to "make install DESTDIR=<distination>".
 256
 257 Defining Variables
 258 ==================
 259
 260 Variables not defined in a site shell script can be set in the
 261 environment passed to `configure'.  However, some packages may run
 262 configure again during the build, and the customized values of these
 263 variables may be lost.  In order to avoid this problem, you should set
 264 them in the `configure' command line, using `VAR=value'.  For example:
 265
 266      ./configure CC=/usr/local2/bin/gcc
 267
 268 causes the specified `gcc' to be used as the C compiler (unless it is
 269 overridden in the site shell script).  Here is another example:
 270
 271      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 272
 273 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 274 configuration-related scripts to be executed by `/bin/bash'.
 275
 276 Generic `configure' Options
 277 ===========================
 278
 279 `configure' also recognizes the following options to control how it operates.
 280
 281 `--help'
 282 `-h'
 283      Print a summary of the options to `configure', and exit.
 284
 285 `--version'
 286 `-V'
 287      Print the version of Autoconf used to generate the `configure'
 288      script, and exit.
 289
 290 `--cache-file=FILE'
 291      Enable the cache: use and save the results of the tests in FILE,
 292      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 293      disable caching.
 294
 295 `--config-cache'
 296 `-C'
 297      Alias for `--cache-file=config.cache'.
 298
 299 `--quiet'
 300 `--silent'
 301 `-q'
 302      Do not print messages saying which checks are being made.  To
 303      suppress all normal output, redirect it to `/dev/null' (any error
 304      messages will still be shown).
 305
 306 `--srcdir=DIR'
 307      Look for the package's source code in directory DIR.  Usually
 308      `configure' can determine that directory automatically.
 309
 310 `configure' also accepts some other, not widely useful, options.  Run
 311 `configure --help' for more details.
 312
 313 ----------------------------------------------------------------------
 314 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
 315 Software Foundation, Inc.
 316
 317 This file is free documentation; the Free Software Foundation gives
 318 unlimited permission to copy, distribute and modify it.
 319