INSTALL

   1 Installation Instructions for GNU pspp
   2 **************************************
   3
   4 These instructions are based on the generic GNU installation
   5 instructions, but they have been tailored for PSPP.  These instructions
   6 apply only to people wishing to build and install PSPP from source.
   7
   8 Overview
   9 ========
  10
  11 PSPP uses the standard GNU configuration system.  Therefore, if all is well,
  12 the following simple procedure should work, even on non-GNU systems:
  13
  14  tar -xzf pspp-*.tar.gz
  15  cd pspp-*
  16  ./configure
  17  make
  18  sudo make install
  19
  20 Obviously, you should replace 'pspp-*' in the above, with the name of
  21 the tarball you are installing.
  22
  23 In 99% of cases, that is all you have to do - FINISHED!
  24
  25
  26
  27
  28 If any part of the above process fails, then it is
  29 likely that one or more of the necessary prerequisites is missing
  30 from your system.  The following paragraphs contain highly detailed
  31 information which will help you fix this.
  32
  33
  34 Before You Install
  35 ==================
  36
  37 Before you install PSPP, you will need to install certain prerequisite
  38 packages.  You may also want to install other packages that enable
  39 additional functionality in PSPP.
  40
  41 If you do not know whether you have these installed already, you may
  42 proceed to "Basic Installation", below.  The PSPP configuration
  43 process will notify you about required and optional packages that are
  44 not present on your system.
  45
  46 The following packages are required to install PSPP:
  47
  48     * A C compiler and tool chain.  On Unix-like systems, we
  49       recommend GCC, but any modern compilation environment should
  50       work.  On Microsoft Windows, Cygwin (http://www.cygwin.com/) and
  51       MinGW (http://www.mingw.org/) are known to work.
  52
  53     * The GNU Scientific Library (http://www.gnu.org/software/gsl/),
  54       version 1.13 or later, including libgslcblas included with GSL.
  55
  56     * Perl (http://www.perl.org/), version 5.005_03 or later.  Perl is
  57       required during build but not after installation.
  58
  59     * iconv, which should be installed as part of a Unix-like system.
  60       If you don't have a version already, you can install GNU
  61       libiconv (http://www.gnu.org/software/libiconv/).
  62
  63     * libintl, from GNU gettext (http://www.gnu.org/software/gettext).
  64       GNU libc includes an integrated libintl, so there is no need to
  65       separately install libintl on a GNU/Linux system.
  66
  67     * zlib (http://www.zlib.net/).
  68
  69 The following packages are required to enable PSPP's graphing
  70 features.  If you cannot arrange to install them, you must run
  71 `configure' with --without-cairo (in which case you will get no graphing
  72 capability).
  73
  74     * Cairo (http://cairographics.org/), version 1.5 or later.
  75
  76     * Pango (http://www.pango.org/), version 1.22 or later.
  77
  78 The following packages are required to enable PSPPIRE, the graphical
  79 user interface for PSPP.  If you cannot install them or do not wish to
  80 use the GUI, you must run `configure' with --without-gui.
  81
  82     * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
  83       0.18 and 0.19 have a bug that will prevent library detection,
  84       but other versions should be fine.
  85
  86     * GTK+ (http://www.gtk.org/), version 2.24.0  -  The Gtk+-3.x series will NOT work!
  87
  88     * GtkSourceView (http://projects.gnome.org/gtksourceview/)
  89       version 2.2 or later.
  90
  91 The following packages are optional:
  92
  93 Installing the following packages will allow your PSPP program to read
  94 Gnumeric files.
  95
  96     * libxml2 (http://xmlsoft.org/).
  97
  98 Installing the following packages will allow your PSPP program to write
  99 OpenDocument text (ODT) files:
 100
 101     * libxml2 (http://xmlsoft.org/).
 102
 103 Other optional packages:
 104
 105     * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
 106       PSPP will assume it is running in an 80x25 terminal.
 107
 108     * libreadline and libhistory
 109       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
 110       them, interactive command editing and history features in the
 111       text-based user interface will be disabled.
 112
 113     * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or
 114       later.  Installing Texinfo will allow you to build PSPP
 115       documentation in PostScript or PDF format.
 116
 117     * libpq, from Postgresql (http://postgresql.org).  This enables PSPP
 118       to read Postgresql databases.  The tests for the Postgresql
 119       interface, but not the Postgresql interface itself, requires the
 120       Postgresql server to be installed.
 121
 122     * The Text::Diff module for Perl (http://cpan.org).  This enables
 123       PSPP to test the Perl module more thoroughly.  It is not needed
 124       to build or use the Perl module.
 125
 126 Basic Installation
 127 ==================
 128
 129 These are installation instructions specific to PSPP (including PSPPIRE,
 130 the graphic user interface).  These instructions contain the
 131 information most commonly needed by people wishing to build the
 132 program from source.  More detailed information can be found in the
 133 generic autoconf manual which is available at
 134 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
 135
 136    The `configure' shell script attempts to guess correct values for
 137 various system-dependent variables used during compilation.
 138
 139    If you need to do unusual things to compile the package, please
 140 report the problem to bug-gnu-pspp@gnu.org.  We will try to figure out
 141 how `configure' could work better in your situation for the next
 142 release.
 143
 144    The simplest way to compile PSPP is:
 145
 146   1. `cd' to the directory containing the package's source code and type
 147      `./configure' to configure the package for your system.
 148
 149      You may invoke `configure' with --help to see what options are
 150      available.  The most common of these are listed under "Optional
 151      Features", below.
 152
 153      It is best to build and install PSPP in directories whose names do
 154      not contain unusual characters such as spaces or single-quotes, due
 155      to limitations of the tools involved in the build process.
 156
 157      If you installed some of the libraries that PSPP uses in a
 158      non-standard location (on many systems, anywhere other than
 159      /usr), you may need to provide some special flags to `configure'
 160      to tell it where to find them.  For example, on GNU/Linux, if you
 161      installed some libraries in /usr/local, then you need to invoke
 162      it with at least the following options:
 163
 164         ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
 165
 166      Running `configure' takes awhile.  While running, it prints some
 167      messages telling which features it is checking for.
 168
 169      If `configure' completes successfully, it prints the message
 170      "PSPP configured successfully." at the end of its run.
 171      Otherwise, it may stop with a list of packages that you must
 172      install before PSPP.  If it does, you need to install those
 173      packages, then re-run this step.  Some prerequisites may be
 174      omitted by passing a --without-<feature> flag to `configure' (see
 175      "Optional Features", below).  If you use one of these flags, then
 176      the feature that it disables will not be available in your PSPP
 177      installation.
 178
 179      `configure' may also print a list of packages that you should
 180      consider installing.  If you install them, then re-run
 181      `configure', additional features will be available in your PSPP
 182      installation.
 183
 184   2. Type `make' to compile the package.
 185
 186   3. Optionally, type `make check' to run the self-tests that come
 187      with the package.  If any of the self-tests fail, please mail
 188      bug-gnu-pspp@gnu.org with the details, to give the PSPP
 189      developers an opportunity to fix the problem in the next release.
 190
 191   4. Type `make install' to install the programs and any data files
 192      and documentation.  Ordinarily you will need root permissions to
 193      do this.  The "su" and "sudo" commands are common ways to obtain
 194      root permissions.  If you cannot get root permissions, see
 195      "Installation Names", below.
 196
 197      Please note:  The `make install' target does NOT install the perl
 198      module (see below).  To install the perl module, you must change to
 199      the `perl-module' directory and manually run `make install' there.
 200
 201   5. You can remove the program binaries and object files from the
 202      source code directory by typing `make clean'.  To also remove the
 203      files that `configure' created (so you can compile the package for
 204      a different kind of computer), type `make distclean'.
 205
 206 Compilers and Options
 207 =====================
 208
 209 Some systems may require unusual options for compilation or linking that the
 210 `configure' script does not know about.  Run `./configure --help' for
 211 details on some of the pertinent environment variables.
 212
 213    You can give `configure' initial values for configuration parameters
 214 by setting variables in the command line or in the environment.  Here
 215 is an example:
 216
 217      ./configure CC=c89 CFLAGS=-O0 LIBS=-lposix
 218
 219 To cross-compile PSPP, you will likely need to set the
 220 PKG_CONFIG_LIBDIR environment variable to point to an
 221 appropriate pkg-config for the cross-compilation environment.
 222
 223 See "Defining Variables", below, for more details.
 224
 225 Installation Names
 226 ==================
 227
 228 By default, `make install' installs PSPP's commands under
 229 `/usr/local/bin', data files under `/usr/local/share', etc.  You
 230 can specify an installation prefix other than `/usr/local' by giving
 231 `configure' the option `--prefix=PREFIX'.
 232
 233    You may wish to install PSPP on a machine where you do not have
 234 root permissions.  To do so, specify a prefix relative within your
 235 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'.  All
 236 PSPP files will be installed under the prefix directory, which `make
 237 install' will create if necessary.  You may run PSPP directly from the
 238 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
 239 under most shells, or for added convenience you can add the
 240 installation directory to your PATH by editing a shell startup file
 241 such as `.bashrc'.
 242
 243    You can specify separate installation prefixes for
 244 architecture-specific files and architecture-independent files.  If you
 245 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
 246 PREFIX as the prefix for installing programs and libraries.
 247 Documentation and other data files still use the regular prefix.
 248
 249    In addition, if you use an unusual directory layout you can give
 250 options like `--bindir=DIR' to specify different values for particular
 251 kinds of files.  Run `configure --help' for a list of the directories
 252 you can set and what kinds of files go in them.
 253
 254    You can cause programs to be installed with an extra prefix or
 255 suffix on their names by giving `configure' the  option
 256 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 257
 258 Optional Features
 259 =================
 260
 261 `--without-cairo'
 262     Don't compile in support for charts (using Cairo and Pango).  This
 263     is useful if your system lacks these libraries.
 264
 265 `--without-gui'
 266     Don't build the PSPPIRE gui.  Use this option if you only want to
 267     build the command line version of PSPP.
 268
 269     Cairo and Pango required to build the GUI, so --without-cairo
 270     implies --without-gui.
 271
 272 `--with-gui-tools'
 273     Build the gui developer tools.  There is no reason to use this
 274     option unless you're involved with the development of PSPP
 275
 276 `--without-lib{xx}'
 277     Optional libraries should normally be detected and the relevant
 278     functionality will be built they exist.  However, on some poorly
 279     configured systems a library may exist, but be totally broken.
 280     In these cases you can use --without-lib{xx} to force configure
 281     to disregard it.
 282
 283 `--without-perl-module'
 284    Disable building the Perl module, in case it does not build properly
 285    or you do not need it.
 286
 287 `--enable-relocatable'
 288    This option is useful for building a package which can be installed
 289    into an arbitrary directory and freely copied to any other directory.
 290    If you use this option, you will probably want to install the pspp
 291    with a command similar to "make install DESTDIR=<destination>".
 292
 293 Defining Variables
 294 ==================
 295
 296 Variables not defined in a site shell script can be set in the
 297 environment passed to `configure'.  However, some packages may run
 298 configure again during the build, and the customized values of these
 299 variables may be lost.  In order to avoid this problem, you should set
 300 them in the `configure' command line, using `VAR=value'.  For example:
 301
 302      ./configure CC=/usr/local2/bin/gcc
 303
 304 causes the specified `gcc' to be used as the C compiler (unless it is
 305 overridden in the site shell script).  Here is another example:
 306
 307      /bin/bash ./configure CONFIG_SHELL=/bin/bash
 308
 309 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
 310 configuration-related scripts to be executed by `/bin/bash'.
 311
 312 Generic `configure' Options
 313 ===========================
 314
 315 `configure' also recognizes the following options to control how it operates.
 316
 317 `--help'
 318 `-h'
 319      Print a summary of the options to `configure', and exit.
 320
 321 `--version'
 322 `-V'
 323      Print the version of Autoconf used to generate the `configure'
 324      script, and exit.
 325
 326 `--cache-file=FILE'
 327      Enable the cache: use and save the results of the tests in FILE,
 328      traditionally `config.cache'.  FILE defaults to `/dev/null' to
 329      disable caching.
 330
 331 `--config-cache'
 332 `-C'
 333      Alias for `--cache-file=config.cache'.
 334
 335 `--quiet'
 336 `--silent'
 337 `-q'
 338      Do not print messages saying which checks are being made.  To
 339      suppress all normal output, redirect it to `/dev/null' (any error
 340      messages will still be shown).
 341
 342 `--srcdir=DIR'
 343      Look for the package's source code in directory DIR.  Usually
 344      `configure' can determine that directory automatically.
 345
 346 `configure' also accepts some other, not widely useful, options.  Run
 347 `configure --help' for more details.
 348
 349 ----------------------------------------------------------------------
 350 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2013 Free
 351 Software Foundation, Inc.
 352
 353 This file is free documentation; the Free Software Foundation gives
 354 unlimited permission to copy, distribute and modify it.
 355