-@node
+@node Top, , , (dir)
+@top
@comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
@setfilename INSTALL.info
@settitle INSTALL - compiling and installing GNU LilyPond
<!--- @@WEB-TITLE@@=Installation Instructions --->
@end html
-@node Top, , , (dir)
-@top
-
@contents
@chapter INSTALL - compiling and installing GNU LilyPond
(1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
site}.
+Building LilyPond is an involved process. We advise to use binary
+packages if these are available for your platform.
+
@subsection Source code
-If you want to compile LilyPond from source, download here:
+ If you want to compile LilyPond from source, download here:
@itemize @bullet
@item Download development releases from
@c Hmm, these won't show up in lilypond.org/stats
For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
tarball; see instructions below.
-
-
Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
from source drill.
The latest development version is also available through anonymous
CVS. See @uref{http://savannah.gnu.org/cvs/?group=lilypond}.
+CVS does not contain generated files. To create @file{configure}, run
+@quotation
+@example
+./autogen.sh
+@end example
+@end quotation
@html
<a name="download-binaries">
released.
@itemize @bullet
-@item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386}
+@item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat-7.x/, Red Hat i386}
@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
@item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
LinuxPPC}
@end example
@end itemize
+@subsection Font problems.
+
+If you are upgrading from a previous version of LilyPond, be sure to
+remove all old font files. These include @file{.pk} and @file{.tfm} files
+that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
+@file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
+script automating this has been included, see
+@file{buildscripts/clean-fonts.sh}.
+
+
+
+
@section Requirements
@subsection Compilation
@TeX{} is used as an output backend.
-Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf}, @file{.afm}, @file{.tfm}).
-Make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
-need to install a tetex-devel or tetex-dev package too.
+Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
+@file{.afm}, @file{.tfm}). Make sure you have tetex 1.0 or newer
+(1.0.6 is known to work). You may need to install a tetex-devel (or
+tetex-dev or libkpathsea-dev) package too.
@item Texinfo (version 4.2 or newer).
The documentation of lily is written in texinfo. Check out
with the @TeX{} distribution.
@item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
-usually included with your installation of @TeX{}. You may need to install
-a tetex-devel or tetex-dev package too. If kpathsea is not installed in
-a directory where the compiler normally looks, read the hints for
-Slackware below.
+usually included with your installation of @TeX{}. You may need to
+install a tetex-devel or tetex-dev package too. If kpathsea is not
+installed in a directory where the compiler normally looks, read the
+hints for Slackware below.
In the very unlikely case that kpathsea is not available for your
platform (ie, you're not running GNU/Linux, Windows, or any recent
LilyPond is a big and slow program. A fast CPU and plenty of RAM is
recommended for comfortable use.
-@subsection Website requirements
+@subsection Building documentation
-The documentation comes in the form of a website. You can view this
-website on the internet, but you can also build it locally. This process
-requires a successful compile of lilypond. The website is built
-by issuing
+You can view the documentation online at
+@uref{http://www.lilypond.org/stable/Documentation/out-www/}, but you
+can also build it locally. This process requires a successful compile of
+lilypond. The documentation is built by issuing
@example
make web-doc
will need to install some additional packages to get mftrace to work.
@end itemize
-@section Building LilyPond
+@section Building LilyPond
to install GNU LilyPond, type:
@example
@c prefix=~ ?
@example
- ./configure --prefix=~ --enable-checking
+ ./configure --prefix=$HOME/usr/ --enable-checking
make
make install
@end example
@example
- ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
make conf=prof
make conf=prof install
with the sources. You can make the rpm by issuing
@example
+ cp lilypond-x.y.z.tar.gz /usr/src/redhat/SOURCES/
tar xfz lilypond-x.y.z.tar.gz
rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
platform.
At least on Slackware 8.0, you have to manually specify the paths to the
-Kpathsea library, using
-@itemize
-@item @code{rm config.cache}
-@item @code{export LDFLAGS=-L/usr/share/texmf/lib}
-@item @code{export CPPFLAGS=-I/usr/share/texmf/include}
-@item @code{./configure}
-@end itemize
+Kpathsea library, see the section on kpathsea
@subsection Mandrake
itself.
-@subsubsection compiling on MacOS X
+@subsection compiling on MacOS X
LilyPond has been built on Darwin, to be precise, on:
@example
Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
Bugs that are not fault of LilyPond are documented here.
+@subsection Linking to kpathsea
+
+If kpathsea and the corresponding header files are installed in some
+directory where GCC does not search by default, for example in
+@file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
+you have to explicitly tell configure where to find it. To do this,
+
+@itemize
+@item @code{rm config.cache}
+@item @code{export LDFLAGS=-L/usr/share/texmf/lib}
+@item @code{export CPPFLAGS=-I/usr/share/texmf/include}
+@item @code{./configure}
+@end itemize
+Once configure has found them, the paths are stored in
+@file{config.make} and will be used even if you don't have the
+environment variables set during make.
+
+
@unnumberedsubsec Gcc-3.0.4
Gcc 3.0.4, is a bit flaky. Try downgrading to 2.95.x, or if you're
@example
CONF=gcc-3.1 ./lexer-gcc-3.1.sh
- CPPFLAGS=$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
+ CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
./configure --enable-config=gcc-3.1
CONF=gcc-3.1 ./lexer-gcc-3.1.sh
make conf=gcc-3.1
@end example
+This assumes that the GCC 3.1 binaries are called gcc-3.1 and g++-3.1.
Note that this is @strong{not} fixed in Debian/unstable for flex <=
2.5.4a-26.
guile-1.4$ ./configure --without-threads; make all install
@end example
+@unnumberedsubsec OpenBSD
+
+@itemize @bullet
+@item By default, gcc on OpenBSD doesn't include
+@file{/usr/local/include} and @file{/usr/local/lib} in the system
+paths. Depending upon where/how you installed kpathsea and other
+libraries, you may need to refer to the section ``Linking to
+kpathsea''.
+
+@end itemize
@unnumberedsubsec NetBSD
@end itemize
-@unnumberedsubsec Solaris:
+@unnumberedsubsec Solaris
@itemize @bullet
+@item Solaris7, ./configure
+
+@file{./configure} needs a POSIX compliant shell. On Solaris7,
+@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
+is. Please run configure like:
+@example
+ /bin/ksh -c ./configure
+@end example
+or
+@example
+ bash -c ./configure
+@end example
+
@item Sparc64/Solaris 2.6, GNU make-3.77
GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.