1 Installation Instructions for GNU pspp
2 **************************************
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.
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:
14 tar -xzf pspp-*.tar.gz
20 Obviously, you should replace 'pspp-*' in the above, with the name of
21 the tarball you are installing.
23 In 99% of cases, that is all you have to do - FINISHED!
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.
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
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.
50 The following packages are required to install PSPP:
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.
57 * The GNU Scientific Library (http://www.gnu.org/software/gsl/),
58 version 1.13 or later, including libgslcblas included with GSL.
60 * Python (https://python.org/), version 3.4 or later. Python is
61 required during build but not after installation.
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/).
67 * Cairo (http://cairographics.org/), version 1.12 or later.
69 * Pango (http://www.pango.org/), version 1.22 or later.
71 * zlib (http://www.zlib.net/).
73 * libxml2 (http://xmlsoft.org/).
75 * gettext version 0.20 or later.
77 The following packages are required to enable PSPPIRE, the graphical
78 user interface for PSPP. If you cannot install them or do not wish to
79 use the GUI, you must run `configure' with --without-gui.
81 * pkg-config (http://pkg-config.freedesktop.org/wiki/). Versions
82 0.18 and 0.19 have a bug that will prevent library detection,
83 but other versions should be fine.
85 * GTK+ (http://www.gtk.org/), version 3.22.0 or later.
87 * GtkSourceView (http://projects.gnome.org/gtksourceview/)
88 version 3.x (3.4.2 or later) or 4.x.
90 * GNU Spread Sheet Widget (http://www.gnu.org/software/ssw)
93 The following packages are only needed to build and test the Perl
96 * Perl (https://www.perl.org/), version 5.005_03 or later.
98 * The Config::Perl::V module for Perl (https://cpan.org).
100 * Optionally, the Text::Diff module for Perl
101 (https://cpan.org). This module enables PSPP to test its Perl
102 module more thoroughly.
104 Other optional packages:
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.
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.
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.
123 These are installation instructions specific to PSPP (including PSPPIRE,
124 the graphic user interface). These instructions contain the
125 information most commonly needed by people wishing to build the
126 program from source. More detailed information can be found in the
127 generic autoconf manual which is available at
128 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
130 The `configure' shell script attempts to guess correct values for
131 various system-dependent variables used during compilation.
133 If you need to do unusual things to compile the package, please
134 report the problem to bug-gnu-pspp@gnu.org. We will try to figure out
135 how `configure' could work better in your situation for the next
138 The simplest way to compile PSPP is:
140 1. `cd' to the directory containing the package's source code and type
141 `./configure' to configure the package for your system.
143 You may invoke `configure' with --help to see what options are
144 available. The most common of these are listed under "Optional
147 It is best to build and install PSPP in directories whose names do
148 not contain unusual characters such as spaces or single-quotes, due
149 to limitations of the tools involved in the build process.
151 If you installed some of the libraries that PSPP uses in a
152 non-standard location (on many systems, anywhere other than
153 /usr), you may need to provide some special flags to `configure'
154 to tell it where to find them. For example, on GNU/Linux, if you
155 installed some libraries in /usr/local, then you need to invoke
156 it with at least the following options:
158 ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
160 Running `configure' takes awhile. While running, it prints some
161 messages telling which features it is checking for.
163 If `configure' completes successfully, it prints the message
164 "PSPP configured successfully." at the end of its run.
165 Otherwise, it may stop with a list of packages that you must
166 install before PSPP. If it does, you need to install those
167 packages, then re-run this step. Some prerequisites may be
168 omitted by passing a --without-<feature> flag to `configure' (see
169 "Optional Features", below). If you use one of these flags, then
170 the feature that it disables will not be available in your PSPP
173 `configure' may also print a list of packages that you should
174 consider installing. If you install them, then re-run
175 `configure', additional features will be available in your PSPP
178 2. Type `make' to compile the package.
180 3. Optionally, type `make check' to run the self-tests that come
181 with the package. If any of the self-tests fail, please mail
182 bug-gnu-pspp@gnu.org with the details, to give the PSPP
183 developers an opportunity to fix the problem in the next release.
185 4. Type `make install' to install the programs and any data files
186 and documentation. Ordinarily you will need root permissions to
187 do this. The "su" and "sudo" commands are common ways to obtain
188 root permissions. If you cannot get root permissions, see
189 "Installation Names", below.
191 Please note: The `make install' target does NOT install the perl
192 module (see below). To install the perl module, you must change to
193 the `perl-module' directory and manually run `make install' there.
195 5. You can remove the program binaries and object files from the
196 source code directory by typing `make clean'. To also remove the
197 files that `configure' created (so you can compile the package for
198 a different kind of computer), type `make distclean'.
200 Compilers and Options
201 =====================
203 Some systems may require unusual options for compilation or linking that the
204 `configure' script does not know about. Run `./configure --help' for
205 details on some of the pertinent environment variables.
207 You can give `configure' initial values for configuration parameters
208 by setting variables in the command line or in the environment. Here
211 ./configure CC=c89 CFLAGS=-O0 LIBS=-lposix
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.
220 Part of cross-compiling procedure builds a native binary. Therefore, you
221 will need not only the dependent libraries for your target, but also for the
222 build machine. This is because the native version is used to create
223 examples for the user manual.
225 To do a windows cross compilation on a debian build machine, the mingw64
226 cross build system can be used. First you have to install the build
229 sudo apt install -y build-essential python3 perl texinfo texlive \
230 libgsl-dev libgtk-3-dev libgtksourceview-3.0-dev \
231 pkg-config gperf git zip curl autoconf libtool \
232 gettext libreadline-dev appstream \
233 mingw-w64 meson ninja-build \
234 imagemagick wget nsis texlive-plain-generic
236 To build windows 64bit installers from the latest nightly do the following steps
239 sandboxdir=`pwd`/sandbox
240 curl -o pspp.tgz https://benpfaff.org/~blp/pspp-master/latest-source.tar.gz
242 ./pspp-<version>/Windows/build-dependencies --arch=x86_64-w64-mingw32 --sandbox=$sandboxdir
245 ../pspp-<version>/configure --host="x86_64-w64-mingw32" \
246 CPPFLAGS="-I$sandboxdir/Install/include" \
247 LDFLAGS="-L$sandboxdir/Install/lib" \
248 PKG_CONFIG_LIBDIR="$sandboxdir/Install/lib/pkgconfig" \
249 --prefix=$sandboxdir/psppinst \
255 make Windows/installers
257 The windows installers are then available in the build/Windows directory. Note that
258 building via mingw64-configure/make does not work because some example outputs for the
259 documentation are created during the build process. That requires a native version also
260 during the cross compile build which does not work with mingw64-configure.
262 See "Defining Variables", below, for more details.
267 By default, `make install' installs PSPP's commands under
268 `/usr/local/bin', data files under `/usr/local/share', etc. You
269 can specify an installation prefix other than `/usr/local' by giving
270 `configure' the option `--prefix=PREFIX'.
272 You may wish to install PSPP on a machine where you do not have
273 root permissions. To do so, specify a prefix relative within your
274 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'. All
275 PSPP files will be installed under the prefix directory, which `make
276 install' will create if necessary. You may run PSPP directly from the
277 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
278 under most shells, or for added convenience you can add the
279 installation directory to your PATH by editing a shell startup file
282 You can specify separate installation prefixes for
283 architecture-specific files and architecture-independent files. If you
284 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
285 PREFIX as the prefix for installing programs and libraries.
286 Documentation and other data files still use the regular prefix.
288 In addition, if you use an unusual directory layout you can give
289 options like `--bindir=DIR' to specify different values for particular
290 kinds of files. Run `configure --help' for a list of the directories
291 you can set and what kinds of files go in them.
293 You can cause programs to be installed with an extra prefix or
294 suffix on their names by giving `configure' the option
295 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
301 Don't build the PSPPIRE gui. Use this option if you only want to
302 build the command line version of PSPP.
305 Optional libraries should normally be detected and the relevant
306 functionality will be built they exist. However, on some poorly
307 configured systems a library may exist, but be totally broken.
308 In these cases you can use --without-lib{xx} to force configure
311 `--without-perl-module'
312 Disable building the Perl module, in case it does not build properly
313 or you do not need it.
315 `--enable-relocatable'
316 This option is useful for building a package which can be installed
317 into an arbitrary directory and freely copied to any other directory.
318 If you use this option, you will probably want to install the pspp
319 with a command similar to "make install DESTDIR=<destination>".
324 Variables not defined in a site shell script can be set in the
325 environment passed to `configure'. However, some packages may run
326 configure again during the build, and the customized values of these
327 variables may be lost. In order to avoid this problem, you should set
328 them in the `configure' command line, using `VAR=value'. For example:
330 ./configure CC=/usr/local2/bin/gcc
332 causes the specified `gcc' to be used as the C compiler (unless it is
333 overridden in the site shell script). Here is another example:
335 /bin/bash ./configure CONFIG_SHELL=/bin/bash
337 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
338 configuration-related scripts to be executed by `/bin/bash'.
340 Generic `configure' Options
341 ===========================
343 `configure' also recognizes the following options to control how it operates.
347 Print a summary of the options to `configure', and exit.
351 Print the version of Autoconf used to generate the `configure'
355 Enable the cache: use and save the results of the tests in FILE,
356 traditionally `config.cache'. FILE defaults to `/dev/null' to
361 Alias for `--cache-file=config.cache'.
366 Do not print messages saying which checks are being made. To
367 suppress all normal output, redirect it to `/dev/null' (any error
368 messages will still be shown).
371 Look for the package's source code in directory DIR. Usually
372 `configure' can determine that directory automatically.
374 `configure' also accepts some other, not widely useful, options. Run
375 `configure --help' for more details.
377 ----------------------------------------------------------------------
378 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2013 Free
379 Software Foundation, Inc.
381 This file is free documentation; the Free Software Foundation gives
382 unlimited permission to copy, distribute and modify it.