Table of Contents
*****************


INSTALL - how to compile and install GNU Solfege 1.9.10 on a GNU like system
  Download
    Source code
    Precompiled binaries
  Requirements
  Configuring and compiling
    `--with-buggy-distro'
    `--with-local-xmlcatalog'
    `--with-swig13'
    `--without-gnome'
    `--without-gtkhtml'
    `--disable-oss-sound'
  Precompiled binaries
  Packaging
    Debian
    RedHat 8.0


INSTALL - how to compile and install GNU Solfege 1.9.10 on a GNU like system
****************************************************************************

   This file contains info on how to build and install GNU Solfege.
For run-time info, check the README file and the man page.

   The homepage for GNU Solfege, `http://www.solfege.org', might also
be of interest.

Download
========

Source code
-----------

   The latest version is available from
`http://download.sourceforge.net/solfege' or (same server, other look)
`http://sourceforge.net/project/showfiles.php?group_id=1465'.

   The source code is also available from the GNU ftp sites and their
mirrors: `ftp://alpha.gnu.org/gnu/solfege' and
`ftp://ftp.gnu.org/gnu/solfege'.

Precompiled binaries
--------------------

   Precompiled binaries are made available for some releases. I am
depending on users of other linux distros to provide these binaries.

   These are only available from Sourceforge:
`http://download.sourceforge.net/solfege' or
`http://sourceforge.net/project/showfiles.php?group_id=1465'.

Requirements
============

   The requirements are listed in the `README' file.

Configuring and compiling
=========================

     ./configure
     make
     su -c "make install"

   should work, and will install into

       /usr/local/bin
       /usr/local/share
       /usr/local/lib
       /usr/etc/solfege1.9

   Since Solfege require GNU m4 and GNU make, FreeBSD should do
something like this:

     M4=/usr/local/bin/gm4 ./configure
     gmake
     su -c "gmake install"

   If you first try without setting the `M4' variable, and see
configure fail, then you have to delete the file `config.cache' before
running the example above.

   Use the `--prefix' and `--sysconfdir' command line options to
install elsewhere. For example to install in your home directory:

     ./configure --prefix=$HOME/usr --sysconfdir=$HOME/etc
     make
     make install

   If you just want to run Solfege without installing, do this:
     ./configure
     make
     ./solfege.py

   The `configure' script can be given a number of options to enable
and disable various features. Some of them are described below.  For a
complete list, type:

     ./configure --help

`--with-buggy-distro'
---------------------

   Use this option if you have problems detecting some of the software
that are required, for example PyGNOME. Using this option will make the
configure script use black magick to check if software are installed
even if the linux distribution (for example RedHat 8.0) does not include
the proper files to check for this.

`--with-local-xmlcatalog'
-------------------------

   Use this option if your `/etc/xml/catalog' file is broken or
missing. If `/etc/xml/catalog' is missing, then `xsltproc' will fetch
the DTD using the network. With this option, the build system will use
the file `online-docs/stupid_catalog_file.cat' included in the Solfege
source tarball. You might have to edit the file if the file names is
different on your system.

`--with-swig13'
---------------

   By default Solfege require Swig 1.1 installed to build properly.
Use this option if you have Swig 1.3 installed.

`--without-gnome'
-----------------

   If found by `configure', Solfege will take advantage of functions in
the GNOME libraries. Use this option to build the application run
without GNOME even if the libraries are found.

`--without-gtkhtml'
-------------------

   If found by `configure', Solfege will be built to use gtkhtml2, the
htmlwidget included in GNOME2. Use this option to build the application
to run without gtkhtml2, even if the libraries are found.

`--disable-oss-sound'
---------------------

   Use this if you are compiling on an OS that don't have the OSS.  The
default is `--enable-oss-sound'.

Precompiled binaries
====================

   A debian package is available www.debian.org, but this is not always
the latest release, because we want stable software in Debian.

   I am depending on users of other linux distros to provide precompiled
binaries. At the time Solfege 1.9.5 was released, binary packages for
RedHat 8.0 had been contributed.

Packaging
=========

Debian
------

   Rename `debian-dir' to `debian' and run:

     dpkg-buildpackage -rfakeroot -us -uc

RedHat 8.0
----------

   The file `solfege.redhat8.spec' should work for RedHat 8.0, but it
still need some adjustments and it is possible that some if its
dependencies are not listed.

   It should be possibly to use the spec file other distributions with
a few adjustments. Note that Solfege require quite new versions of some
programs/libs.

   To create rpm and src.rpm package, run:

     rpm -ta solfege-1.9.10.tar.gz

   or unpack the tarball, edit the spec file as necessary and run:

     rpm -ba solfege.redhat8.spec

   Hopefully, binary rpm packages for some distributions will be
provided later.  

