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