INSTALL - compiling and installing GNU LilyPond
***********************************************
-ABSTRACT
-========
-
- This document explains what you need to install LilyPond, and what
-you should do. If you are going to compile and install LilyPond often,
-e.g. when doing development, you might want to check out the
-`buildscripts/set-lily.sh' script. It sets some environment variables
-and symlinks, which comes in handly when you have to compile LilyPond
-more often.
-
-OBTAINING
+Obtaining
=========
- You can get the latest version of LilyPond at <
-ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/>. Refer to the links document for
-mirror sites.
+ You can get the latest version of LilyPond at
+ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
_If you upgrade by patching do remember to rerun autoconf after
applying the patch_.
-PREREQUISITES
+ If you do not want to download the entire archive for each version,
+the safest method for upgrading is to use `xdelta', see
+`ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
+
+ The following command produces `lilypond-1.3.122.tar.gz' from
+`lilypond-1.3.121' identical (up to compression dates) to the .122 on
+the FTP site.
+ xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
+
+Prerequisites
=============
For compilation you need:
* A GNU system: GNU LilyPond is known to run on these GNU systems:
Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
- and Solaris.
+ and Solaris.
* Lots of disk space: LilyPond takes between 30 and 100 mb to
compile if you use debugging information. If you are short on
disk-space run configure with `--disable-debugging'.
- Although we recommend to use Unix, LilyPond is known to run on
- Windows NT/95/98 as well. See Section *Note w32::.
+ * Although we recommend to use Unix, LilyPond is known to run on
+ Windows NT/95/98 as well. See Section Windows NT/95,es.
- * EGCS 1.1 or newer. Check out < ftp://ftp.gnu.org/pub/gcc/>
+ * A reasonable C++ compiler: EGCS 1.1, GCC 2.95.2 or newer. Check
+ out `ftp://ftp.gnu.org/gnu/gcc/'.
- * Python 1.5, Check out <ftp://ftp.python.org> or
- <ftp://ftp.cwi.nl/pub/python>.
+ * Python 1.5, Check out `ftp://ftp.python.org' or
+ `ftp://ftp.cwi.nl/pub/python'.
- * GUILE 1.3, check out
- <http://www.gnu.org/software/guile/guile.html>.
+ * GUILE 1.3.4 or newer, check out
+ http://www.gnu.org/software/guile/guile.html
+ (http://www.gnu.org/software/guile/guile.html). Version 1.4 is
+ recommended for better performance.
- * GNU make. Check out <ftp://ftp.gnu.org/make/>.
+ * GNU Make. Check out ftp://ftp.gnu.org/gnu/make/
+ (ftp://ftp.gnu.org/gnu/make/).
- * Flex (version 2.5.4 or newer). Check out
- <ftp://ftp.gnu.org/flex/>.
+ * Flex (version 2.5.4a or newer). Check out
+ ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/
+ (ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/).
* Bison (version 1.25 or newer). Check out
- <ftp://ftp.gnu.org/bison/>.
+ ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
- * Texinfo. Check out <ftp://ftp.gnu.org/pub/texinfo/>. Most
- documentation is in texinfo.
+ * TeX. If you want LilyPond to use kpathsea support (recommended),
+ 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.
- * Yodl. Needed for obsolete docs (1.31.17)
- <ftp://ftp.lilypond.org/pub/yodl>.
+ * Texinfo (version 4.0 or newer). Check out
+ ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/texinfo/).
+ Most documentation is in texinfo.
* The geometry package for LaTeX is needed to use ly2dvi. Available
at
- <ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry>
- or at mirror site <ftp://ftp.dante.de>
+ ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
+ (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
+ or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
- * MetaPost, if you want to use direct PostScript output. Please note
- that tetex-0.4pl8 (included with Redhat 5.x) does not include
- `mfplain.mp', which is needed for producing the scaleable font
+ * MetaPost, needed for generating PostScript fonts. Please note that
+ tetex-0.4pl8 (included with Red Hat 5.x) does not include
+ `mfplain.mp', which is needed for producing the scalable font
files.
+ If you do not want to use PostScript output, edit `mf/GNUmakefile',
+ removing the line saying `PFA_FILES='
-RUNNING
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX.
+
+
+Running
=======
GNU LilyPond does use a lot of resources. For operation you need the
following software
- * TeX
+ * TeX.
* A PostScript printer and/or viewer (such as Ghostscript) is
strongly recommended. Xdvi will show all embedded PostScript
too if you have Ghostscript installed.
- * GUILE 1.3, check out <http://www.gnu.org/programs/guile.html>
+ * GUILE 1.3.4, or newer. Check out
+ http://www.gnu.org/software/guile/
+ (http://www.gnu.org/programs/guile.html)
For running LilyPond successfully you have to help TeX and MetaFont
find various files. The recommended way of doing so is adjusting the
-environment variables in the start-up scripts of your shell. An
-example is given here for the Bourne shell:
- export MFINPUTS="/usr/local/share/lilypond/mf:"
- export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
+environment variables in the start-up scripts of your shell. Appropriate
+Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' after compilation.
- The empty path component represents TeX and MetaFont's default
-search paths. Scripts with the proper paths for the bourne and C-shell
+ The empty path component represents TeX and MetaFont's default search
+paths. Scripts with the proper paths for the bourne and C-shell
respectively are generated in `buildscripts/out/lilypond-profile' and
`buildscripts/out/lilypond-login' during compilation.
- LilyPond is a hiddeously big, slow and bloated program. A fast CPU
-and plenty of RAM is recommended for comfortable use.
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
-WEBSITE
+Website
=======
The website is the most convenient form to use for reading the
documentation on-line documentation. It is made by entering
- make website
- This does require a fully functioning
+ make htmldoc
+ This does require a functioning LilyPond. The binary doesn't have to
+be installed.
If you want to auto-generate Lily's website, you'll need some
additional conversion tools.
- * YODL 1.31.15 or later.
+ * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities)
+ (For Red Hat Linux users: it is included within the
+ package libgr-progs). The original is at
+ ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
- * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
- users: it is included within the package libgr-progs).
- the original is at
- <ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz>
-
- * pnmtopng, which is also in libgr-progs for RedHat. The original is
- at
- <ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz>.i
+ * pnmtopng (also in libgr-progs for Red Hat). The original is at
+ ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
- The version of `pnmtopng' that is distributed with RedHat 5.1 and
+ The version of `pnmtopng' that is distributed with Red Hat 5.1 and
5.2 contains a bug: pnmtopng is dynamically linked to the wrong
- version of libpng, which results in cropped images. Recompile it
- from source, and make sure that the pnmtopng binary is linked
- statically to the libpng that is included in libgr. RedHat 6.0
- does not have this problem.
+ version of libpng.
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
+ * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
+ Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/bib2html/).
+ Bibtex2html is available in debian, while bib2html is in some rpm
+ based distributions. Bib2html, in turn depends on man2html for
+ proper installation. man2html can be had from
+ http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
+ (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
- You can then install the new pnmtopng into `/usr/local/bin/'
+ The website will build without bib converter utility, but you will
+ not see our hypertextified bibliography.
- * Bib2html <http://pertsserver.cs.uiuc.edu/~hull/bib2html.>
- Which, in turn depends on man2html for proper installation.
- man2html can be had from
- <http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05>.
- The website will build without this utility, but you will not see
- our hypertextified bibliography.
-
- * Doc++ (optional) to read the source code.
-
-
- You also have to install `buildscripts/out/ps-to-gifs' in a
-directory that is in the path.
-
-CONFIGURING and COMPILING
+Configuring and compiling
=========================
to install GNU LilyPond, simply type:
-
gunzip -c lilypond-x.y.z | tar xf -
cd lilypond-x.y.z
./configure # fill in your standard prefix with --prefix
This will install a number of files, something close to:
- /usr/local/man/man1/mi2mu.1
- /usr/local/man/man1/convert-mudela.1
- /usr/local/man/man1/mudela-book.1
+ /usr/local/man/man1/midi2ly.1
+ /usr/local/man/man1/abc2ly.1
+ /usr/local/man/man1/etf2ly.1
+ /usr/local/man/man1/convert-ly.1
+ /usr/local/man/man1/lilypond-book.1
/usr/local/man/man1/lilypond.1
/usr/local/bin/lilypond
- /usr/local/bin/mi2mu
+ /usr/local/bin/midi2ly
+ /usr/local/bin/convert-ly
+ /usr/local/bin/lilypond-book
+ /usr/local/bin/abc2ly
+ /usr/local/bin/pmx2ly
+ /usr/local/bin/musedata2ly
+ /usr/local/bin/etf2ly
/usr/local/share/lilypond/*
- /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+ /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo
The above assumes that you are root and have the GNU development
tools, and your make is GNU make. If this is not the case, you can
`CPPFLAGS' are the preprocessor flags.
The configure script is Cygnus configure, and it will accept
-*-help*. If you are not root, you will probably have to make it with a
-different *-prefix* option. Our favourite location is
+`--help'. If you are not root, you will probably have to make it with a
+different `--prefix' option. Our favourite location is
./configure --prefix=$HOME/usr
Options to configure include:
-`*--enable-printing*'
- Enable debugging print routines (lilypond *-D* option)
+``--enable-printing''
+ Enable debugging print routines (lilypond `-D' option)
-`*--enable-optimise*'
- Set maximum optimisation: compile with *-O2*. This can be
+``--enable-optimise''
+ Set maximum optimisation: compile with `-O2'. This can be
unreliable on some compiler/platform combinations (eg, DEC Alpha
and PPC)
-`*--enable-profiling*'
+``--enable-profiling''
Compile with support for profiling.
-`*--enable-config*'
+``--enable-config''
Output to a different configuration file. Needed for
multi-platform builds
All options are documented in the `configure' help The option
-*-enable-optimise* is recommended for Real Life usage.
+`--enable-optimise' is recommended for Real Life usage.
If you do
resulting binaries can be found in the subdirectories `out/' (which
contain all files generated during compilation).
-CONFIGURING FOR MULTIPLE PLATFORMS
+Configuring for multiple platforms
==================================
If you want to compile LilyPond with different configuration
-settings, then, you can use the *-enable-config* option. Example:
+settings, then, you can use the `--enable-config' option. Example:
suppose I want to build with and without profiling. Then I'd use the
following for the normal build,
and for the profiling version, I specify a different configuration.
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
+ make config=prof
+ make config=prof install
-INSTALLING
+Installing
==========
- If you have done a successful `make', then a simple
+ if you have done a successful `make', then a simple
make install
`.pk' and `.tfm' files of the fonts. A script has been provided to do
the work for you, see `bin/clean-fonts.sh'.
-CAVEATS
-=======
-
- * The -O2 option triggers bugs on various platforms (PowerPC,
- Alpha). If you experience problems, you should first try
- turning off this.
-
- * On PPC you need at least EGCS-1.1.2f.
-
-REDHAT LINUX
-============
+Red Hat Linux
+=============
- RedHat Linux users can compile an RPM. A spec file is in
-`make/out/lilypond.spec', it is distributed along with the sources.
+ Red Hat Linux users can compile an RPM. A spec file is in
+`make/out/lilypond.spec'; it is distributed along with the sources.
You can make the rpm by issuing
rpm -tb lilypond-x.y.z.tar.gz
rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
- Precompiled i386 RedHat RPMS are available from
-<ftp://freshmeat.net/pub/rpms/lilypond/> and
-<http://linux.umbc.edu/software/lilypond/rpms/>.
+ Precompiled Red Hat 7.0 i386 RPMS are available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
- For compilation on a RedHat system you need these packages, in
-addition to the thoes needed for running:
+ For compilation on a Red Hat system you need these packages, in
+addition to the those needed for running:
* glibc-devel
* libstdc++-devel
* bison
-DEBIAN GNU/LINUX
+ * texinfo
+
+ * tetex-devel
+
+Debian GNU/Linux
================
- A Debian package is also available; contact Anthony Fok
-<foka@debian.org>. The build scripts are in the subdirectory `debian/'.
+ A Debian package is also available. You may install it easily by
+using apt-get as root:
+
+ apt-get install lilypond1.3
+
+ Alternatively, visit
+
+ * http://packages.debian.org/lilypond
+ (http://packages.debian.org/lilypond)
+
+ * http://ftp.debian.org/debian/pool/main/l/lilypond1.3/
+ (http://ftp.debian.org/debian/pool/main/l/lilypond1.3/) for latest
+ package uploaded to Debian unstable;
+
+ * http://people.debian.org/~foka/lilypond/
+ (http://people.debian.org/~foka/lilypond/) for latest
+ semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2
+ (potato) users. The official stable Debian 2.2r2 is stuck with
+ the old LilyPond-1.3.24.
+
+ You may contact Anthony Fok <foka@debian.org> for more information.
+
+ The build scripts are in the subdirectory `debian/'; you can make
+the .deb by doing, for example:
+
+ $ su - root
+ # dpkg --purge lilypond lilypond1.3
+ # exit
+ $ tar xzf lilypond-1.3.122.tar.gz
+ $ cd lilypond-1.3.122
+ $ dch -p -v 1.3.122-0.local.1 "Local build."
+ $ debuild
+ $ su - root
+ # dpkg -i ../lilypond1.3_1.3.122*.deb
+ # exit
+ $
+
+ For compilation on a Debian GNU/Linux system you need these packages,
+in addition to the those needed for running:
+
+ * g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
+
+ * libguile<your-libguile-version-here>-dev
+
+ * make, m4, flex, bison
+
+ * gettext
+
+ * groff, texinfo, bibtex2html (not in 2.2r2)
-WINDOWS NT/95
+ * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+
+ * dpkg-dev, debhelper, fakeroot
+
+ * gs, netpbm, pnmtopng
+
+ Most of these are listed on the Build-Depends line in the
+debian/control file. To ensure the creation of the lilypond deb is
+trouble-free, we recommend that you first install the following packages
+before starting dpkg-buildpackage by running apt-get as root.
+
+ For Debian 2.2 (or 2.2r2, 2.2r3):
+
+ apt-get install task-debian-devel task-c++-dev \
+ python-base libguile6-dev tetex-bin tetex-dev \
+ tetex-extra flex bison texinfo groff gs \
+ netpbm pnmtopng m4 gettext
+
+ For Debian in development ("unstable", the future 2.3 or 3.0):
+
+ apt-get install task-debian-devel task-c++-dev \
+ python-base libguile9-dev tetex-bin libkpathsea-dev \
+ tetex-extra flex bison texinfo bibtex2html groff gs \
+ netpbm pnmtopng m4 gettext
+
+ And, just so that old fonts from previous versions of LilyPond won't
+interfere with your build, you may want to do this before the build too:
+
+ dpkg --purge lilypond lilypond1.3
+
+Windows NT/95
=============
- Separate instructions on building for W32 are available
-<../../outdir/README-W32.html>.
+ Separate instructions on building for W32 are available; See the
+files in `Documentation/ntweb/', included with the sources.
+
+Problems
+========
-BUGS
-====
+ For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>. Please consult the faq before mailing
+your problems.
- Send bug reports to bug-gnu-music@gnu.org. For help and questions
-use help-gnu-music@gnu.org and gnu-music-discuss@gnu.org. Please
-consult the faq before mailing your problems.
+ If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
-AUTHORS
-=======
+ Bugs that are LilyPond's fault are listed in our TODO list on the
+web, or demonstrated in `input/bugs/'.
+
+ Bugs that are not LilyPond's fault are documented here.
+
+LinuxPPC Bugs:
+**************
+
+ * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
+ fixed in egcs-1.1.2-12f or gcc-2.95-0a,
+ `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
+
+ * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
+ particular guile-1.3, and Lily herself will break.
+
+Linux-i386
+**********
+
+ * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+
+ Lily will crash during parsing (which suggests a C++ library
+ incompatibility). Precise cause, precise platform description or
+ solution are not known.
+
+ Note that this only happens on some computers with the said
+ platform.
+
+ * libg++ 2.7
+
+ LilyPond occasionally crashes while parsing the initialisation
+ files. This is a very obscure bug, and usually entering the
+ commandline differently "fixes" it.
+
+ lilypond input.ly
+
+ and
+ lilypond -I. ./input.ly
+ makes a difference
+
+ Typical stacktrace:
+ SIGSEGV
+ __libc_malloc (bytes=16384)
+ ?? ()
+ yyFlexLexer::yy_create_buffer ()
+ Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
+
+ This behaviour has been observed with machines that have old libg++
+ versions (LinuxPPC feb '98, Red Hat 4.x).
+
+Solaris:
+********
+
+ * Sparc64/Solaris 2.6, GNU make-3.77
+
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
+
+ * Sparc64/Solaris 2.6, ld
+
+ Not yet resolved.
+
+AIX
+***
+
+ * AIX 4.3 ld
- Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ The following is from the gcc install/SPECIFIC file.
+ Some versions of the AIX binder (linker) can fail with a
+ relocation overflow severe error when the -bbigtoc option
+ is used to link GCC-produced object files into an
+ executable that overflows the TOC. A fix for APAR IX75823
+ (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
+ available from IBM Customer Support and from its
+ 27service.boulder.ibm.com website as PTF U455193.
- Jan Nieuwenhuizen <janneke@gnu.org>
+ Binutils does not support AIX 4.3 (at least through release
+ 2.9). GNU as and GNU ld will not work properly and one
+ should not configure GCC to use those GNU utilities. Use
+ the native AIX tools which do interoperate with GCC.
- In case of problems, please use the mailing list for help.
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
- Have fun!