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