INSTALL

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