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