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