2 @comment node-name, next, previous, up\input texinfo @c -*-texinfo-*-
3 @setfilename INSTALL.info
4 @settitle INSTALL - compiling and installing GNU LilyPond
7 <!--- @@WEB-TITLE@@=Installation Instructions --->
15 @chapter INSTALL - compiling and installing GNU LilyPond
18 This document describes how to build LilyPond on Unix platforms. It
19 is also known to run and compile on Windows NT/95/98/ME/XP as well.
20 More information on this topic can be found at the
21 @uref{http://www.lilypond.org/cygwin/, LilyPond on Windows page}.
25 <a name="download-source">
30 Even numbered versions are `stable'. The webpages for the stable version
31 (1.4) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
32 servers}. Big enhancements go into the latest odd numbered version
33 (1.5), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
36 @subsection Source code
38 If you want to compile LilyPond from source, download here:
40 @item Download development releases from
41 @c Hmm, these won't show up in lilypond.org/stats
42 @c Otoh, lilypond.org is not updated when release mail arrives
43 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/} by FTP and
44 @uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP.
45 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
46 @item at @code{lilypond.org}
47 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
48 @uref{http://www.lilypond.org/ftp/} by HTTP.
52 Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
53 FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
56 For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
57 tarball; see instructions below.
60 @subsubsection Anonymous CVS access
66 cvs -d :pserver:anoncvs@@lilypond.org:/home/lilypond login
67 cvs -d :pserver:anoncvs@@lilypond.org:/home/lilypond co -P lilypond
71 See @uref{http://lilypond.org/wiki/?CVS} for more information.
74 <a name="download-binaries">
79 @subsection Precompiled binaries
81 If you want to track bleeding edge development, try:
84 @item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian
85 GNU/Linux} usually has the latest binaries for the most useful stable
86 and development versions, while
87 @item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/,
88 Mandrake Cooker} also provides fairly recent versions.
91 Binaries are made available for other popular platforms, but as we need
92 to compile them ourselves, they are not updated for every version
96 @item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386}
97 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
98 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
101 @uref{http://www.lilypond.org/gnu-windows/, Windows}
104 @subsection Upgrading
106 There are two options for upgrading sources.
109 @item if you have an unpacked source tree of a previous version, you
112 @emph{If you upgrade by patching do remember to rerun autoconf after
115 @item if you have the @code{.tar.gz} file of a previous release, you can
117 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
118 This is much safer than using patches, and is the recommended way.
120 The following command produces @file{lilypond-1.4.3.tar.gz} from
121 @file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
124 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
128 @section Requirements
130 @subsection Compilation
132 You need the following packages to compile Lilypond.
135 @item The GNU c++ compiler (version 2.95.2 or newer).
136 EGCS 1.1 may work, but is no longer supported.
137 Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
139 WARNING: if you choose to upgrade to GCC 3.x, enquire if your
140 distribution supports g++ 3.x and flex.
142 @item Python (version 1.5 or newer).
143 Check out @uref{http://www.python.org, the python website}.
145 @item GUILE (version 1.4 or newer).
147 @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
151 @uref{ftp://ftp.gnu.org/gnu/make/, the GNU
154 @item Flex (version 2.5.4a or newer).
155 Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
157 WARNING: plain Flex 2.5.4(a) generates invalid C++ code. GCC 3.x
158 chokes on this. If you wish to use GCC 3.x, make sure that your
159 distribution supports g++ 3.x and flex. For a workaround, see
162 @item Bison (version 1.25 or newer).
163 Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
167 @TeX{} is used as an output backend.
169 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf}, @file{.afm}, @file{.tfm}).
170 Make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
171 need to install a tetex-devel or tetex-dev package too.
173 @item Texinfo (version 4.2 or newer).
174 The documentation of lily is written in texinfo. Check out
175 @uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
177 @item The geometry package for LaTeX is needed to use ly2dvi.
179 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
180 FTP directory for @code{geometry}}. This package is normally included
181 with the @TeX{} distribution.
183 @item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
184 usually included with your installation of @TeX{}. You may need to install
185 a tetex-devel or tetex-dev package too. If kpathsea is not installed in
186 a directory where the compiler normally looks, read the hints for
189 In the very unlikely case that kpathsea is not available for your
190 platform (ie, you're not running GNU/Linux, Windows, or any recent
191 UNIX), you can compile LilyPond without kpathsea support. In that case,
192 you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
193 configure something like:
197 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
203 @subsection Running requirements
205 GNU LilyPond does use a lot of resources. For operation you need the
210 @item Xdvi and Ghostscript
211 @item GUILE 1.4, or newer.
213 @uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
216 For running LilyPond successfully you have to help @TeX{} and MetaFont find
217 various files. The recommended way of doing so is adjusting the
218 environment variables in the start-up scripts of your shell. Appropriate
219 Csh and bourne sh scripts are left in
220 @file{buildscripts/out/lilypond-profile} and
221 @file{buildscripts/out/lilypond-login} after compilation.
223 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
224 recommended for comfortable use.
226 @subsection Website requirements
228 The documentation comes in the form of a website. You can view this
229 website on the internet, but you can also build it locally. This process
230 requires a successful compile of lilypond. The website is built
238 Building the website requires some additional tools:
241 @item The netpbm utilities, see @uref{http://netpbm.sourceforge.net/}
242 @item pktrace 1.0 or newer, needed for generating PostScript Type1
243 fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/pktrace/}. You
244 will need to install some additional packages to get pktrace to work.
247 @section Building LilyPond
249 to install GNU LilyPond, type:
251 gunzip -c lilypond-x.y.z | tar xf -
253 ./configure # run with --help to see appropriate options
256 sh buildscripts/clean-fonts.sh
259 If you are doing an upgrade, you should remove all @file{feta}
260 @code{.pk} and @file{.tfm} files. A script has been provided to do the
261 work for you, see @file{buildscripts/clean-fonts.sh}.
264 If you are not root, you should choose a @code{--prefix} argument that
265 points into your home directory, eg.
268 ./configure --prefix=$HOME/usr
272 In this case, you have to insert the contents of
273 @code{buildscripts/out/lilypond-login} or
274 @code{buildscripts/out/lilypond-profile} into your start up scripts by
279 @subsection Configuring for multiple platforms
281 If you want to build multiple versions of LilyPond with different
282 configuration settings, you can use the @code{--enable-config=CONF}
283 option of configure. You should use @samp{make conf=CONF} to generate
284 the output in @file{out-CONF}. Example: suppose I want to build with
285 and without profiling. Then I'd use the following for the normal
290 ./configure --prefix=~ --enable-checking
295 and for the profiling version, I specify a different configuration.
299 ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
301 make conf=prof install
311 An Emacs mode for entering music and running LilyPond is included with
312 the source archive as @file{lilypond-mode.el},
313 @file{lilypond-indent.el} and @file{lilypond-font-lock.el}. You
314 should install these files somewhere in your @var{load-path}. If you
315 have installed a precompiled LilyPond package, these files can be
316 found in @file{/usr/share/doc/lilypond-x.y.z/}.
318 Add this to your @file{~/.emacs} or @file{~/.emacs.el}, or install this
319 file in Emacs' @file{site-start.d}:
322 ;;; lilypond-init.el --- Startup code for LilyPond mode
324 (autoload 'LilyPond-mode "lilypond-mode")
325 (setq auto-mode-alist
326 (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
328 (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
332 If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
333 automatically loaded, you not even need to modify your @code{~/.emacs}
336 @section Compiling for distributions
338 @subsection Red Hat Linux
340 Red Hat 7.x i386 RPMS are available from
341 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}. For running on
342 a Red Hat system you need these packages: guile, tetex, tetex-latex,
343 tetex-dvips, libstdc++, python, ghostscript.
345 You can also compile them yourself. A spec file is in
346 @file{make/out/lilypond.redhat.spec}. This file is distributed along
347 with the sources. You can make the rpm by issuing
350 tar xfz lilypond-x.y.z.tar.gz
351 rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
352 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
356 For compilation on a Red Hat system you need these packages, in
357 addition to the those needed for running: glibc-devel, gcc-c++,
358 libstdc++-devel, guile-devel, flex, bison, texinfo, groff, pktrace,
359 netpbm-progs, autotrace, t1utils.
366 Some LinuxPPC RPMS should available from
367 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
369 A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
373 Some SUSE RPMS should available from
374 @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}.
376 You can also compile a RPM for SUSE yourself. A spec file is in
377 @file{make/out/lilypond.suse.spec}, see the instructions for building
380 You must have the following packages: guile tcsh tetex te_latex te_kpath
381 te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
382 gs_serv gs_lib gs_fonts guile
384 @subsection Slackware
386 No precompiled packages for Slackware are available.
388 Problems have been reported with Slackware 7.0; apparently, it ships
389 with a faulty compiler. Do not compile LilyPond with -O2 on this
392 At least on Slackware 8.0, you have to manually specify the paths to the
393 Kpathsea library, using
395 @item @code{rm config.cache}
396 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
397 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
398 @item @code{./configure}
404 Some binaries are available at rpmfind.net. Refer to
405 @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}.
407 You can also compile a RPM for Mandrake yourself. A spec file is in
408 @file{make/out/lilypond.mandrake.spec}, see the instructions for building
411 @subsection Debian GNU/Linux
413 A Debian package is also available. You may install it easily by running
414 @command{apt-get} as root:
417 apt-get install lilypond lilypond-doc
420 You can also compile the .deb for Debian yourself, do:
423 apt-get -b source lilypond
426 If you're real impatient, you may even do:
429 cd lilypond-x.y.z # a previous version
430 uscan # download and build latest directly from upstream
434 Debian's @TeX{} installation is a bit short on memory, you may want to
435 increase it like this:
437 --- texmf.cnf.orig Sun Dec 16 23:47:07 2001
438 +++ texmf.cnf Sun Dec 16 23:46:34 2001
440 main_memory.context = 1500000
441 main_memory.mpost = 1000000
442 main_memory = 263000 % words of inimemory available; also applies to inimf&mp
443 -extra_mem_top = 0 % extra high memory for chars, tokens, etc.
444 -extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
445 +extra_mem_top = 1000000 % extra high memory for chars, tokens, etc.
446 +extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
448 obj_tab_size.context = 300000
451 % Max number of characters in all strings, including all error messages,
452 % help texts, font names, control sequences. These values apply to TeX and MP.
453 pool_size.context = 750000
456 % Minimum pool space after TeX/MP's own strings; must be at least
457 % 25000 less than pool_size, but doesn't need to be nearly that large.
458 string_vacancies.context = 45000
461 You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
462 environment variables if you do not want to or cannot modify
463 @file{/etc/texmf/texmf.cnf}.
468 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
469 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
470 for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
471 The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
472 Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
473 package is now obsolete.
476 Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
479 The build scripts are in the subdirectory @file{debian/}; you can
480 make the .deb by doing, for example:
484 # dpkg --purge lilypond lilypond1.3
486 $ tar xzf lilypond-1.4.3.tar.gz
488 $ dch -p -v 1.4.3-0.local.1 "Local build."
491 # dpkg -i ../lilypond_1.4.3*.deb
496 Use command @command{debuild} instead of @command{debuild -B} if you have
497 a very fast machine and want to build the HTML, PS and DVI documentation
500 For compilation on a Debian GNU/Linux system you need these packages,
501 in addition to the those needed for running:
504 @item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
505 @item libguile<@var{your-libguile-version-here}>-dev
506 @item make, m4, flex, bison
509 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
510 @item dpkg-dev, debhelper, fakeroot
512 @item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
513 in Debian testing/unstable.)
516 Most of these are listed on the @samp{Build-Depends} line in the
517 @file{debian/control} file. To ensure the creation of the lilypond deb is
518 trouble-free, we recommend that you first install the following packages
519 by running \@command{apt-get} as root before building the package:
524 apt-get install task-debian-devel task-c++-dev \
525 python-base libguile6-dev tetex-bin tetex-dev \
526 tetex-extra flex bison texinfo groff gs \
527 netpbm pnmtopng m4 gettext
530 For Debian in development ("unstable", the future 2.3 or 3.0):
533 apt-get install binutils cpp gcc libc6-dev \
534 g++ libstdc++2.10-dev \
535 python-base libguile-dev tetex-bin libkpathsea-dev \
536 tetex-extra flex bison texinfo groff gs \
540 And, just so that old fonts from previous versions of LilyPond won't
541 interfere with your build, you may want to do this before the build too:
544 dpkg --purge lilypond lilypond1.3
549 LilyPond is available through fink, in the unstable cvs distribution.
553 @item Get the Fink package manager from @uref{http://fink.sourceforge.net}
554 @item Get the Lilypond package description by enabling the "unstable" tree
555 in fink and executing @command{fink selfupdate-cvs}.
561 fink install lilypond-unstable
565 That's it! The command should compile and install all LilyPond
566 prerequisites (python, TeX, X11, ghostscript) and then LilyPond
570 @subsubsection compiling on MacOS X
571 LilyPond has been built on Darwin, to be precise, on:
573 Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
574 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc
580 Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
583 To make sure you have all packages needed to build LilyPond installed,
587 apt-get install bash python guile debianutils flex bison texinfo \
588 ghostscript6 netpbm m4 gettext
597 For more information about @file{apt-get} and @file{fink}, see
598 @uref{http://fink.sf.net,fink.sourceforge.net}.
600 @c brokenness of autoconf; don't ask
601 Then, configure, patch, make and install LilyPond using these commands:
604 CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
605 ./configure --prefix=/sw
606 make -C lily out/parser.hh out/parser.cc out/config.h
607 patch -p0 < darwin.patch
608 make -C lily out/parser.o
609 make DEPENDENCIES_OUTPUT=/dev/null all
613 For installing, you must be root, of course.
615 @c Why isn't this in BUGS (where it belongs?)
618 For help and questions use @email{lilypond-user@@gnu.org}. Please
619 consult the FAQ before mailing your problems. If you find bugs, please
620 send bug reports to @email{bug-lilypond@@gnu.org}.
622 Bugs that are not fault of LilyPond are documented here.
624 @unnumberedsubsec FLex-2.5.4a and gcc-3.0
626 Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
627 LilyPond with gcc-3.0 you may do:
630 CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
631 make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
632 patch -p1 < lexer-gcc-3.0.patch
633 make conf=gcc-3.0 -C lily
636 Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
638 @unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
640 There's a bug in certain kernels around version 2.4.0, that is
641 triggered when using Guile 1.4 compiled with pthreads. You'll see
642 random segmentation fault crashes of LilyPond. Upgrade to a newer
643 version of Linux. If you can't do that, you may try to recompiling
644 Guile without threads (YMMV):
647 guile-1.4$ ./configure --without-threads; make all install
651 @unnumberedsubsec NetBSD
654 @item The flex precompiled in NetBSD-1.4.2 is broken.
655 Download flex-2.5.4a, build, install.
657 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
658 release)) does not include @file{/usr/pkg} paths. Configure using:
661 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
667 @unnumberedsubsec Solaris:
670 @item Sparc64/Solaris 2.6, GNU make-3.77
672 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
674 @item Sparc64/Solaris 2.6, ld
680 @unnumberedsubsec AIX
685 The following is from the gcc install/SPECIFIC file.
687 Some versions of the AIX binder (linker) can fail with a relocation
688 overflow severe error when the -bbigtoc option is used to link
689 GCC-produced object files into an executable that overflows the TOC.
690 A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
691 -BBIGTOC) is available from IBM Customer Support and from its
692 27service.boulder.ibm.com website as PTF U455193.
694 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
695 as and GNU ld will not work properly and one should not configure GCC
696 to use those GNU utilities. Use the native AIX tools which do
697 interoperate with GCC.
700 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
702 LDFLAGS='-Wl,-bbigtoc' ./configure