Merge 'master' into 'psppsheet'.
[pspp] / INSTALL
diff --git a/INSTALL b/INSTALL
index f391f56313c11de18de9d9187aa1543c9faf936f..5d1775cd8816baebf6756eab076a44b532cc3712 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,6 +4,23 @@ Installation Instructions for GNU pspp
 These instructions are based on the generic GNU installation
 instructions, but they have been tailored for PSPP.
 
 These instructions are based on the generic GNU installation
 instructions, but they have been tailored for PSPP.
 
+Overview
+========
+
+PSPP uses the standard GNU configuration system.  Therefore, if all is well,
+the following simple procedure should work, even on non-GNU systems:
+
+ tar -xzf pspp-*.tar.gz
+ cd pspp-*
+ ./configure
+ make 
+ sudo make install
+
+Obviously, you should replace 'pspp-*' in the above, with the name of
+the tarball you are installing.  If any part of this process fails, then 
+it's likely that one or more of the necessary prerequisites is missing
+from your system.   Read on to find out how to correct this.
+
 Before You Install
 ==================
 
 Before You Install
 ==================
 
@@ -33,6 +50,10 @@ The following packages are required to install PSPP:
       If you don't have a version already, you can install GNU
       libiconv (http://www.gnu.org/software/libiconv/).
 
       If you don't have a version already, you can install GNU
       libiconv (http://www.gnu.org/software/libiconv/).
 
+    * libintl, from GNU gettext (http://ww.gnu.org/software/gettext).
+      GNU libc includes an integrated libintl, so there is no need to
+      separately install libintl on a GNU/Linux system.
+
 The following packages are required to enable PSPP's graphing
 features.  If you cannot arrange to install them, you must run
 `configure' with --without-cairo.
 The following packages are required to enable PSPP's graphing
 features.  If you cannot arrange to install them, you must run
 `configure' with --without-cairo.
@@ -51,13 +72,9 @@ use the GUI, you must run `configure' with --without-gui.
 
     * GTK+ (http://www.gtk.org/), version 2.12.0 or later.
 
 
     * GTK+ (http://www.gtk.org/), version 2.12.0 or later.
 
-    * pkg-config (http://pkg-config.freedesktop.org/wiki/).  Versions
-      0.18 and 0.19 have a bug that will prevent library detection,
-      but other versions should be fine.
+    * GtkSourceView (http://projects.gnome.org/gtksourceview/) 
+      version 2.2 or later.
 
 
-To cross-compile PSPP, you will likely need to set the
-PKG_CONFIG_LIBDIR environment variable to point to an
-appropriate pkg-config for the cross-compilation environment.
 
 Installing the following packages will allow your PSPP binary to read
 Gnumeric files.
 
 Installing the following packages will allow your PSPP binary to read
 Gnumeric files.
@@ -85,8 +102,14 @@ The following packages are optional.
       later.  Installing Texinfo will allow you to build PSPP
       documentation in PostScript or PDF format.
 
       later.  Installing Texinfo will allow you to build PSPP
       documentation in PostScript or PDF format.
 
-    * libpq, from Postgresql (http://postgresql.org). This enables PSPP 
-      to read Postgresql databases.
+    * libpq, from Postgresql (http://postgresql.org).  This enables PSPP 
+      to read Postgresql databases.  The tests for the Postgresql
+      interface, but not the Postgresql interface itself, requires the
+      Postgresql server to be installed.
+
+    * The Text::Diff module for Perl (http://cpan.org).  This enables
+      PSPP to test the Perl module more thoroughly.  It is not needed
+      to build or use the Perl module.
 
 Basic Installation
 ==================
 
 Basic Installation
 ==================
@@ -159,6 +182,10 @@ release.
      root permissions.  If you cannot get root permissions, see
      "Installation Names", below.
 
      root permissions.  If you cannot get root permissions, see
      "Installation Names", below.
 
+     Please note:  The `make install' target does NOT install the perl
+     module (see below).  To install the perl module, you must change to
+     the `perl-module' directory and manually run `make install' there.
+
   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
@@ -177,7 +204,11 @@ is an example:
 
      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 
 
      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
 
-   See "Defining Variables", below, for more details.
+To cross-compile PSPP, you will likely need to set the
+PKG_CONFIG_LIBDIR environment variable to point to an
+appropriate pkg-config for the cross-compilation environment.
+
+See "Defining Variables", below, for more details.
 
 Installation Names
 ==================
 
 Installation Names
 ==================
@@ -237,12 +268,9 @@ Optional Features
     In these cases you can use --without-lib{xx} to force configure
     to disregard it.
 
     In these cases you can use --without-lib{xx} to force configure
     to disregard it.
 
-`--enable-anachronistic-dependencies'
-   If you use this option, some of the checks for dependent libraries
-   will be relaxed, permitting configure to succeed when older versions
-   of libraries are detected.   Use of this option is not recommended.
-   If you use it, some features may be missing and the build may fail
-   with obscure error messages.
+`--without-perl-module'
+   Disable building the Perl module, in case it does not build properly
+   or you do not need it.
 
 `--enable-relocatable'
    This option is useful for building a package which can be installed
 
 `--enable-relocatable'
    This option is useful for building a package which can be installed