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 handly 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/,ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}. Refer to the links
24 document for mirror sites.
26 @emph{If you upgrade by patching do remember to rerun autoconf after
29 If you do not want to download the entire archive for each version, the
30 safest method for upgrading is to use @file{xdelta}, see
31 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/}
33 The following command produces @file{lilypond-1.1.55.tar.gz} from
34 @file{lilypond-1.1.54} identical (up to compression dates) to the .55 on
37 xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
40 @section Prerequisites
42 For compilation you need:
45 @item A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
46 (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
49 @item Lots of disk space: LilyPond takes between 30 and 100 mb to
50 compile if you use debugging information. If you are short on
51 disk-space run configure with @code{--disable-debugging}.
54 Although we recommend to use Unix, LilyPond is known to run on Windows
55 NT/95/98 as well. See Section Windows NT/95,es.
57 @item EGCS 1.1 or newer. Check out @uref{ftp://ftp.gnu.org/pub/gcc/}.
61 @uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
63 @item GUILE 1.3, check out @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
66 Check out @uref{ftp://ftp.gnu.org/make/,ftp://ftp.gnu.org/make/}.
68 @item Flex (version 2.5.4 or newer).
69 Check out @uref{ftp://ftp.gnu.org/flex/,ftp://ftp.gnu.org/flex/}.
71 @item Bison (version 1.25 or newer).
72 Check out @uref{ftp://ftp.gnu.org/bison/,ftp://ftp.gnu.org/bison/}.
74 @item Texinfo. Check out @uref{ftp://ftp.gnu.org/pub/texinfo/,ftp://ftp.gnu.org/pub/texinfo/}.
75 Most documentation is in texinfo.
77 @item The geometry package for LaTeX is needed to use ly2dvi.
79 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
80 or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
82 @item MetaPost, if you want to use direct PostScript output. Please
83 note that tetex-0.4pl8 (included with Redhat 5.x) does not include
84 @file{mfplain.mp}, which is needed for producing the scaleable font files.
90 GNU LilyPond does use a lot of resources. For operation you need the
95 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
96 recommended. Xdvi will show all embedded PostScript too if you have
97 Ghostscript installed.
98 @item GUILE 1.3, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/programs/guile.html}
101 For running LilyPond successfully you have to help TeX and MetaFont
102 find various files. The recommended way of doing so is adjusting the
103 environment variables in the start-up scripts of your shell. An
104 example is given here for the Bourne shell:
106 export MFINPUTS="/usr/local/share/lilypond/mf:"
107 export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
111 The empty path component
112 represents TeX and MetaFont's default search paths. Scripts with
113 the proper paths for the bourne and C-shell respectively are generated in
114 @file{buildscripts/out/lilypond-profile} and
115 @file{buildscripts/out/lilypond-login} during compilation.
117 LilyPond is a hiddeously big, slow and bloated program. A fast CPU
118 and plenty of RAM is recommended for comfortable use.
122 The website is the most convenient form to use for reading the
123 documentation on-line documentation. It is made by entering @example
128 This does require a fully functioning
130 If you want to auto-generate Lily's website, you'll need some additional
134 @item xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
135 users: it is included within the package libgr-progs).
137 @uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
139 @item pnmtopng, which is also in libgr-progs for RedHat. The original is
141 @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
143 The version of @file{pnmtopng} that is distributed with RedHat 5.1 and
144 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
145 version of libpng, which results in cropped images. Recompile it from
146 source, and make sure that the pnmtopng binary is linked statically to
147 the libpng that is included in libgr. RedHat 6.0 does not have this
151 tar xzf libgr-2.0.13.tar.gz
159 You can then install the new pnmtopng into @file{/usr/local/bin/}
161 @item Bib2html @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html.,http://pertsserver.cs.uiuc.edu/~hull/bib2html.}
162 Which, in turn depends on man2html for proper installation.
163 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}.
165 The website will build without this utility, but you will not see our
166 hypertextified bibliography.
168 @item Doc++ (optional) to read the source code.
172 @section configuring and compiling
174 to install GNU LilyPond, simply type:
177 gunzip -c lilypond-x.y.z | tar xf -
179 ./configure # fill in your standard prefix with --prefix
185 This will install a number of files, something close to:
188 /usr/local/man/man1/mi2mu.1
189 /usr/local/man/man1/convert-mudela.1
190 /usr/local/man/man1/mudela-book.1
191 /usr/local/man/man1/lilypond.1
192 /usr/local/bin/lilypond
194 /usr/local/bin/convert-mudela
195 /usr/local/bin/mudela-book
196 /usr/local/bin/abc2ly
197 /usr/local/share/lilypond/*
198 /usr/local/share/locale/@{it,nl@}/LC_MESSAGES/lilypond.mo
202 The above assumes that you are root and have the GNU development
203 tools, and your make is GNU make. If this is not the case, you can
204 adjust your environment variables to your taste:
208 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
213 @code{CPPFLAGS} are the preprocessor flags.
215 The configure script is Cygnus configure, and it will accept
216 @code{--help}. If you are not root, you will probably have to make it
217 with a different @code{--prefix} option. Our favourite location is
221 ./configure --prefix=$HOME/usr
225 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
227 Since GNU LilyPond currently is beta, you are advised to also use
236 Options to configure include:
239 @item @code{--enable-printing}
240 Enable debugging print routines (lilypond @code{-D} option)
241 @item @code{--enable-optimise}
242 Set maximum optimisation: compile with @code{-O2}. This can be
243 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
244 @item @code{--enable-profiling}
245 Compile with support for profiling.
246 @item @code{--enable-config}
247 Output to a different configuration file. Needed for multi-platform
251 All options are documented in the @file{configure} help
252 The option @code{--enable-optimise} is recommended for Real Life usage.
262 everything will be compiled, but nothing will be installed. The
263 resulting binaries can be found in the subdirectories @file{out/} (which
264 contain all files generated during compilation).
266 @section configuring for multiple platforms
268 If you want to compile LilyPond with different configuration settings,
269 then, you can use the @code{--enable-config} option. Example: suppose I
270 want to build with and without profiling. Then I'd use the
271 following for the normal build,
275 ./configure --prefix=~ --disable-optimise --enable-checking
281 and for the profiling version, I specify a different configuration.
285 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
287 make config=optprof install
294 if you have done a successful @code{make}, then a simple
304 If you are doing an upgrade, please remember to remove obsolete
305 @file{.pk} and @file{.tfm} files of the fonts. A script has been
306 provided to do the work for you, see @file{bin/clean-fonts.sh}.
309 @section Redhat linux
311 RedHat Linux users can compile an RPM. A spec file is in
312 @file{make/out/lilypond.spec}, it is distributed along with the
315 You can make the rpm by issuing
318 rpm -tb lilypond-x.y.z.tar.gz
319 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
323 Precompiled i386 RedHat RPMS are available from
324 @uref{ftp://freshmeat.net/pub/rpms/lilypond/,ftp://freshmeat.net/pub/rpms/lilypond/} and
325 @uref{http://linux.umbc.edu/software/lilypond/rpms/,http://linux.umbc.edu/software/lilypond/rpms/}.
327 For compilation on a RedHat system you need these packages,
328 in addition to the those needed for running:
331 @item libstdc++-devel
338 @section Debian GNU/linux
340 A Debian package is also available; contact Anthony Fok
341 @email{foka@@debian.org}. The build scripts are in the subdirectory
344 @section Windows NT/95
346 Separate instructions on building for W32 are available; See file
347 README-W32, included with the sources.
349 @c I detest the use of euphemisms, esp. for BUGS
350 @section Bugs and Problems
352 For help and questions use @email{help-gnu-music@@gnu.org} and
353 @email{gnu-music-discuss@@gnu.org}. Please consult the faq before
354 mailing your problems.
356 If you find bugs, please send bug reports to
357 @email{bug-gnu-music@@gnu.org}.
359 Known bugs that are LilyPond's fault are listed in @file{TODO}, or
360 demonstrated in @file{input/bugs/}.
362 Known bugs that are not LilyPond's fault are documented here.
364 @unnumbered All platforms
367 Guile 1.3.2 is buggy in several respects. Do not use it for LilyPond.
370 @unnumbered LinuxPPC Bugs:
373 @item R5, egcs-1.1.2-12c
374 Egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
375 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
378 All compiling with @code{-O2} is suspect, in particular guile-1.3, and
379 Lily herself will break.
384 @unnumbered Linux-i386
387 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
389 Lily will crash during parsing (which suggests a C++ library
390 incompatibility). Precise cause, precise platform description or
391 solution are not known.
393 Note that this only happens on some computers with the said platform.
396 A binary RPM of Guile 1.3 has been distributed from the LilyPond ftp
397 site. This binary was made in RedHat 5.x, and it will fail if this
398 RPM is used with RedHat 6.x.
403 LilyPond occasionally crashes while parsing the initialisation files.
404 This is a very obscure bug, and usually entering the commandline
405 differently "fixes" it.
413 lilypond -I. ./input.ly
420 __libc_malloc (bytes=16384)
422 yyFlexLexer::yy_create_buffer ()
423 Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
426 This behaviour has been observed with machines that have old libg++
427 versions (LinuxPPC feb '98, RedHat 4.x).
436 @item Sparc64/Solaris 2.6, GNU make-3.77
438 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
441 @item Sparc64/Solaris 2.6, ld
452 The following is from the gcc install/SPECIFIC file.
454 Some versions of the AIX binder (linker) can fail with a relocation
455 overflow severe error when the -bbigtoc option is used to link
456 GCC-produced object files into an executable that overflows the TOC. A
457 fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
458 -BBIGTOC) is available from IBM Customer Support and from its
459 27service.boulder.ibm.com website as PTF U455193.
461 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
462 as and GNU ld will not work properly and one should not configure GCC
463 to use those GNU utilities. Use the native AIX tools which do
464 interoperate with GCC.
467 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
469 LDFLAGS='-Wl,-bbigtoc' ./configure
477 @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}
479 @email{janneke@@gnu.org, Jan Nieuwenhuizen}
481 In case of problems, please use the mailing list for help.