Finally got the datasheet responding fast enough.

[pspp-builds.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 4ccbb78b20596d2b2024b8691a5f85872308c112..9ae05a33f8ac1e3f7450f11f09a453b83e72dace 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,92 +1,33 @@
-Release Notes
-=============
+Installation Instructions
+*************************

 
 

-PSPP has the following library dependencies;
+Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
+Software Foundation, Inc.

 
 

-    * The GNU Scientific Library (libgsl), version 1.6 or later.
-
-    * libplot from GNU plotutils is optional.  Without it, the new
-      graphing features will not work.  If you do not have it
-      installed, you must run `configure' with --without-libplot.
-
-    * ncurses and GNU readline are optional.  They make for a more pleasant
-      command line interface.
-
-PSPP also has the following build dependencies:
-
-    * perl 5.6 or later.
-
-    * GNU diff, for `make check' to complete properly.  (We intend to
-      eliminate this dependency in a later release.)
-
-A few system-specific issues have been noted.  These may be PSPP bugs
-or system bugs; we have not yet been able to track them down precisely:
-
-    * On Solaris, one or more tests may fail `make check'.  We have
-      only seen this reported on Solaris 9 with GCC 3.4.2.  Our
-      reporter says that turning off optimization (with -O0) at least
-      masked the symptoms.
-
-    * On Mac OS X, GCC 4.0.0 build 4061 has been observed to cause
-      some tests to fail.  Later builds should work fine.
-
-Finally, a few extra notes:
-
-    * The Sun WorkShop compiler will not work out of the box in this
-      release.  Use GCC instead.  We will fix this for the next
-      release.
-
-    * GCC 4.x reports an inordinate number of warnings for this
-      release.  You may ignore these for now.  We will fix these for
-      the next release.
-
-
-
-
-
-
-
-
-
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
-Foundation, Inc.
-
-   This file is free documentation; the Free Software Foundation gives
+This file is free documentation; the Free Software Foundation gives

 unlimited permission to copy, distribute and modify it.
 
 Basic Installation
 ==================
 
 unlimited permission to copy, distribute and modify it.
 
 Basic Installation
 ==================
 

-   These are generic installation instructions.
+These are installation instructions specific to PSPP (including PSPPIRE, 
+the graphic user interface).  These instructions contain the
+information most commonly needed by people wishing to build the
+program from source.  More detailed information can be found in the
+generic autoconf manual which is available at
+http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts.html

 
    The `configure' shell script attempts to guess correct values for
 
    The `configure' shell script attempts to guess correct values for

-various system-dependent variables used during compilation.  It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions.  Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, and a
-file `config.log' containing compiler output (useful mainly for
-debugging `configure').
-
-   It can also use an optional file (typically called `config.cache'
-and enabled with `--cache-file=config.cache' or simply `-C') that saves
-the results of its tests to speed up reconfiguring.  (Caching is
-disabled by default to prevent problems with accidental use of stale
-cache files.)
+various system-dependent variables used during compilation.
+

 
    If you need to do unusual things to compile the package, please try
 to figure out how `configure' could check whether to do them, and mail
 
    If you need to do unusual things to compile the package, please try
 to figure out how `configure' could check whether to do them, and mail

-diffs or instructions to the address given in the `README' so they can
-be considered for the next release.  If you are using the cache, and at
-some point `config.cache' contains results you don't want to keep, you
-may remove or edit it.
+diffs or instructions to pspp-dev@gnu.org so they can
+be considered for the next release. 

 
 

-   The file `configure.ac' (or `configure.in') is used to create
-`configure' by a program called `autoconf'.  You only need
-`configure.ac' if you want to change it or regenerate `configure' using
-a newer version of `autoconf'.

 
 

-The simplest way to compile this package is:
+The simplest way to compile PSPP is:

 
   1. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.  If you're
 
   1. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.  If you're


@@ -99,27 +40,23 @@ The simplest way to compile this package is:
 
   2. Type `make' to compile the package.
 
 
   2. Type `make' to compile the package.
 

-  3. Optionally, type `make check' to run any self-tests that come with
+  3. Optionally, type `make check' to run the self-tests that come with

      the package.
 
   4. Type `make install' to install the programs and any data files and
      the package.
 
   4. Type `make install' to install the programs and any data files and

-     documentation.
+     documentation.  You will need root permissions to do this.

 
   5. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the
      files that `configure' created (so you can compile the package for
 
   5. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the
      files that `configure' created (so you can compile the package for

-     a different kind of computer), type `make distclean'.  There is
-     also a `make maintainer-clean' target, but that is intended mainly
-     for the package's developers.  If you use it, you may have to get
-     all sorts of other programs in order to regenerate files that came
-     with the distribution.
+     a different kind of computer), type `make distclean'.

 
 Compilers and Options
 =====================
 
 
 Compilers and Options
 =====================
 

