INSTALL - compiling and installing GNU LilyPond
***********************************************
-ABSTRACT
-========
+Obtaining
+=========
- 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.
+ 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/).
-OBTAINING
-=========
+ There are three options for downloading sources.
- 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.
+ * if you don't have any version, then you can download the entire
+ `.tar.gz' file.
- _If you upgrade by patching do remember to rerun autoconf after
-applying the patch_.
+ * if you have an unpacked source tree of a previous version, you
+ may use the diffs .
-PREREQUISITES
-=============
+ _If you upgrade by patching do remember to rerun autoconf after
+ applying the patch_.
+
+ * if you have the `.tar.gz' file of a previous release, you can use
+ xdelta (ftp://ftp.xcf.berkeley.edu/pub/xdelta/). This is much
+ safer than using normal diffs, and is the recommended way.
+
+ 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
- For compilation you need:
+Build requirements
+==================
- * A GNU system: GNU LilyPond is known to run on these GNU systems:
- Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
- and Solaris.
+ This document describes how to build LilyPond on Unix platforms. It
+is also known to run and compile on Windows NT/95/98 as well. More
+information on this topic can be found at the LilyPond on Windows page
+(http://appel.lilypond.org/lilypond/gnu-windows/).
- * 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'.
+ You need the following packages to compile Lilypond.
- Although we recommend to use Unix, LilyPond is known to run on
- Windows NT/95/98 as well. See Section *Note w32::.
+ * A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or newer.
+ Check out the gcc site (ftp://ftp.gnu.org/gnu/gcc/).
- * EGCS 1.1 or newer. Check out < ftp://ftp.gnu.org/pub/gcc/>
+ * Python 1.5, Check out the python website (http://www.python.org).
- * Python 1.5, Check out <ftp://ftp.python.org> or
- <ftp://ftp.cwi.nl/pub/python>.
+ * GUILE 1.3.4 or newer, check out the GUILE webpage
+ (http://www.gnu.org/software/guile/guile.html). Version 1.4 is
+ recommended for better performance.
- * GUILE 1.3, check out
- <http://www.gnu.org/software/guile/guile.html>.
+ * GNU Make. Check out the GNU make FTP directory
+ (ftp://ftp.gnu.org/gnu/make/).
- * GNU make. Check out <ftp://ftp.gnu.org/make/>.
+ * Flex (version 2.5.4a or newer). Check out the Flex webpage
+ (http://www.gnu.org/software/flex/).
- * Flex (version 2.5.4 or newer). Check out
- <ftp://ftp.gnu.org/flex/>.
+ * Bison (version 1.25 or newer). Check out the bison webpage
+ (http://www.gnu.org/software/bison/)
- * Bison (version 1.25 or newer). Check out
- <ftp://ftp.gnu.org/bison/>.
+ * TeX.
- * Texinfo. Check out <ftp://ftp.gnu.org/pub/texinfo/>. Most
- documentation is in texinfo.
+ TeX is used as an output backend.
- * Yodl. Needed for obsolete docs (1.31.17)
- <ftp://ftp.lilypond.org/pub/yodl>.
+ Also, TeX's libkpathsea is used to find the fonts (.mf, .afm,
+ .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.
- * 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>
+ * Texinfo (version 4.0 or newer). The documentation of lily is
+ written in texinfo. Check out the texinfo FTP directory
+ (ftp://ftp.gnu.org/gnu/texinfo/).
- * 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
+ * The geometry package for LaTeX is needed to use ly2dvi. It is
+ available at the FTP directory for `geometry'
+ (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry).
+ This package is normally included with the TeX distribution.
+
+ * 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 don't have MetaPost and don't want to use PostScript
+ output, then edit `mf/GNUmakefile', removing the line saying
+ `PFA_FILES='.
+
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX. You may need to
+ install a tetex-devel or tetex-dev package too.
+
+ In the very unlikely case that kpathsea is not available for your
+ platform (ie, you're not running GNU/Linux, Windows, or any recent
+ UNIX), you can compile LilyPond without kpathsea support. In that
+ case, you'll probably have to indicate where TeX's tfm files live.
+ Invoke configure something like:
-RUNNING
-=======
+ ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
+
+
+Running requirements
+====================
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.
+ * Xdvi and ghostscript
- * GUILE 1.3, check out <http://www.gnu.org/programs/guile.html>
+ * GUILE 1.3.4, or newer. Check out the GUILE webpage
+ (http://www.gnu.org/software/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 bourne 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
-respectively are generated in `buildscripts/out/lilypond-profile' and
-`buildscripts/out/lilypond-login' during compilation.
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
- LilyPond is a hiddeously big, slow and bloated program. A fast CPU
-and plenty of RAM is recommended for comfortable use.
+Website requirements
+====================
-WEBSITE
-=======
+ 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
- The website is the most convenient form to use for reading the
-documentation on-line documentation. It is made by entering
+ make web-doc
- make website
- This does require a fully functioning
+ Building the website requires some additional tools:
- If you want to auto-generate Lily's website, you'll need some
-additional conversion tools.
+ * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
+ The original is at the netpbm FTP site
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
- * YODL 1.31.15 or later.
+ * pnmtopng. The original is at in the pnmtopng FTP site
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.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>
+ * 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).
- * 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
+ The website will build without bib converter utility, but you will
+ not see our hypertextified bibliography.
- The version of `pnmtopng' that is distributed with RedHat 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.
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
+Configuring and compiling
+=========================
- You can then install the new pnmtopng into `/usr/local/bin/'
+ to install GNU LilyPond, type:
+ gunzip -c lilypond-x.y.z | tar xf -
+ cd lilypond-x.y.z
+ ./configure # run with --help to see appropriate options
+ make
+ make install
+ sh buildscripts/clean-fonts.sh
- * 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>.
+ If you are doing an upgrade, you should remove all `feta' `.pk' and
+`.tfm' files. A script has been provided to do the work for you, see
+`buildscripts/clean-fonts.sh'.
- The website will build without this utility, but you will not see
- our hypertextified bibliography.
+ If you are not root, you should choose a `--prefix' argument that
+points into your home directory, eg.
- * Doc++ (optional) to read the source code.
+ ./configure --prefix=$HOME/usr
+ In this case, you have to insert the contents of
+`buildscripts/out/lilypond-login' or
+`buildscripts/out/lilypond-profile' into your start up scripts by hand.
- You also have to install `buildscripts/out/ps-to-gifs' in a
-directory that is in the path.
+Configuring for multiple platforms
+==================================
-CONFIGURING and COMPILING
-=========================
+ If you want to build multiple versions of LilyPond with different
+configuration settings, you can use the `--enable-config=CONF' option
+of configure. You should use `make conf=CONF' to generate the output
+in `out-CONF'. Example: suppose I want to build with and without
+profiling. Then I'd use the following for the normal build,
- to install GNU LilyPond, simply type:
+ ./configure --prefix=~ --enable-checking
+ make
+ make install
- gunzip -c lilypond-x.y.z | tar xf -
- cd lilypond-x.y.z
- ./configure # fill in your standard prefix with --prefix
- make
- make install
+ and for the profiling version, I specify a different configuration.
- 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/lilypond.1
- /usr/local/bin/lilypond
- /usr/local/bin/mi2mu
- /usr/local/share/lilypond/*
- /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
- 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
-adjust your environment variables to your taste:
+Emacs mode
+==========
+ An emacs mode for LilyPond is included with the source archive as
+`lilypond-mode.el' and `lilypond-font-lock.el'. If you have an RPM, it
+is in `/usr/share/doc/lilypond-X/'. You have to install it yourself.
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- ./configure
+ Add this to your ~/.emacs or ~/.emacs.el:
+ (load-library "lilypond-mode.el")
+ (setq auto-mode-alist
+ (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
+ (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
- `CPPFLAGS' are the preprocessor flags.
+ If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
+is automatically loaded, so you need not modify your `~/.emacs' file.
- 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
+Red Hat Linux
+=============
+ Red Hat 7.0 i386 RPMS are available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
- ./configure --prefix=$HOME/usr
+ You can also compile them yourself. A spec file is in
+`make/out/lilypond.spec'. This file is distributed along with the
+sources. You can make the rpm by issuing
- In this case, you will have to set up MFINPUTS, and TEXINPUTS
-accordingly.
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
- Since GNU LilyPond currently is beta, you are advised to also use
+ For running on a Red Hat system you need these packages: guile,
+tetex, tetex-dvips, libstdc++, python, ghostscript.
+ For compilation on a Red Hat system you need these packages, in
+addition to the those needed for running: glibc-devel, gcc-c++,
+libstdc++-devel, guile-devel, flex, bison, texinfo, tetex-devel, groff,
+libgr-progs.
- --enable-debugging
- --enable-checking
+SuSE
+====
- Options to configure include:
+ [TODO: document this]
-`*--enable-printing*'
- Enable debugging print routines (lilypond *-D* option)
+ Install `tetex', `te_mpost', `te_kpath'.
-`*--enable-optimise*'
- Set maximum optimisation: compile with *-O2*. This can be
- unreliable on some compiler/platform combinations (eg, DEC Alpha
- and PPC)
+Mandrake
+========
-`*--enable-profiling*'
- Compile with support for profiling.
+ [TODO]
-`*--enable-config*'
- Output to a different configuration file. Needed for
- multi-platform builds
+Debian GNU/Linux
+================
- All options are documented in the `configure' help The option
-*-enable-optimise* is recommended for Real Life usage.
+ A Debian package is also available. You may install it easily by
+using apt-get as root:
- If you do
+ apt-get install lilypond1.3
+ Alternatively, visit
- make all
+ * http://packages.debian.org/lilypond
+ (http://packages.debian.org/lilypond)
- everything will be compiled, but nothing will be installed. The
-resulting binaries can be found in the subdirectories `out/' (which
-contain all files generated during compilation).
+ * 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;
-CONFIGURING FOR MULTIPLE PLATFORMS
-==================================
+ * 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.
- If you want to compile LilyPond with different configuration
-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,
+ 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:
- ./configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
+ $ 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
+ $
- and for the profiling version, I specify a different configuration.
+ 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
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
+ * libguile<your-libguile-version-here>-dev
-INSTALLING
-==========
+ * make, m4, flex, bison
- If you have done a successful `make', then a simple
+ * gettext
+ * groff, texinfo, bibtex2html (not in 2.2r2)
- make install
+ * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
- should do the trick.
+ * dpkg-dev, debhelper, fakeroot
- If you are doing an upgrade, please remember to remove obsolete
-`.pk' and `.tfm' files of the fonts. A script has been provided to do
-the work for you, see `bin/clean-fonts.sh'.
+ * gs, netpbm, pnmtopng
-CAVEATS
-=======
+ 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.
- * The -O2 option triggers bugs on various platforms (PowerPC,
- Alpha). If you experience problems, you should first try
- turning off this.
+ For Debian 2.2 (or 2.2r2, 2.2r3):
- * On PPC you need at least EGCS-1.1.2f.
+ 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
-REDHAT LINUX
-============
+ For Debian in development ("unstable", the future 2.3 or 3.0):
- RedHat Linux users can compile an RPM. A spec file is in
-`make/out/lilypond.spec', it is distributed along with the sources.
+ 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
- You can make the rpm by issuing
+ 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:
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+ dpkg --purge lilypond lilypond1.3
- Precompiled i386 RedHat RPMS are available from
-<ftp://freshmeat.net/pub/rpms/lilypond/> and
-<http://linux.umbc.edu/software/lilypond/rpms/>.
+Problems
+========
- For compilation on a RedHat system you need these packages, in
-addition to the thoes needed for running:
- * glibc-devel
+ 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>.
- * libstdc++-devel
+ Bugs that are not fault of LilyPond are documented here.
- * guile-devel
+NetBSD
+******
- * flex
+ * The flex precompiled in NetBSD-1.4.2 is broken. Download
+ flex-2.5.4a, build, install.
- * bison
+ * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
+ release)) does not include `/usr/pkg' paths. Configure using:
-DEBIAN GNU/LINUX
-================
+ CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
- A Debian package is also available; contact Anthony Fok
-<foka@debian.org>. The build scripts are in the subdirectory `debian/'.
-WINDOWS NT/95
-=============
+Solaris:
+********
- Separate instructions on building for W32 are available
-<../../outdir/README-W32.html>.
+ * Sparc64/Solaris 2.6, GNU make-3.77
-BUGS
-====
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
+
+ * Sparc64/Solaris 2.6, ld
+
+ Not yet resolved.
- 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.
+AIX
+***
-AUTHORS
-=======
+ * 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!