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