-   Some systems require unusual options for compilation or linking that
-the `configure' script does not know about.  Run `./configure --help'
-for details on some of the pertinent environment variables.
+Some systems may require unusual options for compilation or linking that the
+`configure' script does not know about.  Run `./configure --help' for
+details on some of the pertinent environment variables.

 
    You can give `configure' initial values for configuration parameters
 by setting variables in the command line or in the environment.  Here
 
    You can give `configure' initial values for configuration parameters
 by setting variables in the command line or in the environment.  Here


@@ -129,106 +66,50 @@ is an example:
 
    *Note Defining Variables::, for more details.
 
 
    *Note Defining Variables::, for more details.
 

-Compiling For Multiple Architectures
-====================================
-
-   You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory.  To do this, you must use a version of `make' that
-supports the `VPATH' variable, such as GNU `make'.  `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script.  `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
-   If you have to use a `make' that does not support the `VPATH'
-variable, you have to compile the package for one architecture at a
-time in the source code directory.  After you have installed the
-package for one architecture, use `make distclean' before reconfiguring
-for another architecture.

 
 Installation Names
 ==================
 
 
 Installation Names
 ==================
 

-   By default, `make install' will install the package's files in
-`/usr/local/bin', `/usr/local/man', etc.  You can specify an
-installation prefix other than `/usr/local' by giving `configure' the
-option `--prefix=PATH'.
+By default, `make install' installs PSPP's commands under
+`/usr/local/bin', data files under `/usr/local/share', etc.  You
+can specify an installation prefix other than `/usr/local' by giving
+`configure' the option `--prefix=PREFIX'.

 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you
 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you

-give `configure' the option `--exec-prefix=PATH', the package will use
-PATH as the prefix for installing programs and libraries.
-Documentation and other data files will still use the regular prefix.
+pass the option `--exec-prefix=PREFIX' to `configure', the package uses
+PREFIX as the prefix for installing programs and libraries.
+Documentation and other data files still use the regular prefix.

 
    In addition, if you use an unusual directory layout you can give
 
    In addition, if you use an unusual directory layout you can give

-options like `--bindir=PATH' to specify different values for particular
+options like `--bindir=DIR' to specify different values for particular

 kinds of files.  Run `configure --help' for a list of the directories
 you can set and what kinds of files go in them.
 
 kinds of files.  Run `configure --help' for a list of the directories
 you can set and what kinds of files go in them.
 

-   If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+   You can cause programs to be installed with an extra prefix or
+suffix on their names by giving `configure' the  option
+`--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 

 
 Optional Features
 =================
 
 
 Optional Features
 =================
 

-   Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System).  The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
-   For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Specifying the System Type
-==========================
+`--without-libplot'
+    Don't compile in support for charts (using libplot).  This is
+    useful if your system doesn't have the libplot library.

 
 

-   There may be some features `configure' cannot figure out
-automatically, but needs to determine by the type of machine the package
-will run on.  Usually, assuming the package is built to be run on the
-_same_ architectures, `configure' can figure that out, but if it prints
-a message saying it cannot guess the machine type, give it the
-`--build=TYPE' option.  TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name which has the form:
+`--without-gui'
+    Don't build the PSPPIRE gui.  Use this option if you only want to
+    build the command line version of PSPP.

 
 

-     CPU-COMPANY-SYSTEM
+`--with-gui-tools'
+    Build the gui developer tools.  There is no reason to use this
+    option unless you're involved with the development of PSPP

 
 

-where SYSTEM can have one of these forms:
-
-     OS KERNEL-OS
-
-   See the file `config.sub' for the possible values of each field.  If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the machine type.
-
-   If you are _building_ compiler tools for cross-compiling, you should
-use the `--target=TYPE' option to select the type of system they will
-produce code for.
-
-   If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the
-"host" platform (i.e., that on which the generated programs will
-eventually be run) with `--host=TYPE'.
-
-Sharing Defaults
-================
-
-   If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists.  Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.

 
 Defining Variables
 ==================
 
 
 Defining Variables
 ==================
 

-   Variables not defined in a site shell script can be set in the
+Variables not defined in a site shell script can be set in the

 environment passed to `configure'.  However, some packages may run
 configure again during the build, and the customized values of these
 variables may be lost.  In order to avoid this problem, you should set
 environment passed to `configure'.  However, some packages may run
 configure again during the build, and the customized values of these
 variables may be lost.  In order to avoid this problem, you should set


@@ -236,14 +117,18 @@ them in the `configure' command line, using `VAR=value'.  For example:
 
      ./configure CC=/usr/local2/bin/gcc
 
 
      ./configure CC=/usr/local2/bin/gcc
 

-will cause the specified gcc to be used as the C compiler (unless it is
-overridden in the site shell script).
+causes the specified `gcc' to be used as the C compiler (unless it is
+overridden in the site shell script).  Here is a another example:
+
+     /bin/bash ./configure CONFIG_SHELL=/bin/bash
+
+Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
+configuration-related scripts to be executed by `/bin/bash'.

 
 

-`configure' Invocation
-======================
+Generic `configure' Options
+===========================

 
 

-   `configure' recognizes the following options to control how it
-operates.
+`configure' also recognizes the following options to control how it operates.

 
 `--help'
 `-h'
 
 `--help'
 `-h'