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