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