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