1 \input texinfo @c -*-texinfo-*-
2 @setfilename INSTALL.info
3 @settitle INSTALL - compiling and installing GNU LilyPond
8 @chapter INSTALL - compiling and installing GNU LilyPond
13 This document explains what you need to install LilyPond, and what you
14 should do. If you are going to compile and install LilyPond often,
15 e.g. when doing development, you might want to check out the
16 @file{buildscripts/set-lily.sh} script. It sets some environment
17 variables and symlinks, which comes in handy when you have to compile
22 You can get the latest version of LilyPond at
23 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,
24 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
27 @emph{If you upgrade by patching do remember to rerun autoconf after
30 If you do not want to download the entire archive for each version, the
31 safest method for upgrading is to use @file{xdelta}, see
32 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/}.
34 The following command produces @file{lilypond-1.1.55.tar.gz} from
35 @file{lilypond-1.1.54} identical (up to compression dates) to the .55 on
38 xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
41 @section Prerequisites
43 For compilation you need:
46 @item A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
47 (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
50 @item Lots of disk space: LilyPond takes between 30 and 100 mb to
51 compile if you use debugging information. If you are short on
52 disk-space run configure with @code{--disable-debugging}.
55 Although we recommend to use Unix, LilyPond is known to run on Windows
56 NT/95/98 as well. See Section Windows NT/95,es.
58 @item EGCS 1.1 or newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/}.
62 @uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
64 @item GUILE 1.3.4 or newer, check out
65 @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
66 Version 1.4 is recommended for better performance.
70 @uref{ftp://ftp.gnu.org/gnu/make/,ftp://ftp.gnu.org/gnu/make/}.
72 @item Flex (version 2.5.4 or newer).
73 Check out @uref{ftp://ftp.gnu.org/gnu/flex/,ftp://ftp.gnu.org/gnu/flex/}.
75 @item Bison (version 1.25 or newer).
76 Check out @uref{ftp://ftp.gnu.org/gnu/bison/,ftp://ftp.gnu.org/gnu/bison/}.
78 @item TeX. If you want LilyPond to use kpathsea support (recommended),
79 make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
80 need to install a tetex-devel or tetex-dev package too.
82 @item Texinfo (version 4.0 or newer).
83 Check out @uref{ftp://ftp.gnu.org/gnu/texinfo/,ftp://ftp.gnu.org/gnu/texinfo/}.
84 Most documentation is in texinfo.
86 @item The geometry package for LaTeX is needed to use ly2dvi.
88 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
89 or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
91 @item MetaPost, needed for generating PostScript fonts. Please
92 note that tetex-0.4pl8 (included with Redhat 5.x) does not include
93 @file{mfplain.mp}, which is needed for producing the scalable font
96 If you do not want to use PostScript output, edit @file{mf/GNUmakefile}.
98 @item kpathsea, a library for searching (TeX) files. @code{kpathsea} is
99 usually included with your installation of TeX.
106 GNU LilyPond does use a lot of resources. For operation you need the
111 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
112 recommended. Xdvi will show all embedded PostScript too if you have
113 Ghostscript installed.
114 @item GUILE 1.3.4, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
117 For running LilyPond successfully you have to help TeX and MetaFont
118 find various files. The recommended way of doing so is adjusting the
119 environment variables in the start-up scripts of your shell. An
120 example is given here for the Bourne shell:
122 export MFINPUTS="/usr/local/share/lilypond/mf:"
123 export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
127 The empty path component
128 represents TeX and MetaFont's default search paths. Scripts with
129 the proper paths for the bourne and C-shell respectively are generated in
130 @file{buildscripts/out/lilypond-profile} and
131 @file{buildscripts/out/lilypond-login} during compilation.
133 LilyPond is a hiddeously big, slow and bloated program. A fast CPU
134 and plenty of RAM is recommended for comfortable use.
138 The website is the most convenient form to use for reading the
139 documentation on-line documentation. It is made by entering @example
144 This does require a functioning LilyPond. The binary doesn't have to
147 If you want to auto-generate Lily's website, you'll need some additional
151 @item xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
152 users: it is included within the package libgr-progs).
154 @uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
156 @item pnmtopng, which is also in libgr-progs for RedHat. The original is
158 @uref{ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz,ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz}.i
160 The version of @file{pnmtopng} that is distributed with RedHat 5.1 and
161 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
162 version of libpng, which results in cropped images. Recompile it from
163 source, and make sure that the pnmtopng binary is linked statically to
164 the libpng that is included in libgr. RedHat 6.0 does not have this
168 tar xzf libgr-2.0.13.tar.gz
176 You can then install the new pnmtopng into @file{/usr/local/bin/}
178 @item @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html,Bib2html}.
179 Which, in turn depends on man2html for proper installation.
180 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}.
182 The website will build without this utility, but you will not see our
183 hypertextified bibliography.
185 @item @uref{http://www.zib.de/Visual/software/doc++/index.html,DOC++}
186 A documentation system for C++ sources, which is used for the
190 @section Configuring and compiling
192 to install GNU LilyPond, simply type:
195 gunzip -c lilypond-x.y.z | tar xf -
197 ./configure # fill in your standard prefix with --prefix
203 This will install a number of files, something close to:
206 /usr/local/man/man1/mi2mu.1
207 /usr/local/man/man1/convert-mudela.1
208 /usr/local/man/man1/mudela-book.1
209 /usr/local/man/man1/lilypond.1
210 /usr/local/bin/lilypond
212 /usr/local/bin/convert-mudela
213 /usr/local/bin/mudela-book
214 /usr/local/bin/abc2ly
215 /usr/local/share/lilypond/*
216 /usr/local/share/locale/@{it,nl@}/LC_MESSAGES/lilypond.mo
220 The above assumes that you are root and have the GNU development
221 tools, and your make is GNU make. If this is not the case, you can
222 adjust your environment variables to your taste:
226 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
231 @code{CPPFLAGS} are the preprocessor flags.
233 The configure script is Cygnus configure, and it will accept
234 @code{--help}. If you are not root, you will probably have to make it
235 with a different @code{--prefix} option. Our favourite location is
239 ./configure --prefix=$HOME/usr
243 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
245 Since GNU LilyPond currently is beta, you are advised to also use
254 Options to configure include:
257 @item @code{--enable-printing}
258 Enable debugging print routines (lilypond @code{-D} option)
259 @item @code{--enable-optimise}
260 Set maximum optimisation: compile with @code{-O2}. This can be
261 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
262 @item @code{--enable-profiling}
263 Compile with support for profiling.
264 @item @code{--enable-config}
265 Output to a different configuration file. Needed for multi-platform
269 All options are documented in the @file{configure} help
270 The option @code{--enable-optimise} is recommended for Real Life usage.
280 everything will be compiled, but nothing will be installed. The
281 resulting binaries can be found in the subdirectories @file{out/} (which
282 contain all files generated during compilation).
284 @section Configuring for multiple platforms
286 If you want to compile LilyPond with different configuration settings,
287 then, you can use the @code{--enable-config} option. Example: suppose I
288 want to build with and without profiling. Then I'd use the
289 following for the normal build,
293 ./configure --prefix=~ --disable-optimise --enable-checking
299 and for the profiling version, I specify a different configuration.
303 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
305 make config=optprof install
312 if you have done a successful @code{make}, then a simple
322 If you are doing an upgrade, please remember to remove obsolete
323 @file{.pk} and @file{.tfm} files of the fonts. A script has been
324 provided to do the work for you, see @file{bin/clean-fonts.sh}.
327 @section Redhat linux
329 RedHat Linux users can compile an RPM. A spec file is in
330 @file{make/out/lilypond.spec}, it is distributed along with the
333 You can make the rpm by issuing
336 rpm -tb lilypond-x.y.z.tar.gz
337 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
341 Precompiled i386 RedHat RPMS are available from
342 @uref{ftp://freshmeat.net/pub/rpms/lilypond/,ftp://freshmeat.net/pub/rpms/lilypond/} and
343 @uref{http://linux.umbc.edu/software/lilypond/rpms/,http://linux.umbc.edu/software/lilypond/rpms/}.
345 For compilation on a RedHat system you need these packages,
346 in addition to the those needed for running:
349 @item libstdc++-devel
356 @section Debian GNU/linux
358 A Debian package is also available; see
359 @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
360 or contact Anthony Fok @email{foka@@debian.org} for more information.
361 The build scripts are in the subdirectory @file{debian/}.
363 @section Windows NT/95
365 Separate instructions on building for W32 are available; See the files
366 in @file{Documentation/ntweb/}, included with the sources.
370 For help and questions use @email{help-gnu-music@@gnu.org} and
371 @email{gnu-music-discuss@@gnu.org}. Please consult the faq before
372 mailing your problems.
374 If you find bugs, please send bug reports to
375 @email{bug-gnu-music@@gnu.org}.
377 Known bugs that are LilyPond's fault are listed in @file{TODO}, or
378 demonstrated in @file{input/bugs/}.
380 Known bugs that are not LilyPond's fault are documented here.
383 @unnumbered LinuxPPC Bugs:
386 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
387 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
389 @item egcs-1.0.2 (LinuxPPC R4):
390 all compiling with @code{-O2} is suspect, in particular guile-1.3, and
391 Lily herself will break.
396 @unnumbered Linux-i386
399 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
401 Lily will crash during parsing (which suggests a C++ library
402 incompatibility). Precise cause, precise platform description or
403 solution are not known.
405 Note that this only happens on some computers with the said platform.
409 LilyPond occasionally crashes while parsing the initialisation files.
410 This is a very obscure bug, and usually entering the commandline
411 differently "fixes" it.
419 lilypond -I. ./input.ly
426 __libc_malloc (bytes=16384)
428 yyFlexLexer::yy_create_buffer ()
429 Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
432 This behaviour has been observed with machines that have old libg++
433 versions (LinuxPPC feb '98, RedHat 4.x).
442 @item Sparc64/Solaris 2.6, GNU make-3.77
444 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
447 @item Sparc64/Solaris 2.6, ld
458 The following is from the gcc install/SPECIFIC file.
460 Some versions of the AIX binder (linker) can fail with a relocation
461 overflow severe error when the -bbigtoc option is used to link
462 GCC-produced object files into an executable that overflows the TOC. A
463 fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
464 -BBIGTOC) is available from IBM Customer Support and from its
465 27service.boulder.ibm.com website as PTF U455193.
467 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
468 as and GNU ld will not work properly and one should not configure GCC
469 to use those GNU utilities. Use the native AIX tools which do
470 interoperate with GCC.
473 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
475 LDFLAGS='-Wl,-bbigtoc' ./configure