-TITLE INFORMATION: INSTALL - compiling and installing GNU LilyPond
-AUTHOR INFORMATION: HWN & JCN
-Contents
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
-1: ABSTRACT
-2: PREREQUISITES
-3: RUNNING
-4: RECOMMENDED
-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
+Obtaining
+=========
-1: ABSTRACT
+ 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/).
-You do something which looks remotely like
+ There are three options for downloading sources.
- configure # Check out the buildscripts/set-lily.sh script
- make
- make install
+ * if you don't have any version, then you can download the entire
+ `.tar.gz' file.
-The detailed instructions follow here. The
-buildscripts/set-lily.sh script sets some environment variables
-and symlinks, which comes in handly when you have to compile LilyPond
-very often. It is aimed at people who run (or debug) LilyPond without
-installing.
+ * if you have an unpacked source tree of a previous version, you
+ may use the diffs .
-2: PREREQUISITES
+ _If you upgrade by patching do remember to rerun autoconf after
+ applying the patch_.
-For compilation you need:
+ * 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.
-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.
+ 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
-o Lots of disk space: LilyPond takes between 50 and 100 mb to
-compile if you use debugging information. If you are short on
-disk-space run configure with --disable-debugging.
+Build requirements
+==================
-Although we recommend to use Unix, LilyPond is known to run on Windows
-NT/95/98 as well. See Section [w32].
+ 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 GNU C++ version 2.7 or newer (2.8 and egcs are also fine).
-o Python 1.5 (Strictly speaking, you shouldn't need Python for
- compiling and installing, but you'll need it to regenerate the font
- tables, e.g.).
+ You need the following packages to compile Lilypond.
-3: RUNNING
+ * 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/).
-GNU LilyPond does use a lot of resources. For operation you need the following:
+ * Python 1.5, Check out the python website (http://www.python.org).
-o TeX
-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.
+ * 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.
-4: RECOMMENDED
+ * GNU Make. Check out the GNU make FTP directory
+ (ftp://ftp.gnu.org/gnu/make/).
-Although not strictly necessary, these are recommended to have.
+ * Flex (version 2.5.4a or newer). Check out the Flex webpage
+ (http://www.gnu.org/software/flex/).
-o GNU make.
-Check out ftp://ftp.gnu.org
-or any mirror of this site.
+ * Bison (version 1.25 or newer). Check out the bison webpage
+ (http://www.gnu.org/software/bison/)
-o Flex (version 2.5.4 or newer).
-Check out ftp://ftp.gnu.org
-or any mirror of this site.
-o Bison (version 1.25 or newer).
-Check out ftp://ftp.gnu.org
-or any mirror of this site.
+ * TeX.
-o Python (version 1.5 or newer). Check out
-ftp://ftp.python.org or ftp://ftp.cwi.nl/pub/python.
+ 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 Yodl. All documentation will be in Yodl. (1.30.17)
-ftp://pcnov095.win.tue.nl/pub/yodl
- http://www.cs.uu.nl/~hanwen/yodl
-o Texinfo. (version 3.12 or newer)
+ * 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/).
-o GNU find
-Check out ftp://ftp.gnu.org
-or any mirror of this site
+ * 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.
-o A fast computer (a full page of music typically takes 1 minute on my
- 486/133, using the --enable-checking compile. It's lot slower than
- most MusiXTeX preprocessors)
+ * 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.
-5: WEBSITE
+ If you don't have MetaPost and don't want to use PostScript
+ output, then edit `mf/GNUmakefile', removing the line saying
+ `PFA_FILES='.
-If you want to auto-generate Lily's website, you'll need some additional
-conversion tools.
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX.
-o xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
- users: it is included within the package libgr-progs).
-o 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.
- TeTeX users should not forget to rerun texhash.
+Running requirements
+====================
-6: CONFIGURING and COMPILING
+ GNU LilyPond does use a lot of resources. For operation you need the
+following software
-to install GNU LilyPond, simply type:
+ * TeX.
- configure --enable-tex-dir=XXXX --enable-mf-dir=YYYY
- make
- make install
+ * Xdvi and ghostscript
-This will install a number of files, something close to:
+ * GUILE 1.3.4, or newer. Check out the GUILE webpage
+ (http://www.gnu.org/software/guile.html)
- /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
- /usr/lib/texmf/texmf/tex/lilypond/*
+ 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.
-You should specify directories that are in TeX's and MetaFont's
-include path with the options (--enable-tex-dir) and
---enable-mf-dir. If you don't specify any directories, the TeX
-include directory is detected dynamically, which is unreliable. 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:
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- configure
+Website requirements
+====================
-CPPFLAGS are the preprocessor flags.
+ 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 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
+ make web-doc
- configure --prefix=$HOME/usr
+ Building the website requires some additional tools:
-In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
+ * 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)
-If you want to install GNU LilyPond in /usr/local, and your TeX has
-no default hooks for local stuff, you can do:
+ * pnmtopng. The original is at in the pnmtopng FTP site
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
- configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
+ * 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).
-Since GNU LilyPond currently is beta, you are advised to also use
+ The website will build without bib converter utility, but you will
+ not see our hypertextified bibliography.
- --enable-debugging
- --enable-checking
-Other options include:
+Configuring and compiling
+=========================
-o --enable-shared
- Make a shared library (gnu/linux, solaris (?) only ) (TEMPORARILY
-OUT OF ORDER)
+ 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
-o --enable-printing
- Enable debugging print routines (lilypond -D option)
-o --enable-optimise
- Set maximum optimisation: compile with -O2
-o --enable-profiling
- Compile with support for profiling.
-o --enable-tex-prefix
- Set the directory where TeX and Metafont live.
-o --enable-tex-dir
- Set then directory TeX input is in (detected as a subdir of
- tex-prefix). This should be a directory that is reachable both for
- tex and latex. On my system the best choice would be
- /usr/lib/texmf/texmf/tex/generic//.
-o --enable-mf-dir
- Set the directory metafont input is in (idem). On my system the best
- choice would be /usr/lib/texmf/texmf/fonts/source/public/.
-o --enable-config
- Output to a different configuration file. Needed for multi-platform
- builds
+ 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'.
-All options are documented in the configure help
-The option --enable-optimise is recommended for Real Life usage.
+ If you are not root, you should choose a `--prefix' argument that
+points into your home directory, eg.
-If you do
+ ./configure --prefix=$HOME/usr
- make all
+ 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.
-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).
+Configuring for multiple platforms
+==================================
-7: CONFIGURING FOR MULTIPLE PLATFORMS
+ 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,
-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,
+ ./configure --prefix=~ --enable-checking
+ make
+ make install
- configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
+ and for the profiling version, I specify a different configuration.
-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 --disable-checking
+ make conf=prof
+ make conf=prof install
-8: INSTALLING
+Emacs mode
+==========
-If you have done a successful make, then a simple
+ 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.
- make install
+ 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)))
-should do the trick.
+ If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
+is automatically loaded, so you need not modify your `~/.emacs' file.
-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.
+Red Hat Linux
+=============
-CAVEATS
+ Red Hat 7.0 i386 RPMS are available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
-o The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You
- should turn off this flag for this file.
+ 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
-EXAMPLE
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
-This is what I type in my xterm:
+ For running on a Red Hat system you need these packages: guile,
+tetex, tetex-dvips, libstdc++, python, ghostscript.
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+ 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.
-This is what the output looks like over here:
+SuSE
+====
- 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 ...
+ [TODO: document this]
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
+ Install `tetex', `te_mpost', `te_kpath'.
-Check out the input files, some of them have comments
-Please refer to the man page for more information.
+Mandrake
+========
-9: REDHAT LINUX
+ [TODO]
-RedHat Linux users can compile an RPM. A spec file is in
-make/out/lilypond.spec. You should install a gif file called
-lelie_icon.gif along with the sources. You can generate this
-gif file by typing
+Debian GNU/Linux
+================
- make gifs
+ A Debian package is also available. You may install it easily by
+using apt-get as root:
-in the directory Documentation.
+ apt-get install lilypond1.3
-You can make the rpm by issuing
+ Alternatively, visit
- make rpm
+ * http://packages.debian.org/lilypond
+ (http://packages.debian.org/lilypond)
-10: DEBIAN GNU/LINUX
+ * 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;
-A Debian package is also available; contact Anthony Fok
-<foka@debian.org>. The build scripts are in the subdirectory debian/
+ * 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.
-11: WINDOWS NT/95
+ You may contact Anthony Fok <foka@debian.org> for more information.
-Separate instructions on building for W32 are avaible
-in the file README-W32.yo.
+ The build scripts are in the subdirectory `debian/'; you can make
+the .deb by doing, for example:
-12: AUTHORS
+ $ 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
+ $
-Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ 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)
+
+ * 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
+
+Problems
+========
+
+ 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>.
+
+ Bugs that are not fault of LilyPond are documented here.
+
+NetBSD
+******
+
+ * The flex precompiled in NetBSD-1.4.2 is broken. Download
+ flex-2.5.4a, build, install.
+
+ * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
+ release)) does not include `/usr/pkg' paths. Configure using:
+
+ CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+
+
+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
+
+ 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.
+
+ 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.
+
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
-Jan Nieuwenhuizen <janneke@gnu.org>
-Have fun!
projects / lilypond.git / blobdiff