From 6bae018e92d45abceef4224117a147f87f2853a9 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 27 Jul 2007 21:38:12 +0000 Subject: [PATCH] Bug #19069. * INSTALL: Improve installation instructions. * README: Move prerequisites to INSTALL. Reviewed by Jason Stover. --- ChangeLog | 5 ++ INSTALL | 139 ++++++++++++++++++++++++++++++++++++++++++++---------- README | 47 ++++-------------- 3 files changed, 128 insertions(+), 63 deletions(-) diff --git a/ChangeLog b/ChangeLog index 6329333d..dce0df29 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2007-07-27 Ben Pfaff + Bug #19069. + * INSTALL: Improve installation instructions. + * README: Move prerequisites to INSTALL. + Reviewed by Jason Stover. + * configure.ac: Make PKG_CHECK_MODULES tests more user-friendly, by having them give their errors at the end of the configuration process instead of stopping it in the middle. Patch #6116. diff --git a/INSTALL b/INSTALL index 9ae05a33..2cff2882 100644 --- a/INSTALL +++ b/INSTALL @@ -1,11 +1,75 @@ -Installation Instructions -************************* +PSPP Installation Instructions +****************************** -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free -Software Foundation, Inc. +These instructions are based on the generic GNU installation +instructions, but they have been tailored for PSPP. -This file is free documentation; the Free Software Foundation gives -unlimited permission to copy, distribute and modify it. +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. + +If you do not know whether you have these installed already, you may +proceed to "Basic Installation", below. The PSPP configuration +process will notify you about required and optional packages that are +not present on your system. + +The following packages are required to install PSPP: + + * An ANSI 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/), + version 1.6 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. + + * 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/). + +The following package is required to enable PSPP's graphing features. +If you cannot arrange to install it, you must run `configure' with +--without-libplot. + + * libplot, from GNU plotutils + (http://www.gnu.org/software/plotutils/). + +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. + + * GTK+ (http://www.gtk.org/), version 2.6.0 or later, although we + recommend version 2.10.2 or later. + + * libglade (http://www.jamesh.id.au/software/libglade/), version + 2.0 or later. + +The following packages are optional. + + * libncurses (http://www.gnu.org/software/ncurses/). Without it, + PSPP will assume it is running in an 80x25 terminal. + + * libreadline and libhistory + (http://tiswww.case.edu/php/chet/readline/rltop.html). Without + them, interactive command editing and history features in the + text-based user interface will be disabled. + + * Texinfo (http://www.gnu.org/software/texinfo/), version 4.7 or + later. Installing Texinfo will allow you to build PSPP + documentation in PostScript or PDF format. + +The following packages are optional. They are useful primarily for +PSPP developers. + + * pkg-config (http://pkg-config.freedesktop.org/wiki/). This is + needed only to regenerate configure after modifying + configure.ac. Basic Installation ================== @@ -20,31 +84,42 @@ http://www.gnu.org/software/autoconf/manual/html_node/Running-configure-Scripts. The `configure' shell script attempts to guess correct values for various system-dependent variables used during compilation. + If you need to do unusual things to compile the package, please +report the problem to bug-gnu-pspp@gnu.org. We will try to figure out +how `configure' could work better in your situation for the next +release. - 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 pspp-dev@gnu.org so they can -be considered for the next release. - - -The simplest way to compile PSPP 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 - using `csh' on an old version of System V, you might need to type - `sh ./configure' instead to prevent `csh' from trying to execute - `configure' itself. + `./configure' to configure the package for your system. Running `configure' takes awhile. While running, it prints some messages telling which features it is checking for. + When `configure' completes, it may print a list of packages that + you must install before PSPP. If it does, you need to install + those packages, then re-run this step. Some prerequisites may be + omitted by passing a --without- flag to `configure' (see + "Optional Features", below). If you use one of these flags, then + the feature that it disables will not be available in your PSPP + installation. + + `configure' may also print a list of packages that you should + consider installing. If you install them, additional features + will be available in your PSPP installation. + 2. Type `make' to compile the package. - 3. Optionally, type `make check' to run the self-tests that come with - the package. + 3. Optionally, type `make check' to run the self-tests that come + with the package. If any of the self-tests fail, please mail + bug-gnu-pspp@gnu.org with the details, to give the PSPP + developers an opportunity to fix the problem in the next release. - 4. Type `make install' to install the programs and any data files and - documentation. You will need root permissions to do this. + 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. 5. You can remove the program binaries and object files from the source code directory by typing `make clean'. To also remove the @@ -64,8 +139,7 @@ is an example: ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix - *Note Defining Variables::, for more details. - + See "Defining Variables", below, for more details. Installation Names ================== @@ -75,6 +149,16 @@ By default, `make install' installs PSPP's commands under can specify an installation prefix other than `/usr/local' by giving `configure' the option `--prefix=PREFIX'. + You may wish to install PSPP on a machine where you do not have +root permissions. To do so, specify a prefix relative within your +home directory, e.g. `--prefix=$HOME' or `--prefix=$HOME/inst'. All +PSPP files will be installed under the prefix directory, which `make +install' will create if necessary. You may run PSPP directly from the +`bin' directory under the prefix directory as, e.g., `~/inst/bin/pspp' +under most shells, or for added convenience you can add the +installation directory to your PATH by editing a shell startup file +such as `.bashrc'. + You can specify separate installation prefixes for architecture-specific files and architecture-independent files. If you pass the option `--exec-prefix=PREFIX' to `configure', the package uses @@ -118,7 +202,7 @@ them in the `configure' command line, using `VAR=value'. For example: ./configure CC=/usr/local2/bin/gcc 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: +overridden in the site shell script). Here is another example: /bin/bash ./configure CONFIG_SHELL=/bin/bash @@ -162,3 +246,10 @@ Generic `configure' Options `configure' also accepts some other, not widely useful, options. Run `configure --help' for more details. +---------------------------------------------------------------------- +Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, 2007 Free +Software Foundation, Inc. + +This file is free documentation; the Free Software Foundation gives +unlimited permission to copy, distribute and modify it. + diff --git a/README b/README index 3034f989..da94b711 100644 --- a/README +++ b/README @@ -6,41 +6,8 @@ PSPP development is ongoing. It already supports a large subset of SPSS's transformation language. Its statistical procedure support is currently limited, but growing. -Instructions for installation are in INSTALL. Before you install -PSPP, you will need to install certain prerequisites: - - * An ANSI C compiler and tool chain. - - * The GNU Scientific Library (libgsl), version 1.6 or later, - including libgslcblas included with GSL. - - * Perl, version 5.005_03 or later. (Perl is required during build - but not after installation.) - - * pkg-config (only if you need to regenerate configure after - modifying configure.ac). - - * 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/). - - * Optional: libncurses. Without it, PSPP will assume it is - running in an 80x25 terminal. - - * Optional: libreadline and libhistory. Without them, interactive - command editing and history features will be disabled. - - * Optional: libplot (from GNU plotutils). Without it, - graphing features will not work. If you do not have it - installed, you must run `configure' with --without-libplot. - - * Optional: GTK+ version 2.6.0 or later (2.10.2 or later is - recommended), plus libglade 2.0 or later. Without them, the - GUI will not be built. If you do not have these installed, you - must run `configure' with --without-gui. - - * Optional: Texinfo 4.7 or later, if you want to build the - documentation in PostScript or PDF format. +Instructions for PSPP installation are in INSTALL, including a list of +prerequisite packages and other PSPP-specific information. For information on differences from previous versions, please see file NEWS. Full documentation on PSPP's language can be found in the doc/ @@ -53,8 +20,9 @@ CVS at http://savannah.gnu.org/projects/pspp Questions and comments about using PSPP may be sent to pspp-users@gnu.org. Bug reports may be filed at http://savannah.gnu.org/bugs/?group=pspp -or emailed to bug-gnu-pspp@gnu.org. (We prefer the web-based system -because it makes it more difficult for us to lose track of bugs.) +or emailed to bug-gnu-pspp@gnu.org. We prefer the web-based system +because it makes it more difficult for us to lose track of bugs, but we +are happy to hear from users through any means. The long term goals for PSPP are ambitious. We wish to provide the following support to users: @@ -71,8 +39,9 @@ following support to users: an "enhanced" mode in certain cases where PSPP can output better results that may surprise SPSS users. - * Friendly textual and graphical interfaces. PSPP does not do - a good job of this yet. + * Friendly textual and graphical interfaces. This release + includes the first version of PSPPIRE, the PSPP graphical + user interface. * Attractive output, including graphs, in a variety of human- and machine-readable formats. PSPP currently produces -- 2.30.2