Per latest comments in bug #19069
[pspp-builds.git] / INSTALL
1 PSPP Installation Instructions
2 ******************************
3
4 These instructions are based on the generic GNU installation
5 instructions, but they have been tailored for PSPP.
6
7 Before You Install
8 ==================
9
10 Before you install PSPP, you will need to install certain prerequisite
11 packages.  You may also want to install other packages that enable
12 additional functionality in PSPP.
13
14 If you do not know whether you have these installed already, you may
15 proceed to "Basic Installation", below.  The PSPP configuration
16 process will notify you about required and optional packages that are
17 not present on your system.
18
19 The following packages are required to install PSPP:
20
21     * An ANSI C compiler and tool chain.  On Unix-like systems, we
22       recommend GCC, but any modern compilation environment should
23       work.  On Microsoft Windows, Cygwin (http://www.cygwin.com/) and
24       MinGW (http://www.mingw.org/) are known to work.
25
26     * The GNU Scientific Library (http://www.gnu.org/software/gsl/),
27       version 1.6 or later, including libgslcblas included with GSL.
28
29     * Perl (http://www.perl.org/), version 5.005_03 or later.  Perl is
30       required during build but not after installation.
31
32     * iconv, which should be installed as part of a Unix-like system.
33       If you don't have a version already, you can install GNU
34       libiconv (http://www.gnu.org/software/libiconv/).
35
36 The following package is required to enable PSPP's graphing features.
37 If you cannot arrange to install it, you must run `configure' with
38 --without-libplot.
39
40     * libplot, from GNU plotutils
41       (http://www.gnu.org/software/plotutils/).
42
43 The following packages are required to enable PSPPIRE, the graphical
44 user interface for PSPP.  If you cannot install them or do not wish to
45 use the GUI, you must run `configure' with --without-gui.
46
47     * pkg-config (http://pkg-config.freedesktop.org/wiki/). 
48
49     * GTK+ (http://www.gtk.org/), version 2.8.0 or later, although we
50       recommend version 2.10.2 or later.
51
52     * libglade (http://www.jamesh.id.au/software/libglade/), version
53       2.0 or later.
54
55 The following packages are optional.
56
57     * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
58       PSPP will assume it is running in an 80x25 terminal.
59
60     * libreadline and libhistory
61       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
62       them, interactive command editing and history features in the
63       text-based user interface will be disabled.
64
65     * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or
66       later.  Installing Texinfo will allow you to build PSPP
67       documentation in PostScript or PDF format.
68
69 Basic Installation
70 ==================
71
72 These are installation instructions specific to PSPP (including PSPPIRE, 
73 the graphic user interface).  These instructions contain the
74 information most commonly needed by people wishing to build the
75 program from source.  More detailed information can be found in the
76 generic autoconf manual which is available at
77 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
78
79    The `configure' shell script attempts to guess correct values for
80 various system-dependent variables used during compilation.
81
82    If you need to do unusual things to compile the package, please
83 report the problem to bug-gnu-pspp@gnu.org.  We will try to figure out
84 how `configure' could work better in your situation for the next
85 release.
86
87    The simplest way to compile PSPP is:
88
89   1. `cd' to the directory containing the package's source code and type
90      `./configure' to configure the package for your system.
91
92      Running `configure' takes awhile.  While running, it prints some
93      messages telling which features it is checking for.
94
95      When `configure' completes, it may print a list of packages that
96      you must install before PSPP.  If it does, you need to install
97      those packages, then re-run this step.  Some prerequisites may be
98      omitted by passing a --without-<feature> flag to `configure' (see
99      "Optional Features", below).  If you use one of these flags, then
100      the feature that it disables will not be available in your PSPP
101      installation.
102
103      `configure' may also print a list of packages that you should
104      consider installing.  If you install them, additional features
105      will be available in your PSPP installation.
106
107   2. Type `make' to compile the package.
108
109   3. Optionally, type `make check' to run the self-tests that come
110      with the package.  If any of the self-tests fail, please mail
111      bug-gnu-pspp@gnu.org with the details, to give the PSPP
112      developers an opportunity to fix the problem in the next release.
113
114   4. Type `make install' to install the programs and any data files
115      and documentation.  Ordinarily you will need root permissions to
116      do this; if you cannot get root permissions, see "Installation
117      Names", below.
118
119   5. You can remove the program binaries and object files from the
120      source code directory by typing `make clean'.  To also remove the
121      files that `configure' created (so you can compile the package for
122      a different kind of computer), type `make distclean'.
123
124 Compilers and Options
125 =====================
126
127 Some systems may require unusual options for compilation or linking that the
128 `configure' script does not know about.  Run `./configure --help' for
129 details on some of the pertinent environment variables.
130
131    You can give `configure' initial values for configuration parameters
132 by setting variables in the command line or in the environment.  Here
133 is an example:
134
135      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
136
137    See "Defining Variables", below, for more details.
138
139 Installation Names
140 ==================
141
142 By default, `make install' installs PSPP's commands under
143 `/usr/local/bin', data files under `/usr/local/share', etc.  You
144 can specify an installation prefix other than `/usr/local' by giving
145 `configure' the option `--prefix=PREFIX'.
146
147    You may wish to install PSPP on a machine where you do not have
148 root permissions.  To do so, specify a prefix relative within your
149 home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'.  All
150 PSPP files will be installed under the prefix directory, which `make
151 install' will create if necessary.  You may run PSPP directly from the
152 `bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp'
153 under most shells, or for added convenience you can add the
154 installation directory to your PATH by editing a shell startup file
155 such as `.bashrc'.
156
157    You can specify separate installation prefixes for
158 architecture-specific files and architecture-independent files.  If you
159 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
160 PREFIX as the prefix for installing programs and libraries.
161 Documentation and other data files still use the regular prefix.
162
163    In addition, if you use an unusual directory layout you can give
164 options like `--bindir=DIR' to specify different values for particular
165 kinds of files.  Run `configure --help' for a list of the directories
166 you can set and what kinds of files go in them.
167
168    You can cause programs to be installed with an extra prefix or
169 suffix on their names by giving `configure' the  option
170 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 
171
172 Optional Features
173 =================
174
175 `--without-libplot'
176     Don't compile in support for charts (using libplot).  This is
177     useful if your system doesn't have the libplot library.
178
179 `--without-gui'
180     Don't build the PSPPIRE gui.  Use this option if you only want to
181     build the command line version of PSPP.
182
183 `--with-gui-tools'
184     Build the gui developer tools.  There is no reason to use this
185     option unless you're involved with the development of PSPP
186
187
188 Defining Variables
189 ==================
190
191 Variables not defined in a site shell script can be set in the
192 environment passed to `configure'.  However, some packages may run
193 configure again during the build, and the customized values of these
194 variables may be lost.  In order to avoid this problem, you should set
195 them in the `configure' command line, using `VAR=value'.  For example:
196
197      ./configure CC=/usr/local2/bin/gcc
198
199 causes the specified `gcc' to be used as the C compiler (unless it is
200 overridden in the site shell script).  Here is another example:
201
202      /bin/bash ./configure CONFIG_SHELL=/bin/bash
203
204 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
205 configuration-related scripts to be executed by `/bin/bash'.
206
207 Generic `configure' Options
208 ===========================
209
210 `configure' also recognizes the following options to control how it operates.
211
212 `--help'
213 `-h'
214      Print a summary of the options to `configure', and exit.
215
216 `--version'
217 `-V'
218      Print the version of Autoconf used to generate the `configure'
219      script, and exit.
220
221 `--cache-file=FILE'
222      Enable the cache: use and save the results of the tests in FILE,
223      traditionally `config.cache'.  FILE defaults to `/dev/null' to
224      disable caching.
225
226 `--config-cache'
227 `-C'
228      Alias for `--cache-file=config.cache'.
229
230 `--quiet'
231 `--silent'
232 `-q'
233      Do not print messages saying which checks are being made.  To
234      suppress all normal output, redirect it to `/dev/null' (any error
235      messages will still be shown).
236
237 `--srcdir=DIR'
238      Look for the package's source code in directory DIR.  Usually
239      `configure' can determine that directory automatically.
240
241 `configure' also accepts some other, not widely useful, options.  Run
242 `configure --help' for more details.
243
244 ----------------------------------------------------------------------
245 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
246 Software Foundation, Inc.
247
248 This file is free documentation; the Free Software Foundation gives
249 unlimited permission to copy, distribute and modify it.
250