Add support for reading and writing SPV files.

[pspp] / INSTALL

diff --git a/INSTALL b/INSTALL
index e45f5875f2756d69053f8de44f08459ec3eee972..25e9a6623604dae4f8699fe0ea3d6113405552a5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,14 +2,45 @@ Installation Instructions for GNU pspp
 **************************************
 
 These instructions are based on the generic GNU installation
 **************************************
 
 These instructions are based on the generic GNU installation

-instructions, but they have been tailored for PSPP.
+instructions, but they have been tailored for PSPP.  These instructions
+apply only to people wishing to build and install PSPP from source. 
+
+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.  
+
+In 99% of cases, that is all you have to do - FINISHED! 
+
+
+
+
+If any part of the above process fails, then it is
+likely that one or more of the necessary prerequisites is missing
+from your system.  The following paragraphs contain highly detailed
+information which will help you fix this.
+

 
 Before You Install
 ==================
 
 Before you install PSPP, you will need to install certain prerequisite
 packages.  You may also want to install other packages that enable
 
 Before You Install
 ==================
 
 Before you install PSPP, you will need to install certain prerequisite
 packages.  You may also want to install other packages that enable

-additional functionality in PSPP.
+additional functionality in PSPP.  Please note, if you are installing
+any of the libararies mentioned below using pre-prepared binary
+packages provided by popular GNU/Linux vendors, you may need to ensure
+that you install the "development" versions (normally postfixed with
+-dev or -devel).

 
 If you do not know whether you have these installed already, you may
 proceed to "Basic Installation", below.  The PSPP configuration
 
 If you do not know whether you have these installed already, you may
 proceed to "Basic Installation", below.  The PSPP configuration


@@ -18,30 +49,39 @@ not present on your system.
 
 The following packages are required to install PSPP:
 
 
 The following packages are required to install PSPP:
 

-    * An ANSI C compiler and tool chain.  On Unix-like systems, we
+    * A C compiler and tool chain.  On Unix-like systems, we

       recommend GCC, but any modern compilation environment should
       work.  On Microsoft Windows, Cygwin (http://www.cygwin.com/) and
       MinGW (http://www.mingw.org/) are known to work.
 
     * The GNU Scientific Library (http://www.gnu.org/software/gsl/),
       recommend GCC, but any modern compilation environment should
       work.  On Microsoft Windows, Cygwin (http://www.cygwin.com/) and
       MinGW (http://www.mingw.org/) are known to work.
 
     * The GNU Scientific Library (http://www.gnu.org/software/gsl/),

-      version 1.8 or later, including libgslcblas included with GSL.
+      version 1.13 or later, including libgslcblas included with GSL.

 
     * Perl (http://www.perl.org/), version 5.005_03 or later.  Perl is
       required during build but not after installation.
 
 
     * Perl (http://www.perl.org/), version 5.005_03 or later.  Perl is
       required during build but not after installation.
 

+    * Python (https://python.org/), version 2.7.  Some tests require
+      Python; if it is missing, those tests will be skipped.  PSPP
+      does not otherwise require Python.
+

     * iconv, which should be installed as part of a Unix-like system.
       If you don't have a version already, you can install GNU
       libiconv (http://www.gnu.org/software/libiconv/).
 
     * iconv, which should be installed as part of a Unix-like system.
       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).
+    * libintl, from GNU gettext (http://www.gnu.org/software/gettext).

       GNU libc includes an integrated libintl, so there is no need to
       separately install libintl on a GNU/Linux system.
 
       GNU libc includes an integrated libintl, so there is no need to
       separately install libintl on a GNU/Linux system.
 

+    * zlib (http://www.zlib.net/).
+
+    * libxml2 (http://xmlsoft.org/).  
+

 The following packages are required to enable PSPP's graphing
 features.  If you cannot arrange to install them, you must run
 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.
+`configure' with --without-cairo (in which case you will get no graphing
+capability).

 
 

-    * Cairo (http://cairographics.org/), version 1.5 or later.
+    * Cairo (http://cairographics.org/), version 1.12 or later.

 
     * Pango (http://www.pango.org/), version 1.22 or later.
 
 
     * Pango (http://www.pango.org/), version 1.22 or later.
 


@@ -53,28 +93,18 @@ use the GUI, you must run `configure' with --without-gui.
       0.18 and 0.19 have a bug that will prevent library detection,
       but other versions should be fine.
 
       0.18 and 0.19 have a bug that will prevent library detection,
       but other versions should be fine.
 

-    * GTK+ (http://www.gtk.org/), version 2.12.0 or later.
+    * GTK+ (http://www.gtk.org/), version 3.18.0 or later.
+      It has been reported that versions prior to 3.22.x give problems,
+      so a recent version is recommended.

 
 

-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.
-
-    * zlib (http://www.zlib.net/).
-
-    * libxml2 (http://xmlsoft.org/).  
+    * GtkSourceView (http://projects.gnome.org/gtksourceview/) 
+      version 3.4.0 or later.

 
 

-Installing the following packages will allow your PSPP binary to write
-OpenDocument text (ODT) files:
+    * GNU Spread Sheet Widget (http://www.gnu.org/software/ssw)

 
 

-    * libxml2 (http://xmlsoft.org/).  
+The following packages are optional:

 
 

-The following packages are optional.
-
-    * libncurses (http://www.gnu.org/software/ncurses/).  Without it,
-      PSPP will assume it is running in an 80x25 terminal.
+Other optional packages:

 
     * libreadline and libhistory
       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without
 
     * libreadline and libhistory
       (http://tiswww.case.edu/php/chet/readline/rltop.html).  Without


@@ -85,8 +115,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 +195,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


@@ -175,9 +215,13 @@ details on some of the pertinent environment variables.
 by setting variables in the command line or in the environment.  Here
 is an example:
 
 by setting variables in the command line or in the environment.  Here
 is an example:
 

-     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
+     ./configure CC=c89 CFLAGS=-O0 LIBS=-lposix
+
+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.
+See "Defining Variables", below, for more details.

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


@@ -237,18 +281,15 @@ 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
    into an arbitrary directory and freely copied to any other directory.
    If you use this option, you will probably want to install the pspp
 
 `--enable-relocatable'
    This option is useful for building a package which can be installed
    into an arbitrary directory and freely copied to any other directory.
    If you use this option, you will probably want to install the pspp

-   with a command similar to "make install DESTDIR=<distination>".
+   with a command similar to "make install DESTDIR=<destination>".

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


@@ -307,7 +348,7 @@ Generic `configure' Options
 `configure --help' for more details.
 
 ----------------------------------------------------------------------
 `configure --help' for more details.
 
 ----------------------------------------------------------------------

-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free
+Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007, 2013 Free

 Software Foundation, Inc.
 
 This file is free documentation; the Free Software Foundation gives
 Software Foundation, Inc.
 
 This file is free documentation; the Free Software Foundation gives