Remove gmp references.
[pspp-builds.git] / INSTALL
1 PSPP has the following library dependencies;
2
3     * The GNU Scientific Library (libgsl), version 1.6 or later.
4
5     * libplot from GNU plotutils is optional.  Without it, the new
6       graphing features will not work.  If you do not have it
7       installed, you must run `configure' with --without-libplot.
8
9     * ncurses and GNU readline are optional.  They make for a more pleasant
10       command line interface.
11
12 PSPP also has the following build dependencies:
13
14     * perl 5.6 or later.
15
16 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
17 Foundation, Inc.
18
19    This file is free documentation; the Free Software Foundation gives
20 unlimited permission to copy, distribute and modify it.
21
22 Basic Installation
23 ==================
24
25    These are generic installation instructions.
26
27    The `configure' shell script attempts to guess correct values for
28 various system-dependent variables used during compilation.  It uses
29 those values to create a `Makefile' in each directory of the package.
30 It may also create one or more `.h' files containing system-dependent
31 definitions.  Finally, it creates a shell script `config.status' that
32 you can run in the future to recreate the current configuration, and a
33 file `config.log' containing compiler output (useful mainly for
34 debugging `configure').
35
36    It can also use an optional file (typically called `config.cache'
37 and enabled with `--cache-file=config.cache' or simply `-C') that saves
38 the results of its tests to speed up reconfiguring.  (Caching is
39 disabled by default to prevent problems with accidental use of stale
40 cache files.)
41
42    If you need to do unusual things to compile the package, please try
43 to figure out how `configure' could check whether to do them, and mail
44 diffs or instructions to the address given in the `README' so they can
45 be considered for the next release.  If you are using the cache, and at
46 some point `config.cache' contains results you don't want to keep, you
47 may remove or edit it.
48
49    The file `configure.ac' (or `configure.in') is used to create
50 `configure' by a program called `autoconf'.  You only need
51 `configure.ac' if you want to change it or regenerate `configure' using
52 a newer version of `autoconf'.
53
54 The simplest way to compile this package is:
55
56   1. `cd' to the directory containing the package's source code and type
57      `./configure' to configure the package for your system.  If you're
58      using `csh' on an old version of System V, you might need to type
59      `sh ./configure' instead to prevent `csh' from trying to execute
60      `configure' itself.
61
62      Running `configure' takes awhile.  While running, it prints some
63      messages telling which features it is checking for.
64
65   2. Type `make' to compile the package.
66
67   3. Optionally, type `make check' to run any self-tests that come with
68      the package.
69
70   4. Type `make install' to install the programs and any data files and
71      documentation.
72
73   5. You can remove the program binaries and object files from the
74      source code directory by typing `make clean'.  To also remove the
75      files that `configure' created (so you can compile the package for
76      a different kind of computer), type `make distclean'.  There is
77      also a `make maintainer-clean' target, but that is intended mainly
78      for the package's developers.  If you use it, you may have to get
79      all sorts of other programs in order to regenerate files that came
80      with the distribution.
81
82 Compilers and Options
83 =====================
84
85    Some systems require unusual options for compilation or linking that
86 the `configure' script does not know about.  Run `./configure --help'
87 for details on some of the pertinent environment variables.
88
89    You can give `configure' initial values for configuration parameters
90 by setting variables in the command line or in the environment.  Here
91 is an example:
92
93      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
94
95    *Note Defining Variables::, for more details.
96
97 Compiling For Multiple Architectures
98 ====================================
99
100    You can compile the package for more than one kind of computer at the
101 same time, by placing the object files for each architecture in their
102 own directory.  To do this, you must use a version of `make' that
103 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
104 directory where you want the object files and executables to go and run
105 the `configure' script.  `configure' automatically checks for the
106 source code in the directory that `configure' is in and in `..'.
107
108    If you have to use a `make' that does not support the `VPATH'
109 variable, you have to compile the package for one architecture at a
110 time in the source code directory.  After you have installed the
111 package for one architecture, use `make distclean' before reconfiguring
112 for another architecture.
113
114 Installation Names
115 ==================
116
117    By default, `make install' will install the package's files in
118 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
119 installation prefix other than `/usr/local' by giving `configure' the
120 option `--prefix=PATH'.
121
122    You can specify separate installation prefixes for
123 architecture-specific files and architecture-independent files.  If you
124 give `configure' the option `--exec-prefix=PATH', the package will use
125 PATH as the prefix for installing programs and libraries.
126 Documentation and other data files will still use the regular prefix.
127
128    In addition, if you use an unusual directory layout you can give
129 options like `--bindir=PATH' to specify different values for particular
130 kinds of files.  Run `configure --help' for a list of the directories
131 you can set and what kinds of files go in them.
132
133    If the package supports it, you can cause programs to be installed
134 with an extra prefix or suffix on their names by giving `configure' the
135 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
136
137 Optional Features
138 =================
139
140    Some packages pay attention to `--enable-FEATURE' options to
141 `configure', where FEATURE indicates an optional part of the package.
142 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
143 is something like `gnu-as' or `x' (for the X Window System).  The
144 `README' should mention any `--enable-' and `--with-' options that the
145 package recognizes.
146
147    For packages that use the X Window System, `configure' can usually
148 find the X include and library files automatically, but if it doesn't,
149 you can use the `configure' options `--x-includes=DIR' and
150 `--x-libraries=DIR' to specify their locations.
151
152 Specifying the System Type
153 ==========================
154
155    There may be some features `configure' cannot figure out
156 automatically, but needs to determine by the type of machine the package
157 will run on.  Usually, assuming the package is built to be run on the
158 _same_ architectures, `configure' can figure that out, but if it prints
159 a message saying it cannot guess the machine type, give it the
160 `--build=TYPE' option.  TYPE can either be a short name for the system
161 type, such as `sun4', or a canonical name which has the form:
162
163      CPU-COMPANY-SYSTEM
164
165 where SYSTEM can have one of these forms:
166
167      OS KERNEL-OS
168
169    See the file `config.sub' for the possible values of each field.  If
170 `config.sub' isn't included in this package, then this package doesn't
171 need to know the machine type.
172
173    If you are _building_ compiler tools for cross-compiling, you should
174 use the `--target=TYPE' option to select the type of system they will
175 produce code for.
176
177    If you want to _use_ a cross compiler, that generates code for a
178 platform different from the build platform, you should specify the
179 "host" platform (i.e., that on which the generated programs will
180 eventually be run) with `--host=TYPE'.
181
182 Sharing Defaults
183 ================
184
185    If you want to set default values for `configure' scripts to share,
186 you can create a site shell script called `config.site' that gives
187 default values for variables like `CC', `cache_file', and `prefix'.
188 `configure' looks for `PREFIX/share/config.site' if it exists, then
189 `PREFIX/etc/config.site' if it exists.  Or, you can set the
190 `CONFIG_SITE' environment variable to the location of the site script.
191 A warning: not all `configure' scripts look for a site script.
192
193 Defining Variables
194 ==================
195
196    Variables not defined in a site shell script can be set in the
197 environment passed to `configure'.  However, some packages may run
198 configure again during the build, and the customized values of these
199 variables may be lost.  In order to avoid this problem, you should set
200 them in the `configure' command line, using `VAR=value'.  For example:
201
202      ./configure CC=/usr/local2/bin/gcc
203
204 will cause the specified gcc to be used as the C compiler (unless it is
205 overridden in the site shell script).
206
207 `configure' Invocation
208 ======================
209
210    `configure' recognizes the following options to control how it
211 operates.
212
213 `--help'
214 `-h'
215      Print a summary of the options to `configure', and exit.
216
217 `--version'
218 `-V'
219      Print the version of Autoconf used to generate the `configure'
220      script, and exit.
221
222 `--cache-file=FILE'
223      Enable the cache: use and save the results of the tests in FILE,
224      traditionally `config.cache'.  FILE defaults to `/dev/null' to
225      disable caching.
226
227 `--config-cache'
228 `-C'
229      Alias for `--cache-file=config.cache'.
230
231 `--quiet'
232 `--silent'
233 `-q'
234      Do not print messages saying which checks are being made.  To
235      suppress all normal output, redirect it to `/dev/null' (any error
236      messages will still be shown).
237
238 `--srcdir=DIR'
239      Look for the package's source code in directory DIR.  Usually
240      `configure' can determine that directory automatically.
241
242 `configure' also accepts some other, not widely useful, options.  Run
243 `configure --help' for more details.
244