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