- INSTALL - compiling and installing GNU LilyPond
- HWN & JCN
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
-Contents
+Obtaining
+=========
- 1: ABSTRACT
-2: OBTAINING
-3: PREREQUISITES
-4: RUNNING
-5: WEBSITE
-6: CONFIGURING and COMPILING
-7: CONFIGURING FOR MULTIPLE PLATFORMS
-8: INSTALLING
-9: REDHAT LINUX
-10: DEBIAN GNU/LINUX
-11: WINDOWS NT/95
-12: AUTHORS
+ 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/).
-1: ABSTRACT
+ There are three options for downloading sources.
-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.
+ * if you don't have any version, then you can download the entire
+ `.tar.gz' file.
-2: OBTAINING
+ * if you have an unpacked source tree of a previous version, you
+ may use the diffs .
-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 upgrade by patching do remember to rerun autoconf after
+ applying the patch_.
-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.
-3: PREREQUISITES
+ 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
+==================
-o 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 Jan's windows page
+(http://appel.lilypond.org/lilypond/gnu-windows/).
-o 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 11.
+ * 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/).
-o EGCS 1.1 or newer.
+ * Python 1.5, Check out the python website (http://www.python.org).
-o 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.
-o GUILE 1.3, check out http://www.gnu.org/soft-
- ware/guile/guile.html.
+ * GNU Make. Check out the GNU make FTP directory
+ (ftp://ftp.gnu.org/gnu/make/).
-o GNU make. Check out ftp://ftp.gnu.org.
+ * Flex (version 2.5.4a or newer). Check out the Flex webpage
+ (http://www.gnu.org/software/flex/).
-o Flex (version 2.5.4 or newer). Check out
- ftp://ftp.gnu.org.
+ * Bison (version 1.25 or newer). Check out the bison webpage
+ (http://www.gnu.org/software/bison/)
-o Bison (version 1.25 or newer). Check out
- ftp://ftp.gnu.org.
+ * TeX.
-o Yodl. All documentation will be in Yodl. (1.30.17)
- ftp://ftp.lilypond.org/pub/yodl
+ 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.
-o 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/).
-4: RUNNING
+ * 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.
-GNU LilyPond does use a lot of resources. For operation you
-need the following software
+ * 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.
-o TeX
+ If you don't have MetaPost and don't want to use PostScript
+ output, then edit `mf/GNUmakefile', removing the line saying
+ `PFA_FILES='.
-o A PostScript printer and/or viewer (such as
- Ghostscript) is strongly recommended. Xdvi will show
- all embedded PostScript too if you have Ghostscript
- installed.
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX.
-o GUILE 1.3, check out http://www.gnu.org/pro-
- grams/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:
+Running requirements
+====================
- export MFINPUTS="/usr/local/share/lilypond/mf:"
- export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
+ GNU LilyPond does use a lot of resources. For operation you need the
+following software
-The empty path component represents and MetaFont's default
+ * TeX.
-search paths. Scripts with the proper paths for the bourne
-and C-shell respectively are generated in build-
-scripts/out/lilypond-profile and buildscripts/out/lilypond-
-login during compilation.
+ * Xdvi and ghostscript
-LilyPond is a hideously slow program. A fast CPU and plenty
-of RAM is recommended for comfortable use.
+ * GUILE 1.3.4, or newer. Check out the GUILE webpage
+ (http://www.gnu.org/software/guile.html)
-5: WEBSITE
+ 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. Appropriate
+Csh and bourne sh scripts are left in
+`buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' after compilation.
-If you want to auto-generate Lily's website, you'll need
-some additional conversion tools.
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
-o xpmtoppm (from 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/con-
- trib/utilities/netpbm-1mar1994.p1.tar.gz
+Website requirements
+====================
-o pnmtopng, which is also in libgr-progs for RedHat. The
- original is at
- ftp://swrinde.nde.swri.edu/pub/png/applications/pnm-
- topng-2.37.2.tar.gz.i
+ 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 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. 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.
+ make web-doc
- tar xzf libgr-2.0.13.tar.gz
- make
- cd png
- rm libpng.so*
- make pnmtopng
+ Building the website requires some additional tools:
- You can then install the new pnmtopng into
- /usr/local/bin/
+ * 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)
-o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
- Which, in turn depends on man2html for proper
+ * pnmtopng. The original is at in the pnmtopng FTP site
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
- installation. man2html can be had from http://askdon-
- ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
- ing/WWW/Man2html-1.05.
+ * 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).
- The website will build without this utility, but you
- will not see our hypertextified bibliography.
+ The website will build without bib converter utility, but you will
+ not see our hypertextified bibliography.
- TeTeX users should not forget to rerun texhash.
-You also have to install buildscripts/out/ps-to-gifs in a
-directory that is in the path.
+Configuring and compiling
+=========================
-6: CONFIGURING and COMPILING
+ 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
-to install GNU LilyPond, simply type:
+ 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'.
- gunzip -c lilypond-x.y.z | tar xf -
- cd lilypond-x.y.z
- ./configure # fill in your standard prefix with --prefix
- make
- make install
+ If you are not root, you should choose a `--prefix' argument that
+points into your home directory, eg.
-This will install a number of files, something close to:
+ ./configure --prefix=$HOME/usr
- /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
+ 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.
-The above assumes that you are root and have the GNU devel-
-opment tools, and your make is GNU make. If this is not the
-case, you can adjust your environment variables to your
+Configuring for multiple platforms
+==================================
-taste:
+ 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,
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- ./configure
+ ./configure --prefix=~ --enable-checking
+ make
+ make install
-CPPFLAGS are the preprocessor flags.
+ and for the profiling version, I specify a different configuration.
-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
- ./configure --prefix=$HOME/usr
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
-In this case, you will have to set up MFINPUTS, and TEXIN-
-PUTS accordingly.
+Emacs mode
+==========
-Since GNU LilyPond currently is beta, you are advised to
-also use
+ 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.
- --enable-debugging
- --enable-checking
+ 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)))
-Options to configure include:
+ If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
+is automatically loaded, so you need not modify your `~/.emacs' file.
---enable-printing
- Enable debugging print routines (lilypond -D option)
+Red Hat Linux
+=============
---enable-optimise
- Set maximum optimisation: compile with -O2. This can
- be unreliable on some compiler/platform combinations
- (eg, DEC Alpha and PPC)
+ Red Hat 7.0 i386 RPMS are available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
---enable-profiling
- Compile with support for profiling.
+ 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
---enable-config
- Output to a different configuration file. Needed for
- multi-platform builds
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
-All options are documented in the configure help The option
---enable-optimise is recommended for Real Life usage.
+ For running on a Red Hat system you need these packages: guile,
+tetex, tetex-dvips, libstdc++, python, ghostscript.
-If you do
+ 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.
- make all
+SuSE
+====
-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).
+ [TODO: document this]
-7: CONFIGURING FOR MULTIPLE PLATFORMS
+ Install `tetex', `te_mpost', `te_kpath'.
-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 profil-
-ing. Then I'd use the following for the normal build,
+Mandrake
+========
- ./configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
+ [TODO]
+
+Debian GNU/Linux
+================
+
+ 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)
-and for the profiling version, I specify a different config-
-uration.
+ * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
- ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make config=optprof
- make config=optprof install
+ * dpkg-dev, debhelper, fakeroot
-8: INSTALLING
+ * gs, netpbm, pnmtopng
-If you have done a successful make, then a simple
+ 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.
- make install
+ For Debian 2.2 (or 2.2r2, 2.2r3):
-should do the trick.
+ 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
-If you are doing an upgrade, please remember to remove obso-
-lete .pk and .tfm files of the fonts. A script has been
-provided to do the work for you, see bin/clean-fonts.sh.
+ For Debian in development ("unstable", the future 2.3 or 3.0):
-CAVEATS
+ 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
-o The -O2 option triggers bugs on various platforms
- (PowerPC, Alpha). If you experience problems, you
- should first try turning off this.
+ 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:
-o On PPC you need at least EGCS-1.1.2f.
+ dpkg --purge lilypond lilypond1.3
-EXAMPLE
+Problems
+========
-This is what I type in my xterm:
+ 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>.
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+ Bugs that are not fault of LilyPond are documented here.
-This is what the output looks like over here:
+NetBSD
+******
- GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
- Parsing ... [/home/hw/share/lilypond/init//
- <..etc..>
- init//performer.ly]]][input/kortjakje.ly]
- Creating elements ...[8][16][24][25]
- Preprocessing elements...
- Calculating column positions ... [14][25]
- Postprocessing elements...
- TeX output to someinput.tex ...
- Creating MIDI elements ...MIDI output to someinput.midi ...
+ * The flex precompiled in NetBSD-1.4.2 is broken. Download
+ flex-2.5.4a, build, install.
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
+ * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
+ release)) does not include `/usr/pkg' paths. Configure using:
-Check out the input files, some of them have comments Please
-refer to the man page for more information.
+ CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
-9: REDHAT LINUX
-RedHat Linux users can compile an RPM. A spec file is in
-make/out/lilypond.spec, it is distributed along with the
-sources.
+Solaris:
+********
-You can make the rpm by issuing
+ * Sparc64/Solaris 2.6, GNU make-3.77
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
-Precompiled i386 RedHat RPMS are available from
-http://linux.umbc.edu/software/lilypond/rpms/.
+ * Sparc64/Solaris 2.6, ld
-10: DEBIAN GNU/LINUX
+ Not yet resolved.
-A Debian package is also available; contact Anthony Fok
-foka@debian.org. The build scripts are in the subdirectory
-debian/.
+AIX
+***
-11: WINDOWS NT/95
+ * AIX 4.3 ld
-Separate instructions on building for W32 are avaible in the
-file README-W32.yo.
+ 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.
-12: AUTHORS
+ 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.
-Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
-Jan Nieuwenhuizen <janneke@gnu.org>
-Have fun!
projects / lilypond.git / blobdiff