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