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