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