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