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 is
19 also known to run and compile on Windows NT/95/98 as well. More
20 information on this topic can be found at the
21 @uref{http://www.lilypond.org/gnu-windows/, LilyPond on Windows page}.
25 <a name="download-source">
30 Even numbered versions are `stable'. The webpages for the stable version
31 (1.2) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
32 servers}. Big enhancements go into the latest odd numbered version
33 (1.3), 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.
51 Of course, if your platform supports LilyPond, such as Debian GNU/Linux,
52 FreeBSD, OpenBSD or NetBSD, you're encouraged to use the native build
55 For Red Hat Linux and SuSE Linux, @file{.spec} files are included in the
56 tarball; see instructions below.
59 <a name="download-binaries">
64 @subsection Precompiled binaries
66 If you want to track bleeding edge development, try:
69 @item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian
70 GNU/Linux} usually has the latest binaries for the most useful stable
71 and development versions, while
72 @item @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/,
73 Mandrake Cooker} also provides fairly recent versions.
76 Binaries are made available for other popular platforms, but as we need
77 to compile them ourselves, they are not updated for every version
81 @item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386}
82 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE, SuSE}
83 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/,
86 @uref{http://www.lilypond.org/gnu-windows/, Windows}
91 There are two options for upgrading sources.
94 @item if you have an unpacked source tree of a previous version, you
97 @emph{If you upgrade by patching do remember to rerun autoconf after
100 @item if you have the @code{.tar.gz} file of a previous release, you can
102 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
103 This is much safer than using patches, and is the recommended way.
105 The following command produces @file{lilypond-1.4.3.tar.gz} from
106 @file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
109 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
113 @section Requirements
115 @subsection Compilation
117 You need the following packages to compile Lilypond.
120 @item A reasonably new version of the GNU C++ compiler: EGCS 1.1, GCC 2.95.2 or
121 newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
123 @item Python (version 1.5 or newer).
124 Check out @uref{http://www.python.org, the python website}.
126 @item GUILE (version 1.4 or newer).
128 @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
132 @uref{ftp://ftp.gnu.org/gnu/make/, the GNU
135 @item Flex (version 2.5.4a or newer).
136 Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
138 @item Bison (version 1.25 or newer).
139 Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
143 @TeX{} is used as an output backend.
145 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf}, @file{.afm}, @file{.tfm}).
146 Make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
147 need to install a tetex-devel or tetex-dev package too.
149 @item Texinfo (version 4.2 or newer).
150 The documentation of lily is written in texinfo. Check out
151 @uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
153 @item The geometry package for LaTeX is needed to use ly2dvi.
155 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
156 FTP directory for @code{geometry}}. This package is normally included
157 with the @TeX{} distribution.
159 @item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
160 usually included with your installation of @TeX{}. You may need to install
161 a tetex-devel or tetex-dev package too. If kpathsea is not installed in
162 a directory where the compiler normally looks, read the hints for
165 In the very unlikely case that kpathsea is not available for your
166 platform (ie, you're not running GNU/Linux, Windows, or any recent
167 UNIX), you can compile LilyPond without kpathsea support. In that case,
168 you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
169 configure something like:
172 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
177 @subsection Running requirements
179 GNU LilyPond does use a lot of resources. For operation you need the
184 @item Xdvi and Ghostscript
185 @item GUILE 1.3.4, or newer. Check out
186 @uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
189 For running LilyPond successfully you have to help @TeX{} and MetaFont find
190 various files. The recommended way of doing so is adjusting the
191 environment variables in the start-up scripts of your shell. Appropriate
192 Csh and bourne sh scripts are left in
193 @file{buildscripts/out/lilypond-profile} and
194 @file{buildscripts/out/lilypond-login} after compilation.
196 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
197 recommended for comfortable use.
199 @subsection Website requirements
201 The documentation comes in the form of a website. You can view this
202 website on the internet, but you can also build it locally. This process
203 requires a successful compile of lilypond. The website is built
211 Building the website requires some additional tools:
214 @item The netpbm utilities, see @uref{http://netpbm.sourceforge.net/}
215 @item pktrace 1.0 or newer, needed for generating PostScript Type1
216 fonts. Get it from @uref{http://www.cs.uu.nl/~hanwen/pktrace/}. You
217 will need to install some additional packages to get pktrace to work.
220 @section Building LilyPond
222 to install GNU LilyPond, type:
224 gunzip -c lilypond-x.y.z | tar xf -
226 ./configure # run with --help to see appropriate options
229 sh buildscripts/clean-fonts.sh
232 If you are doing an upgrade, you should remove all @file{feta}
233 @code{.pk} and @file{.tfm} files. A script has been provided to do the
234 work for you, see @file{buildscripts/clean-fonts.sh}.
237 If you are not root, you should choose a @code{--prefix} argument that
238 points into your home directory, eg.
241 ./configure --prefix=$HOME/usr
245 In this case, you have to insert the contents of
246 @code{buildscripts/out/lilypond-login} or
247 @code{buildscripts/out/lilypond-profile} into your start up scripts by
252 @subsection Configuring for multiple platforms
254 If you want to build multiple versions of LilyPond with different
255 configuration settings, you can use the @code{--enable-config=CONF}
256 option of configure. You should use @samp{make conf=CONF} to generate
257 the output in @file{out-CONF}. Example: suppose I want to build with
258 and without profiling. Then I'd use the following for the normal build,
261 ./configure --prefix=~ --enable-checking
266 and for the profiling version, I specify a different configuration.
270 ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
272 make conf=prof install
282 An Emacs mode for entering music and running LilyPond is included with
283 the source archive as @file{lilypond-mode.el},
284 @file{lilypond-indent.el} and @file{lilypond-font-lock.el}. You
285 should install these files somewhere in your @var{load-path}. If you
286 have installed a precompiled LilyPond package, these files can be
287 found in @file{/usr/share/doc/lilypond-x.y.z/}.
289 Add this to your @file{~/.emacs} or @file{~/.emacs.el}, or install this
290 file in Emacs' @file{site-start.d}:
293 ;;; lilypond-init.el --- Startup code for LilyPond mode
295 (autoload 'LilyPond-mode "lilypond-mode")
296 (setq auto-mode-alist
297 (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
299 (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
303 If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
304 automatically loaded, you not even need to modify your @code{~/.emacs}
307 @section Compiling for distributions
309 @subsection Red Hat Linux
311 Red Hat 7.x i386 RPMS are available from
312 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
314 You can also compile them yourself. A spec file is in
315 @file{make/out/lilypond.redhat.spec}. This file is distributed along
316 with the sources. You can make the rpm by issuing
319 tar xfz lilypond-x.y.z.tar.gz
320 rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
321 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
325 For running on a Red Hat system you need these packages: guile, tetex,
326 tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
328 For compilation on a Red Hat system you need these packages, in
329 addition to the those needed for running: glibc-devel, gcc-c++,
330 libstdc++-devel, guile-devel, flex, bison, texinfo, groff, pktrace,
331 netpbm-progs, autotrace, t1utils.
338 Some LinuxPPC RPMS should available from
339 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
341 A LinuxPPC RPM can be made using the @file{lilypond.redhat.spec} file.
345 Some SUSE RPMS should available from
346 @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE}.
348 You can also compile a RPM for SUSE yourself. A spec file is in
349 @file{make/out/lilypond.suse.spec}, see the instructions for building
352 You must have the following packages: guile tcsh tetex te_latex te_kpath
353 te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
354 gs_serv gs_lib gs_fonts guile
356 @subsection Slackware
358 No precompiled packages for Slackware are available.
360 Problems have been reported with Slackware 7.0; apparently, it ships
361 with a faulty compiler. Do not compile LilyPond with -O2 on this
364 At least on Slackware 8.0, you have to manually specify the paths to the
365 Kpathsea library, using
367 @item @code{rm config.cache}
368 @item @code{export LDFLAGS=-L/usr/share/texmf/lib}
369 @item @code{export CPPFLAGS=-I/usr/share/texmf/include}
370 @item @code{./configure}
376 Some binaries are available at rpmfind.net. Refer to
377 @uref{http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/}.
379 You can also compile a RPM for Mandrake yourself. A spec file is in
380 @file{make/out/lilypond.mandrake.spec}, see the instructions for building
383 @subsection Debian GNU/Linux
385 A Debian package is also available. You may install it easily by running
386 @command{apt-get} as root:
389 apt-get install lilypond lilypond-doc
392 You can also compile the .deb for Debian yourself, do:
395 apt-get -b source lilypond
398 If you're real impatient, you may even do:
401 cd lilypond-x.y.z # a previous version
402 uscan # download and build latest directly from upstream
406 Debian's @TeX{} installation is a bit short on memory, you may want to
407 increase it like this:
409 --- texmf.cnf.orig Sun Dec 16 23:47:07 2001
410 +++ texmf.cnf Sun Dec 16 23:46:34 2001
412 main_memory.context = 1500000
413 main_memory.mpost = 1000000
414 main_memory = 263000 % words of inimemory available; also applies to inimf&mp
415 -extra_mem_top = 0 % extra high memory for chars, tokens, etc.
416 -extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
417 +extra_mem_top = 1000000 % extra high memory for chars, tokens, etc.
418 +extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
420 obj_tab_size.context = 300000
423 % Max number of characters in all strings, including all error messages,
424 % help texts, font names, control sequences. These values apply to TeX and MP.
425 pool_size.context = 750000
428 % Minimum pool space after TeX/MP's own strings; must be at least
429 % 25000 less than pool_size, but doesn't need to be nearly that large.
430 string_vacancies.context = 45000
433 You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
434 environment variables if you do not want to or cannot modify
435 @file{/etc/texmf/texmf.cnf}.
440 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
441 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
442 for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
443 The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
444 Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
445 package is now obsolete.
448 Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
451 The build scripts are in the subdirectory @file{debian/}; you can
452 make the .deb by doing, for example:
456 # dpkg --purge lilypond lilypond1.3
458 $ tar xzf lilypond-1.4.3.tar.gz
460 $ dch -p -v 1.4.3-0.local.1 "Local build."
463 # dpkg -i ../lilypond_1.4.3*.deb
468 Use command @command{debuild} instead of @command{debuild -B} if you have
469 a very fast machine and want to build the HTML, PS and DVI documentation
472 For compilation on a Debian GNU/Linux system you need these packages,
473 in addition to the those needed for running:
476 @item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
477 @item libguile<@var{your-libguile-version-here}>-dev
478 @item make, m4, flex, bison
481 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
482 @item dpkg-dev, debhelper, fakeroot
484 @item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
485 in Debian testing/unstable.)
488 Most of these are listed on the @samp{Build-Depends} line in the
489 @file{debian/control} file. To ensure the creation of the lilypond deb is
490 trouble-free, we recommend that you first install the following packages
491 by running \@command{apt-get} as root before building the package:
496 apt-get install task-debian-devel task-c++-dev \
497 python-base libguile6-dev tetex-bin tetex-dev \
498 tetex-extra flex bison texinfo groff gs \
499 netpbm pnmtopng m4 gettext
502 For Debian in development ("unstable", the future 2.3 or 3.0):
505 apt-get install binutils cpp gcc libc6-dev \
506 g++ libstdc++2.10-dev \
507 python-base libguile-dev tetex-bin libkpathsea-dev \
508 tetex-extra flex bison texinfo groff gs \
512 And, just so that old fonts from previous versions of LilyPond won't
513 interfere with your build, you may want to do this before the build too:
516 dpkg --purge lilypond lilypond1.3
521 LilyPond is available through fink, in the unstable cvs distribution.
525 @item Get the Fink package manager from @uref{http://fink.sourceforge.net}
526 @item Get the Lilypond package description by enabling the "unstable" tree
527 in fink and executing @command{fink selfupdate-cvs}.
533 fink install lilypond-unstable
537 That's it! The command should compile and install all LilyPond
538 prerequisites (python, TeX, X11, ghostscript) and then LilyPond
542 @subsubsection compiling on MacOS X
543 LilyPond has been built on Darwin, to be precise, on:
545 Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
546 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc
552 Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
555 To make sure you have all packages needed to build LilyPond installed,
559 apt-get install bash python guile debianutils flex bison texinfo \
560 ghostscript6 netpbm m4 gettext
569 For more information about @file{apt-get} and @file{fink}, see
570 @uref{http://fink.sf.net,fink.sourceforge.net}.
572 @c brokenness of autoconf; don't ask
573 Then, configure, patch, make and install LilyPond using these commands:
576 CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
577 ./configure --prefix=/sw
578 make -C lily out/parser.hh out/parser.cc out/config.h
579 patch -p0 < darwin.patch
580 make -C lily out/parser.o
581 make DEPENDENCIES_OUTPUT=/dev/null all
585 For installing, you must be root, of course.
587 @c Why isn't this in BUGS (where it belongs?)
590 For help and questions use @email{lilypond-user@@gnu.org}. Please
591 consult the FAQ before mailing your problems. If you find bugs, please
592 send bug reports to @email{bug-lilypond@@gnu.org}.
594 Bugs that are not fault of LilyPond are documented here.
596 @unnumberedsubsec FLex-2.5.4a and gcc-3.0
598 Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
599 LilyPond with gcc-3.0 you may do:
602 CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
603 make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
604 patch -p1 < lexer-gcc-3.0.patch
605 make conf=gcc-3.0 -C lily
608 Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
610 @unnumberedsubsec Linux-2.4.0, Guile-1.4 --with-threads
612 There's a bug in certain kernels around version 2.4.0, that is
613 triggered when using Guile 1.4 compiled with pthreads. You'll see
614 random segmentation fault crashes of LilyPond. Upgrade to a newer
615 version of Linux. If you can't do that, you may try to recompiling
616 Guile without threads (YMMV):
619 guile-1.4$ ./configure --without-threads; make all install
623 @unnumberedsubsec NetBSD
626 @item The flex precompiled in NetBSD-1.4.2 is broken.
627 Download flex-2.5.4a, build, install.
629 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
630 release)) does not include @file{/usr/pkg} paths. Configure using:
633 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
639 @unnumberedsubsec Solaris:
642 @item Sparc64/Solaris 2.6, GNU make-3.77
644 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
646 @item Sparc64/Solaris 2.6, ld
652 @unnumberedsubsec AIX
657 The following is from the gcc install/SPECIFIC file.
659 Some versions of the AIX binder (linker) can fail with a relocation
660 overflow severe error when the -bbigtoc option is used to link
661 GCC-produced object files into an executable that overflows the TOC.
662 A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
663 -BBIGTOC) is available from IBM Customer Support and from its
664 27service.boulder.ibm.com website as PTF U455193.
666 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
667 as and GNU ld will not work properly and one should not configure GCC
668 to use those GNU utilities. Use the native AIX tools which do
669 interoperate with GCC.
672 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
674 LDFLAGS='-Wl,-bbigtoc' ./configure