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