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