docs
[pspp] / README.Git
1 Prerequisites for Building PSPP from Git
2 ----------------------------------------
3
4 To build this project from the sources direct from the Git archive,
5 you must install the prerequisites listed in README, plus the
6 following:
7
8         * Autoconf 2.60 (or later).
9
10         * Automake 1.10 (or later).
11
12         * Gettext 0.19 (or later).
13
14         * GNU M4 1.4.9 (or later).
15
16         * pkg-config 0.21 (or later).
17
18         * gperf 3.0.1 (or later).
19
20         * Gnulib (see below for details).
21
22         * libtool 1.5.22 (or later).
23
24         * Texinfo 5.2 or later, to build the documentation.
25
26         * Gimp --  2.8.2 is known to work
27
28 After you install PSPP's prerequisites, you must obtain a copy of
29 Gnulib, then bootstrap the tree, as described in the sections below.
30 After that, you may follow the procedure described in INSTALL.
31
32 Obtaining Gnulib
33 ----------------
34
35 This version of PSPP should work with the Gnulib commit shown below.
36 Gnulib does not maintain a stable API or ABI, so it is possible that
37 PSPP will not work with older or newer versions of Gnulib.
38
39  commit 2d830e4a792fcd9f614ed08a7f18584b8b21d23b (HEAD, origin/master, origin/HEAD)
40  Author: Bruno Haible <bruno@clisp.org>
41  Date:   Sun Mar 13 15:12:46 2022 +0100
42
43      sigsegv: Add support for Linux/PowerPC (32-bit) with musl libc.
44
45 To clone Gnulib into a directory named "gnulib" using Git, and then
46 check out this particular commit, run these commands:
47         git clone git://git.savannah.gnu.org/gnulib.git gnulib
48         cd gnulib
49         git checkout $COMMIT
50 where $COMMIT should be replaced by the commit number listed above
51 (usually it is sufficient to just type the first 6 or so digits).
52
53 If you do not have Git installed, then you may alternately download
54 http://git.savannah.gnu.org/gitweb/?p=gnulib.git;a=snapshot;h=$COMMIT;sf=tgz
55 where $COMMIT is, again, at least the first few digits of the commit
56 number listed above.  This download will yield a tar.gz file that you
57 may extract with "gunzip" and "tar" to yield identical results.
58
59 Bootstrapping
60 -------------
61
62 Once you have Gnulib installed, PSPP must be "bootstrapped" using the
63 following command:
64         make -f Smake
65 If you checked Gnulib out in a directory named `gnulib' at the same
66 level as PSPP, then this is sufficient.  Otherwise, provide the
67 location of GNULIB on the `make' command line:
68         make -f Smake GNULIB=/gnulib/base/directory/name
69
70 After executing Smake, follow the procedure described in INSTALL to
71 build and install PSPP.  On some systems this may be as simple as:
72         ./configure
73         make
74
75 Once PSPP is built, you may run its self-tests with:
76         make check
77 or for a more thorough test:
78         make distcheck
79
80 Building from git on Mac OS
81 ---------------------------
82
83 You can build on MacOS in the macports environment. After installing all
84 required packages to resolve library dependencies and autotools e.t.c, you
85 run make -f Smake as described above.
86
87 The macports system provides the libraries and header files in a separate
88 location from the MacOS system libraries. The typical locations are
89
90 Libraries: /opt/local/lib
91 Headers:   /opt/local/include
92
93 pspp under macports will be linked against the macports libraries. The configure
94 script has to be informed about the library and header locations. Assume the following
95 directory structure for an out of tree build:
96
97 ~/mypspp
98   |----pspp    (This is the pspp git directory)
99   |----install (The install location containing also ui files for psppire)
100   |----build   (The build directory)
101   |----gnulib  (The gnulib directory as described above)
102
103 Then you can build with the following commands:
104
105     cd ~/mypspp/pspp
106     make -f Smake
107     cd ../build
108     ../pspp/configure --prefix=/Users/USER/mypspp/install \
109                   LDFLAGS=-L/opt/local/lib \
110                   CPPFLAGS=-I/opt/local/include
111     make
112     make install
113     ../install/bin/psppire (If everything worked, you should see psppire...)