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