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