1 \input texinfo @c -*-texinfo-*-
2 @setfilename INSTALL.info
3 @settitle INSTALL - compiling and installing GNU LilyPond
10 @chapter INSTALL - compiling and installing GNU LilyPond
13 This document describes how to build LilyPond on Unix platforms. It is
14 also known to run and compile on Windows NT/95/98 as well. More
15 information on this topic can be found at the
16 @uref{http://www.lilypond.org/gnu-windows/, LilyPond on Windows page}.
20 <a name="download-source">
25 Even numbered versions are `stable'. The webpages for the stable version
26 (1.2) reside @uref{http://www.gnu.org/software/lilypond, on the GNU
27 servers}. Big enhancements go into the latest odd numbered version
28 (1.3), whose webpages are on @uref{http://www.lilypond.org/,the lilypond
31 @subsection source code
34 If you want to compile LilyPond from source, download here:
36 @item Download development releases from
37 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/} by FTP and
38 @uref{http://ftp.cs.uu.nl/pub/GNU/LilyPond/}, by HTTP.
39 @item @uref{ftp://sca.uwaterloo.ca/pub/} by FTP (Canadian mirror)
40 @item at @code{lilypond.org}
41 @uref{ftp://ftp.lilypond.org/pub/LilyPond/} by FTP and
42 @uref{http://www.lilypond.org/ftp/} by HTTP.
46 <a name="download-binaries">
53 Binaries are available, but are not updated for every version released.
55 @item @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/, Red Hat i386}
56 @item @uref{ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/, LinuxPPC}
57 @item @uref{ftp://ftp.debian.org/debian/pool/main/l/lilypond/, Debian GNU/Linux}
58 @item @uref{http://home.austin.rr.com/jbr/jeff/lilypond/, Windows Stable}
59 @c @item @uref{ftp://ftp.lilypond.org/pub/lilypond/gnu-windows, Windows
61 @uref{http://www.lilypond.org/gnu-windows/, Windows Testing}
67 There are two options for upgrading sources.
70 @item if you have an unpacked source tree of a previous version, you
73 @emph{If you upgrade by patching do remember to rerun autoconf after
76 @item if you have the @code{.tar.gz} file of a previous release, you can
78 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/, xdelta}.
79 This is much safer than using patches, and is the recommended way.
81 The following command produces @file{lilypond-1.4.3.tar.gz} from
82 @file{lilypond-1.4.2.tar.gz} identical (up to compression dates) to the .3
85 xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
91 @subsection Compilation
93 You need the following packages to compile Lilypond.
96 @item A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or
97 newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/, the gcc site}.
100 Check out @uref{http://www.python.org, the python website}.
102 @item GUILE 1.3.4 or newer, check out
103 @uref{http://www.gnu.org/software/guile/guile.html,the GUILE webpage}.
104 Version 1.4 is recommended for better performance.
108 @uref{ftp://ftp.gnu.org/gnu/make/, the GNU
111 @item Flex (version 2.5.4a or newer).
112 Check out @uref{http://www.gnu.org/software/flex/,the Flex webpage}.
114 @item Bison (version 1.25 or newer).
115 Check out @uref{http://www.gnu.org/software/bison/,the bison webpage}
119 @TeX{} is used as an output backend.
121 Also, @TeX{}'s libkpathsea is used to find the fonts (@file{.mf}, @file{.afm}, @file{.tfm}).
122 Make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
123 need to install a tetex-devel or tetex-dev package too.
125 @item Texinfo (version 4.0 or newer).
126 The documentation of lily is written in texinfo. Check out
127 @uref{ftp://ftp.gnu.org/gnu/texinfo/,the texinfo FTP directory}.
129 @item The geometry package for LaTeX is needed to use ly2dvi.
131 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,the
132 FTP directory for @code{geometry}}. This package is normally included
133 with the @TeX{} distribution.
135 @item MetaPost, needed for generating PostScript fonts. Please
136 note that tetex-0.4pl8 (included with Red Hat 5.x) does not include
137 @file{mfplain.mp}, which is needed for producing the scalable font
140 If you don't have MetaPost and don't want to use PostScript output, then
141 edit @file{mf/GNUmakefile}, removing the line saying @code{PFA_FILES=}.
143 @item kpathsea, a library for searching (@TeX{}) files. @code{kpathsea} is
144 usually included with your installation of @TeX{}. You may need to install
145 a tetex-devel or tetex-dev package too.
147 In the very unlikely case that kpathsea is not available for your
148 platform (ie, you're not running GNU/Linux, Windows, or any recent
149 UNIX), you can compile LilyPond without kpathsea support. In that case,
150 you'll probably have to indicate where @TeX{}'s tfm files live. Invoke
151 configure something like:
154 ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
159 @subsection Running requirements
161 GNU LilyPond does use a lot of resources. For operation you need the
166 @item Xdvi and Ghostscript
167 @item GUILE 1.3.4, or newer. Check out
168 @uref{http://www.gnu.org/software/guile.html,the GUILE webpage}
171 For running LilyPond successfully you have to help @TeX{} and MetaFont find
172 various files. The recommended way of doing so is adjusting the
173 environment variables in the start-up scripts of your shell. Appropriate
174 Csh and bourne sh scripts are left in
175 @file{buildscripts/out/lilypond-profile} and
176 @file{buildscripts/out/lilypond-login} after compilation.
178 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
179 recommended for comfortable use.
181 @subsection Website requirements
183 The documentation comes in the form of a website. You can view this
184 website on the internet, but you can also build it locally. This process
185 requires a successful compile of lilypond. The website is built
193 Building the website requires some additional tools:
196 @item xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
198 @uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,the
201 @item pnmtopng. The original is
203 @uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,in
204 the pnmtopng FTP site}.
206 @item @uref{http://www.lri.fr/~filliatr/ftp/bibtex2html/, Bibtex2html}, or
207 @uref{http://www.uni-koblenz.de/ag-ki/ftp/bib2html/, Bib2html}.
208 Bibtex2html is available in debian, while bib2html is in some rpm based
210 Bib2html, in turn depends on man2html for proper installation.
211 man2html can be had from @uref{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}.
213 The website will build without bib converter utility, but you will not
214 see our hypertextified bibliography.
216 @item texinfo (a development release)
217 The documentation will build with texinfo-4.0, but if you want split
218 html pages, you're best off using the lates pretest version from
219 @uref{ftp://texinfo.org/texinfo/pretests/texinfo-4.0b.tar.gz,
221 @uref{ftp://alpha.gnu.org/gnu/texinfo-4.0b.tar.gz,texinfo-4.0b}
224 @section Building LilyPond
226 to install GNU LilyPond, type:
228 gunzip -c lilypond-x.y.z | tar xf -
230 ./configure # run with --help to see appropriate options
233 sh buildscripts/clean-fonts.sh
236 If you are doing an upgrade, you should remove all @file{feta}
237 @code{.pk} and @file{.tfm} files. A script has been provided to do the
238 work for you, see @file{buildscripts/clean-fonts.sh}.
241 If you are not root, you should choose a @code{--prefix} argument that
242 points into your home directory, eg.
245 ./configure --prefix=$HOME/usr
249 In this case, you have to insert the contents of
250 @code{buildscripts/out/lilypond-login} or
251 @code{buildscripts/out/lilypond-profile} into your start up scripts by
256 @subsection Configuring for multiple platforms
258 If you want to build multiple versions of LilyPond with different
259 configuration settings, you can use the @code{--enable-config=CONF}
260 option of configure. You should use @samp{make conf=CONF} to generate
261 the output in @file{out-CONF}. Example: suppose I want to build with
262 and without profiling. Then I'd use the following for the normal build,
265 ./configure --prefix=~ --enable-checking
270 and for the profiling version, I specify a different configuration.
274 ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
276 make conf=prof install
286 An emacs mode for LilyPond is included with the source archive as
287 @file{lilypond-mode.el} and @file{lilypond-font-lock.el}. If you have
288 an RPM, it is in @file{/usr/share/doc/lilypond-X/}. You have to install
291 Add this to your @file{~/.emacs} or @file{~/.emacs.el}:
293 (load-library "lilypond-mode.el")
294 (setq auto-mode-alist
295 (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
296 (add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
299 If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode is
300 automatically loaded, so you need not modify your @code{~/.emacs} file.
302 @section Compiling for distributions
304 @subsection Red Hat Linux
306 Red Hat 7.0 i386 RPMS are available from
307 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
309 You can also compile them yourself. A spec file is in
310 @file{make/out/redhat.spec}. This file is distributed along with the
311 sources. You can make the rpm by issuing
314 tar xfz lilypond-x.y.z.tar.gz
315 rpm -bb lilypond-x.y.z/make/out/redhat.spec
316 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
320 For running on a Red Hat system you need these packages: guile, tetex,
321 tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
323 For compilation on a Red Hat system you need these packages, in addition
324 to the those needed for running: glibc-devel, gcc-c++, libstdc++-devel,
325 guile-devel, flex, bison, texinfo, tetex-devel, groff,
331 There appears to be a problem with the Xdvi shipped with Red Hat 7.1.
332 Symptoms: Xdvi responds very sluggishly or hangs while viewing
333 lilypond output. The cause for this problem is unknown; you are advised
334 to recompile Xdvi from source.
339 Some LinuxPPC RPMS should available from
340 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
342 A LinuxPPC RPM can be made using the @file{redhat.spec} file.
346 Some SUSE RPMS should available from
347 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/}.
349 You can also compile a RPM for SUSE yourself. A spec file is in
350 @file{make/out/suse.spec}, see the instructions for building the Red Hat
353 You must have the following packages: guile tcsh tetex te_latex te_kpath
354 te_mpost libpng python gpp libgpp gettext autoconf netpbm libnetpb
355 gs_serv gs_lib gs_fonts guile
357 @subsection Slackware
359 No precompiled packages for Slackware are available.
361 Problems have been reported with Slackware 7.0; apparently, it ships
362 with a faulty compiler. Do not compile LilyPond with -O2 on this
367 Some binaries are available at rpmfind.net. Refer to
368 @uref{ftp://ftp.rpmfind.net/linux/Mandrake-devel/cooker/contrib/RPMS/}.
371 @subsection Debian GNU/Linux
373 A Debian package is also available. You may install it easily by running
374 @command{apt-get} as root:
377 apt-get install lilypond lilypond-doc
381 Debian's @TeX{} installation is a bit short on memory, you may want to
382 increase it like this:
384 --- /etc/texmf/texmf.cnf.dpkg Sun Jan 28 14:12:14 2001
385 +++ /etc/texmf/texmf.cnf Fri Apr 27 11:09:35 2001
387 main_memory.context = 1500000
388 main_memory.mpost = 1000000
389 main_memory = 263000 % words of inimemory available; also applies to inimf&mp
390 -extra_mem_top = 0 % extra high memory for chars, tokens, etc.
391 -extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
392 +extra_mem_top = 100000 % extra high memory for chars, tokens, etc.
393 +extra_mem_bot = 100000 % extra low memory for boxes, glue, breakpoints, etc.
395 obj_tab_size.context = 256000
399 You could also export @env{extra_mem_top} and @env{extra_mem_bot} as
400 environment variables if you do not want to or cannot modify
401 @file{/etc/texmf/texmf.cnf}.
406 @item @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
407 @item @uref{http://people.debian.org/~foka/lilypond/,http://people.debian.org/~foka/lilypond/}
408 for latest semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato) users.
409 The official stable Debian 2.2 is stuck with the old LilyPond-1.3.24.
410 Since LilyPond-1.4 has been released, the older lilypond1.3 Debian
411 package is now obsolete.
414 Please contact Anthony Fok @email{lilypond@@packages.debian.org} for more
417 The build scripts are in the subdirectory @file{debian/}; you can
418 make the .deb by doing, for example:
422 # dpkg --purge lilypond lilypond1.3
424 $ tar xzf lilypond-1.4.3.tar.gz
426 $ dch -p -v 1.4.3-0.local.1 "Local build."
429 # dpkg -i ../lilypond_1.4.3*.deb
434 Use command @command{debuild} instead of @command{debuild -B} if you have
435 a very fast machine and want to build the HTML, PS and DVI documentation
438 For compilation on a Debian GNU/Linux system you need these packages,
439 in addition to the those needed for running:
442 @item g++, cpp, libc6-dev, libstdc++<@var{your-libstdc++-version-here}>-dev
443 @item libguile<@var{your-libguile-version-here}>-dev
444 @item make, m4, flex, bison
447 @item bibtex2html (not in Debian 2.2)
448 @item tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
449 @item dpkg-dev, debhelper, fakeroot
451 @item pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
452 in Debian testing/unstable.)
455 Most of these are listed on the @samp{Build-Depends} line in the
456 @file{debian/control} file. To ensure the creation of the lilypond deb is
457 trouble-free, we recommend that you first install the following packages
458 by running \@command{apt-get} as root before building the package:
463 apt-get install task-debian-devel task-c++-dev \
464 python-base libguile6-dev tetex-bin tetex-dev \
465 tetex-extra flex bison texinfo groff gs \
466 netpbm pnmtopng m4 gettext
469 For Debian in development ("unstable", the future 2.3 or 3.0):
472 apt-get install task-debian-devel task-c++-dev \
473 python-base libguile9-dev tetex-bin libkpathsea-dev \
474 tetex-extra flex bison texinfo bibtex2html groff gs \
478 And, just so that old fonts from previous versions of LilyPond won't
479 interfere with your build, you may want to do this before the build too:
482 dpkg --purge lilypond lilypond1.3
489 For help and questions use @email{help-gnu-music@@gnu.org} and
490 @email{gnu-music-discuss@@gnu.org}. Please consult the FAQ before
491 mailing your problems. If you find bugs, please send bug reports to
492 @email{bug-gnu-music@@gnu.org}.
494 Bugs that are not fault of LilyPond are documented here.
496 @unnumberedsubsec NetBSD
499 @item The flex precompiled in NetBSD-1.4.2 is broken.
500 Download flex-2.5.4a, build, install.
502 @item The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
503 release)) does not include @file{/usr/pkg} paths. Configure using:
506 CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
512 @unnumberedsubsec Solaris:
515 @item Sparc64/Solaris 2.6, GNU make-3.77
517 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
519 @item Sparc64/Solaris 2.6, ld
525 @unnumberedsubsec AIX
530 The following is from the gcc install/SPECIFIC file.
532 Some versions of the AIX binder (linker) can fail with a relocation
533 overflow severe error when the -bbigtoc option is used to link
534 GCC-produced object files into an executable that overflows the TOC.
535 A fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
536 -BBIGTOC) is available from IBM Customer Support and from its
537 27service.boulder.ibm.com website as PTF U455193.
539 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
540 as and GNU ld will not work properly and one should not configure GCC
541 to use those GNU utilities. Use the native AIX tools which do
542 interoperate with GCC.
545 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
547 LDFLAGS='-Wl,-bbigtoc' ./configure