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