3 @comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
4 @setfilename INSTALL.info
5 @settitle INSTALL - compiling and installing GNU LilyPond
8 <!--- @@WEB-TITLE@@=Installation Instructions --->
13 @chapter INSTALL - compiling and installing GNU LilyPond
16 This document describes how to build LilyPond on Unix platforms. It
17 is also known to run and compile on Windows NT/95/98/ME/XP as well.
18 More information on this topic can be found at the
19 @uref{http://www.lilypond.org/cygwin/, LilyPond on Windows page}.
23 <a name="download-source">
28 Even numbered versions are `stable'. The webpages for the stable version
29 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
30 servers}. Big enhancements go into the latest odd numbered version
31 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
34 Building LilyPond is an involved process. We advise to use binary
35 packages if these are available for your platform.
37 @subsection Source code
39 If you want to compile LilyPond from source, download here:
41 @item Download development releases from
42 @c Hmm, these won't show up in lilypond.org/stats
43 @c Otoh, lilypond.org is not updated when release mail arrives
44 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/} by FTP and
45 @uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP.
46 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
47 @item at @code{lilypond.org}
48 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
49 @uref{http://www.lilypond.org/ftp/} by HTTP.
53 For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
54 tarball; see instructions below.
56 Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
57 FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
60 The latest development version is also available through anonymous
61 CVS. See @uref{http://savannah.gnu.org/cvs/?group=lilypond}.
63 CVS does not contain generated files. To create @file{configure}, run
71 <a name="download-binaries">
76 @subsection Precompiled binaries
78 If you want to track bleeding edge development, try:
81 @item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian
82 GNU/Linux} usually has the latest binaries for the most useful stable
83 and development versions, while
84 @item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/,
85 Mandrake Cooker} also provides fairly recent versions.
88 Binaries are made available for other popular platforms, but as we need
89 to compile them ourselves, they are not updated for every version
93 @item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat-7.x/, Red Hat i386}
94 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
95 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
98 @uref{http://www.lilypond.org/gnu-windows/, Windows}
101 @subsection Upgrading
103 There are two options for upgrading sources.
106 @item if you have an unpacked source tree of a previous version, you
109 @emph{If you upgrade by patching do remember to rerun autoconf after
112 @item if you have the @code{.tar.gz} file of a previous release, you can
114 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
115 This is much safer than using patches, and is the recommended way.
117 The following command produces @file{lilypond-1.4.3.tar.gz} from
118 @file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
121 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
125 @subsection Font problems.
127 If you are upgrading from a previous version of LilyPond, be sure to
128 remove all old font files. These include @file{.pk} and @file{.tfm} files
129 that may be located in @file{/var/lib/texmf}, @file{/var/spool/texmf},
130 @file{/var/tmp/texmf} or @file{@var{prefix}/share/lilypond/fonts/}. A
131 script automating this has been included, see
132 @file{buildscripts/clean-fonts.sh}.
137 @section Requirements
139 @subsection Compilation
141 You need the following packages to compile Lilypond.
144 @item The GNU c++ compiler (version 2.95.2 or newer).
145 EGCS 1.1 may work, but is no longer supported.
146 Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
148 WARNING: if you choose to upgrade to GCC 3.x, enquire if your
149 distribution supports g++ 3.x and flex. At the time of writing (Fri
150 Jul 5 2002), @strong{no} distribution that we know of ships a flex
151 that generates gcc-3.1.x compliant C++ code.
153 @item Python (version 1.5 or newer).
154 Check out @uref{http://www.python.org, the python website}.
156 @item GUILE (version 1.4 or newer).
158 @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
162 @uref{ftp://ftp.gnu.org/gnu/make/, the GNU
165 @item Flex (version 2.5.4a or newer).
166 Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
168 WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
169 chokes on this. If you wish to use GCC 3.x, make sure that your
170 distribution supports g++ 3.x and flex. For workarounds, see
171 lexer-gcc-3.0.patch and lexer-gcc-3.1.sh in the source directory.
173 @item Bison (version 1.25 or newer).
174 Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
178 @TeX{} is used as an output backend.
180 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf},
181 @file{.afm}, @file{.tfm}). Make sure you have tetex 1.0 or newer
182 (1.0.6 is known to work). You may need to install a tetex-devel (or
183 tetex-dev or libkpathsea-dev) package too.
185 @item Texinfo (version 4.2 or newer).
186 The documentation of lily is written in texinfo. Check out
187 @uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
189 @item The geometry package for LaTeX is needed to use ly2dvi.
191 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
192 FTP directory for @code{geometry}}. This package is normally included
193 with the @TeX{} distribution.
195 @item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
196 usually included with your installation of @TeX{}. You may need to
197 install a tetex-devel or tetex-dev package too. If kpathsea is not
198 installed in a directory where the compiler normally looks, read the
199 hints for Slackware below.
201 In the very unlikely case that kpathsea is not available for your
202 platform (ie, you're not running GNU/Linux, Windows, or any recent
203 UNIX), you can compile LilyPond without kpathsea support. In that case,
204 you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
205 configure something like:
209 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
215 @subsection Running requirements
217 GNU LilyPond does use a lot of resources. For operation you need the
222 @item Xdvi and Ghostscript
223 @item GUILE 1.4, or newer.
225 @uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
228 For running LilyPond successfully you have to help @TeX{} and MetaFont find
229 various files. The recommended way of doing so is adjusting the
230 environment variables in the start-up scripts of your shell. Appropriate
231 Csh and bourne sh scripts are left in
232 @file{buildscripts/out/lilypond-profile} and
233 @file{buildscripts/out/lilypond-login} after compilation.
235 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
236 recommended for comfortable use.
238 @subsection Building documentation
240 You can view the documentation online at
241 @uref{http://www.lilypond.org/stable/Documentation/out-www/}, but you
242 can also build it locally. This process requires a successful compile of
243 lilypond. The documentation is built by issuing
250 Building the website requires some additional tools:
253 @item The netpbm utilities, see @uref{http://netpbm.sourceforge.net/}
254 @item mftrace 1.0 or newer, needed for generating PostScript Type1
255 fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/mftrace/}. You
256 will need to install some additional packages to get mftrace to work.
259 @section Building LilyPond
261 to install GNU LilyPond, type:
263 gunzip -c lilypond-x.y.z | tar xf -
265 ./configure # run with --help to see appropriate options
268 sh buildscripts/clean-fonts.sh
271 If you are doing an upgrade, you should remove all @file{feta}
272 @code{.pk} and @file{.tfm} files. A script has been provided to do the
273 work for you, see @file{buildscripts/clean-fonts.sh}.
276 If you are not root, you should choose a @code{--prefix} argument that
277 points into your home directory, eg.
280 ./configure --prefix=$HOME/usr
284 In this case, you have to insert the contents of
285 @code{buildscripts/out/lilypond-login} or
286 @code{buildscripts/out/lilypond-profile} into your start up scripts by
291 @subsection Configuring for multiple platforms
293 If you want to build multiple versions of LilyPond with different
294 configuration settings, you can use the @code{--enable-config=CONF}
295 option of configure. You should use @samp{make conf=CONF} to generate
296 the output in @file{out-CONF}. Example: suppose I want to build with
297 and without profiling. Then I'd use the following for the normal
302 ./configure --prefix=$HOME/usr/ --enable-checking
307 and for the profiling version, I specify a different configuration.
311 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
313 make conf=prof install
323 An Emacs mode for entering music and running LilyPond is contained in
324 the source archive as @file{lilypond-mode.el},
325 @file{lilypond-indent.el} and @file{lilypond-font-lock.el}.
326 You should install these files to a directory included in your
327 @var{load-path}. As a user, you may want add your source path or
328 @file{~/site-lisp/} to your @var{load-path}. Append the following line
329 (modified) to your @file{~/.emacs} or @file{~/.emacs.el}:
332 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
335 File @file{lilypond-init.el} should be placed to
336 @var{load-path}@file{/site-start.d/} or appended to your @file{~/.emacs}.
337 If you have installed a precompiled LilyPond package, these files can be
338 found in @file{/usr/share/doc/lilypond-x.y.z/}.
340 If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
341 automatically loaded, you not even need to modify your @code{~/.emacs}
346 A Vim mode for entering music and running LilyPond is contained in
347 the source archive. Append the content of @file{vimrc} to @file{~/.vimrc}
348 to get shortcuts. Install files @file{lilypond.vim} and @file{lilypond.words}
349 to @file{~/.vim/} to get syntax-highlighting and auto-completion,
353 @section Compiling for distributions
355 @subsection Red Hat Linux
357 Red Hat 7.x i386 RPMS are available from
358 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. For running on
359 a Red Hat system you need these packages: guile, tetex, tetex-latex,
360 tetex-dvips, libstdc++, python, ghostscript.
362 You can also compile them yourself. A spec file is in
363 @file{make/out/lilypond.redhat.spec}. This file is distributed along
364 with the sources. You can make the rpm by issuing
367 cp lilypond-x.y.z.tar.gz /usr/src/redhat/SOURCES/
368 tar xfz lilypond-x.y.z.tar.gz
369 rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
370 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
374 For compilation on a Red Hat system you need these packages, in
375 addition to the those needed for running: glibc-devel, gcc-c++,
376 libstdc++-devel, guile-devel, flex, bison, texinfo, groff, mftrace,
377 netpbm-progs, autotrace, t1utils.
384 Some LinuxPPC RPMS should available from
385 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
387 A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
391 Some SUSE RPMS should available from
392 @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}.
394 You can also compile a RPM for SUSE yourself. A spec file is in
395 @file{make/out/lilypond.suse.spec}, see the instructions for building
398 You must have the following packages: guile tcsh tetex te_latex te_kpath
399 te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
400 gs_serv gs_lib gs_fonts guile
402 @subsection Slackware
404 No precompiled packages for Slackware are available.
406 Problems have been reported with Slackware 7.0; apparently, it ships
407 with a faulty compiler. Do not compile LilyPond with -O2 on this
410 At least on Slackware 8.0, you have to manually specify the paths to the
411 Kpathsea library, see the section on kpathsea
416 Some binaries are available at rpmfind.net. Refer to
417 @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}.
419 You can also compile a RPM for Mandrake yourself. A spec file is in
420 @file{make/out/lilypond.mandrake.spec}, see the instructions for building
423 @subsection Debian GNU/Linux
425 A Debian package is also available. You may install it easily by running
426 @command{apt-get} as root:
429 apt-get install lilypond lilypond-doc
432 You can also compile the .deb for Debian yourself, do:
435 apt-get -b source lilypond
438 If you're real impatient, you may even do:
441 cd lilypond-x.y.z # a previous version
442 uscan # download and build latest directly from upstream
446 Debian's @TeX{} installation is a bit short on memory, you may want to
447 increase it like this:
449 --- texmf.cnf.orig Sun Dec 16 23:47:07 2001
450 +++ texmf.cnf Sun Dec 16 23:46:34 2001
452 main_memory.context = 1500000
453 main_memory.mpost = 1000000
454 main_memory = 263000 % words of inimemory available; also applies to inimf&mp
455 -extra_mem_top = 0 % extra high memory for chars, tokens, etc.
456 -extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
457 +extra_mem_top = 1000000 % extra high memory for chars, tokens, etc.
458 +extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
460 obj_tab_size.context = 300000
463 % Max number of characters in all strings, including all error messages,
464 % help texts, font names, control sequences. These values apply to TeX and MP.
465 pool_size.context = 750000
468 % Minimum pool space after TeX/MP's own strings; must be at least
469 % 25000 less than pool_size, but doesn't need to be nearly that large.
470 string_vacancies.context = 45000
473 You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
474 environment variables if you do not want to or cannot modify
475 @file{/etc/texmf/texmf.cnf}.
480 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
481 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
482 for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
483 The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
484 Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
485 package is now obsolete.
488 Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
491 The build scripts are in the subdirectory @file{debian/}; you can
492 make the .deb by doing, for example:
496 # dpkg --purge lilypond lilypond1.3
498 $ tar xzf lilypond-1.4.3.tar.gz
500 $ dch -p -v 1.4.3-0.local.1 "Local build."
503 # dpkg -i ../lilypond_1.4.3*.deb
508 Use command @command{debuild} instead of @command{debuild -B} if you have
509 a very fast machine and want to build the HTML, PS and DVI documentation
512 For compilation on a Debian GNU/Linux system you need these packages,
513 in addition to the those needed for running:
516 @item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
517 @item libguile<@var{your-libguile-version-here}>-dev
518 @item make, m4, flex, bison
521 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
522 @item dpkg-dev, debhelper, fakeroot
524 @item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
525 in Debian testing/unstable.)
528 Most of these are listed on the @samp{Build-Depends} line in the
529 @file{debian/control} file. To ensure the creation of the lilypond deb is
530 trouble-free, we recommend that you first install the following packages
531 by running \@command{apt-get} as root before building the package:
536 apt-get install task-debian-devel task-c++-dev \
537 python-base libguile6-dev tetex-bin tetex-dev \
538 tetex-extra flex bison texinfo groff gs \
539 netpbm pnmtopng m4 gettext
542 For Debian in development ("unstable", the future 2.3 or 3.0):
545 apt-get install binutils cpp gcc libc6-dev \
546 g++ libstdc++2.10-dev \
547 python-base libguile-dev tetex-bin libkpathsea-dev \
548 tetex-extra flex bison texinfo groff gs \
552 And, just so that old fonts from previous versions of LilyPond won't
553 interfere with your build, you may want to do this before the build too:
556 dpkg --purge lilypond lilypond1.3
561 LilyPond is available through fink, in the unstable cvs distribution.
565 @item Get the Fink package manager from @uref{http://fink.sourceforge.net}
566 @item Get the Lilypond package description by enabling the "unstable" tree
567 in fink and executing @command{fink selfupdate-cvs}.
573 fink install lilypond-unstable
577 That's it! The command should compile and install all LilyPond
578 prerequisites (python, TeX, X11, ghostscript) and then LilyPond
582 @subsection compiling on MacOS X
583 LilyPond has been built on Darwin, to be precise, on:
585 Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
586 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc
592 Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
595 To make sure you have all packages needed to build LilyPond installed,
599 apt-get install bash python guile debianutils flex bison texinfo \
600 ghostscript6 netpbm m4 gettext
609 For more information about @file{apt-get} and @file{fink}, see
610 @uref{http://fink.sf.net,fink.sourceforge.net}.
612 @c brokenness of autoconf; don't ask
613 Then, configure, patch, make and install LilyPond using these commands:
616 CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
617 ./configure --prefix=/sw
618 make -C lily out/parser.hh out/parser.cc out/config.h
619 patch -p0 < darwin.patch
620 make -C lily out/parser.o
621 make DEPENDENCIES_OUTPUT=/dev/null all
625 For installing, you must be root, of course.
627 @c Why isn't this in BUGS (where it belongs?)
630 For help and questions use @email{lilypond-user@@gnu.org}. Please
631 consult the FAQ before mailing your problems. If you find bugs, please
632 send bug reports to @email{bug-lilypond@@gnu.org}.
634 Bugs that are not fault of LilyPond are documented here.
636 @subsection Linking to kpathsea
638 If kpathsea and the corresponding header files are installed in some
639 directory where GCC does not search by default, for example in
640 @file{/usr/local/lib/} and @file{/usr/local/include/} respectively,
641 you have to explicitly tell configure where to find it. To do this,
644 @item @code{rm config.cache}
645 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
646 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
647 @item @code{./configure}
649 Once configure has found them, the paths are stored in
650 @file{config.make} and will be used even if you don't have the
651 environment variables set during make.
654 @unnumberedsubsec Gcc-3.0.4
656 Gcc 3.0.4, is a bit flaky. Try downgrading to 2.95.x, or if you're
657 adventurous (see below), upgrading to 3.1.x.
659 @unnumberedsubsec Flex-2.5.4a and gcc-3.x
661 Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
662 LilyPond with gcc-3.0 you may do:
665 CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
666 make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
667 patch -p1 < lexer-gcc-3.0.patch
668 make conf=gcc-3.0 -C lily
671 Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
673 @unnumberedsubsec Flex-2.5.4a and gcc-3.1.x
675 Flex 2.5.4a does not produce g++-3.1.1 compliant C++ code. To compile
676 LilyPond with gcc-3.1.1 you may do:
679 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
680 CPPFLAGS=-I$(pwd)/lily/out-gcc-3.1 CC=gcc-3.1 CXX=g++-3.1 \
681 ./configure --enable-config=gcc-3.1
682 CONF=gcc-3.1 ./lexer-gcc-3.1.sh
686 This assumes that the GCC 3.1 binaries are called gcc-3.1 and g++-3.1.
687 Note that this is @strong{not} fixed in Debian/unstable for flex <=
690 @unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
692 There's a bug in certain kernels around version 2.4.0, that is
693 triggered when using Guile 1.4 compiled with pthreads. You'll see
694 random segmentation fault crashes of LilyPond. Upgrade to a newer
695 version of Linux. If you can't do that, you may try to recompiling
696 Guile without threads (YMMV):
699 guile-1.4$ ./configure --without-threads; make all install
702 @unnumberedsubsec OpenBSD
705 @item By default, gcc on OpenBSD doesn't include
706 @file{/usr/local/include} and @file{/usr/local/lib} in the system
707 paths. Depending upon where/how you installed kpathsea and other
708 libraries, you may need to refer to the section ``Linking to
713 @unnumberedsubsec NetBSD
716 @item The flex precompiled in NetBSD-1.4.2 is broken.
717 Download flex-2.5.4a, build, install.
719 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
720 release)) does not include @file{/usr/pkg} paths. Configure using:
723 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
729 @unnumberedsubsec Solaris
732 @item Solaris7, ./configure
734 @file{./configure} needs a POSIX compliant shell. On Solaris7,
735 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
736 is. Please run configure like:
738 CONFIG_SHELL=/bin/ksh ksh -c ./configure
742 CONFIG_SHELL=/bin/bash bash -c ./configure
745 @item Sparc64/Solaris 2.6, GNU make-3.77
747 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
749 @item Sparc64/Solaris 2.6, ld
755 @unnumberedsubsec AIX
760 The following is from the gcc install/SPECIFIC file.
762 Some versions of the AIX binder (linker) can fail with a relocation
763 overflow severe error when the -bbigtoc option is used to link
764 GCC-produced object files into an executable that overflows the TOC.
765 A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
766 -BBIGTOC) is available from IBM Customer Support and from its
767 27service.boulder.ibm.com website as PTF U455193.
769 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
770 as and GNU ld will not work properly and one should not configure GCC
771 to use those GNU utilities. Use the native AIX tools which do
772 interoperate with GCC.
775 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
777 LDFLAGS='-Wl,-bbigtoc' ./configure