Updated INSTALL to be more specific to pspp.
[pspp-builds.git] / INSTALL
1 Installation Instructions
2 *************************
3
4 Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
5 Software Foundation, Inc.
6
7 This file is free documentation; the Free Software Foundation gives
8 unlimited permission to copy, distribute and modify it.
9
10 Basic Installation
11 ==================
12
13 These are installation instructions specific to PSPP (including PSPPIRE, 
14 the graphic user interface).  These instructions contain the
15 information most commonly needed by people wishing to build the
16 program from source.  More detailed information can be found in the
17 generic autoconf manual which is available at
18 http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html
19
20    The `configure' shell script attempts to guess correct values for
21 various system-dependent variables used during compilation.
22
23
24    If you need to do unusual things to compile the package, please try
25 to figure out how `configure' could check whether to do them, and mail
26 diffs or instructions to pspp-dev@gnu.org so they can
27 be considered for the next release. 
28
29
30 The simplest way to compile PSPP is:
31
32   1. `cd' to the directory containing the package's source code and type
33      `./configure' to configure the package for your system.  If you're
34      using `csh' on an old version of System V, you might need to type
35      `sh ./configure' instead to prevent `csh' from trying to execute
36      `configure' itself.
37
38      Running `configure' takes awhile.  While running, it prints some
39      messages telling which features it is checking for.
40
41   2. Type `make' to compile the package.
42
43   3. Optionally, type `make check' to run the self-tests that come with
44      the package.
45
46   4. Type `make install' to install the programs and any data files and
47      documentation.  You will need root permissions to do this.
48
49   5. You can remove the program binaries and object files from the
50      source code directory by typing `make clean'.  To also remove the
51      files that `configure' created (so you can compile the package for
52      a different kind of computer), type `make distclean'.
53
54 Compilers and Options
55 =====================
56
57 Some systems may require unusual options for compilation or linking that the
58 `configure' script does not know about.  Run `./configure --help' for
59 details on some of the pertinent environment variables.
60
61    You can give `configure' initial values for configuration parameters
62 by setting variables in the command line or in the environment.  Here
63 is an example:
64
65      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
66
67    *Note Defining Variables::, for more details.
68
69
70 Installation Names
71 ==================
72
73 By default, `make install' installs PSPP's commands under
74 `/usr/local/bin', data files under `/usr/local/share', etc.  You
75 can specify an installation prefix other than `/usr/local' by giving
76 `configure' the option `--prefix=PREFIX'.
77
78    You can specify separate installation prefixes for
79 architecture-specific files and architecture-independent files.  If you
80 pass the option `--exec-prefix=PREFIX' to `configure', the package uses
81 PREFIX as the prefix for installing programs and libraries.
82 Documentation and other data files still use the regular prefix.
83
84    In addition, if you use an unusual directory layout you can give
85 options like `--bindir=DIR' to specify different values for particular
86 kinds of files.  Run `configure --help' for a list of the directories
87 you can set and what kinds of files go in them.
88
89    You can cause programs to be installed with an extra prefix or
90 suffix on their names by giving `configure' the  option
91 `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 
92
93 Optional Features
94 =================
95
96 `--without-libplot'
97     Don't compile in support for charts (using libplot).  This is
98     useful if your system doesn't have the libplot library.
99
100 `--without-gui'
101     Don't build the PSPPIRE gui.  Use this option if you only want to
102     build the command line version of PSPP.
103
104 `--with-gui-tools'
105     Build the gui developer tools.  There is no reason to use this
106     option unless you're involved with the development of PSPP
107
108
109 Defining Variables
110 ==================
111
112 Variables not defined in a site shell script can be set in the
113 environment passed to `configure'.  However, some packages may run
114 configure again during the build, and the customized values of these
115 variables may be lost.  In order to avoid this problem, you should set
116 them in the `configure' command line, using `VAR=value'.  For example:
117
118      ./configure CC=/usr/local2/bin/gcc
119
120 causes the specified `gcc' to be used as the C compiler (unless it is
121 overridden in the site shell script).  Here is a another example:
122
123      /bin/bash ./configure CONFIG_SHELL=/bin/bash
124
125 Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
126 configuration-related scripts to be executed by `/bin/bash'.
127
128 Generic `configure' Options
129 ===========================
130
131 `configure' also recognizes the following options to control how it operates.
132
133 `--help'
134 `-h'
135      Print a summary of the options to `configure', and exit.
136
137 `--version'
138 `-V'
139      Print the version of Autoconf used to generate the `configure'
140      script, and exit.
141
142 `--cache-file=FILE'
143      Enable the cache: use and save the results of the tests in FILE,
144      traditionally `config.cache'.  FILE defaults to `/dev/null' to
145      disable caching.
146
147 `--config-cache'
148 `-C'
149      Alias for `--cache-file=config.cache'.
150
151 `--quiet'
152 `--silent'
153 `-q'
154      Do not print messages saying which checks are being made.  To
155      suppress all normal output, redirect it to `/dev/null' (any error
156      messages will still be shown).
157
158 `--srcdir=DIR'
159      Look for the package's source code in directory DIR.  Usually
160      `configure' can determine that directory automatically.
161
162 `configure' also accepts some other, not widely useful, options.  Run
163 `configure --help' for more details.
164