Fix missing @clicksequence problem with older Texinfo versions.

[pspp-builds.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 64675e035c1bed871470a47b5ec489b174d39c23..d3a469cf6ee124c7c583abc233e10abfa3081035 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,5 +1,5 @@
-PSPP Installation Instructions
-******************************
+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.


@@ -44,13 +44,26 @@ The following packages are required to enable PSPPIRE, the graphical
 user interface for PSPP.  If you cannot install them or do not wish to
 use the GUI, you must run `configure' with --without-gui.
 
 user interface for PSPP.  If you cannot install them or do not wish to
 use the GUI, you must run `configure' with --without-gui.
 

-    * pkg-config (http://pkg-config.freedesktop.org/wiki/). 
+    * 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.

 
 

-    * GTK+ (http://www.gtk.org/), version 2.8.0 or later, although we
-      recommend version 2.10.2 or later.
+    * GTK+ (http://www.gtk.org/), version 2.12.0 or later.

 
 

-    * libglade (http://www.jamesh.id.au/software/libglade/), version
-      2.6 or later.
+Installing the following packages will allow your PSPP binary to read
+Gnumeric files.
+
+    * 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.
+
+      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.
+
+    * zlib (http://www.zlib.net/).
+
+    * libxml2 (http://xmlsoft.org/).  

 
 The following packages are optional.
 
 
 The following packages are optional.
 


@@ -66,11 +79,8 @@ 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.
 

-    * zlib (http://www.zlib.net/).  Installing zlib and libxml2 will
-      allow your PSPP binary to read Gnumeric files.
-
-    * libxml2 (http://xmlsoft.org/).  Installing zlib and libxml2 will
-      allow your PSPP binary to read Gnumeric files.
+    * libpq, from Postgresql (http://postgresql.org). This enables PSPP 
+      to read Postgresql databases.

 
 Basic Installation
 ==================
 
 Basic Installation
 ==================


@@ -95,6 +105,23 @@ release.
   1. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.
 
   1. `cd' to the directory containing the package's source code and type
      `./configure' to configure the package for your system.
 

+     You may invoke `configure' with --help to see what options are
+     available.  The most common of these are listed under "Optional
+     Features", below.
+
+     It is best to build and install PSPP in directories whose names do
+     not contain unusual characters such as spaces or single-quotes, due
+     to limitations of the tools involved in the build process.
+
+     If you installed some of the libraries that PSPP uses in a
+     non-standard location (on many systems, anywhere other than
+     /usr), you may need to provide some special flags to `configure'
+     to tell it where to find them.  For example, on GNU/Linux, if you
+     installed some libraries in /usr/local, then you need to invoke
+     it with at least the following options:
+
+       ./configure LDFLAGS='-L/usr/local/lib -Wl,-rpath,/usr/local/lib' CPPFLAGS='-I/usr/local/include'
+

      Running `configure' takes awhile.  While running, it prints some
      messages telling which features it is checking for.
 
      Running `configure' takes awhile.  While running, it prints some
      messages telling which features it is checking for.
 


@@ -122,8 +149,9 @@ release.
 
   4. Type `make install' to install the programs and any data files
      and documentation.  Ordinarily you will need root permissions to
 
   4. Type `make install' to install the programs and any data files
      and documentation.  Ordinarily you will need root permissions to

-     do this; if you cannot get root permissions, see "Installation
-     Names", below.
+     do this.  The "su" and "sudo" commands are common ways to obtain
+     root permissions.  If you cannot get root permissions, see
+     "Installation Names", below.

 
   5. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the
 
   5. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the


@@ -193,6 +221,25 @@ Optional Features
     Build the gui developer tools.  There is no reason to use this
     option unless you're involved with the development of PSPP
 
     Build the gui developer tools.  There is no reason to use this
     option unless you're involved with the development of PSPP
 

+`--without-lib{xx}'
+    Optional libraries should normally be detected and the relevant
+    functionality will be built they exist.  However, on some poorly
+    configured systems a library may exist, but be totally broken.
+    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.
+
+`--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>".

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