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
12 You can get the latest version of LilyPond at
13 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/,
14 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/}.
17 @emph{If you upgrade by patching do remember to rerun autoconf after
20 If you do not want to download the entire archive for each version, the
21 safest method for upgrading is to use @file{xdelta}, see
22 @uref{ftp://ftp.xcf.berkeley.edu/pub/xdelta/}.
24 The following command produces @file{lilypond-1.1.55.tar.gz} from
25 @file{lilypond-1.1.54} identical (up to compression dates) to the .55 on
28 xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
31 @section Prerequisites
33 For compilation you need:
36 @item A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
37 (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
40 @item Lots of disk space: LilyPond takes between 30 and 100 mb to
41 compile if you use debugging information. If you are short on
42 disk-space run configure with @code{--disable-debugging}.
45 Although we recommend to use Unix, LilyPond is known to run on Windows
46 NT/95/98 as well. See Section Windows NT/95,es.
48 @item EGCS 1.1 or newer. Check out @uref{ftp://ftp.gnu.org/gnu/gcc/}.
52 @uref{ftp://ftp.python.org} or @uref{ftp://ftp.cwi.nl/pub/python}.
54 @item GUILE 1.3.4 or newer, check out
55 @uref{http://www.gnu.org/software/guile/guile.html,http://www.gnu.org/software/guile/guile.html}.
56 Version 1.4 is recommended for better performance.
60 @uref{ftp://ftp.gnu.org/gnu/make/,ftp://ftp.gnu.org/gnu/make/}.
62 @item Flex (version 2.5.4a or newer).
63 Check out @uref{ftp://ftp.gnu.org/gnu/flex/,ftp://ftp.gnu.org/gnu/flex/}.
65 @item Bison (version 1.25 or newer).
66 Check out @uref{ftp://ftp.gnu.org/gnu/bison/,ftp://ftp.gnu.org/gnu/bison/}.
68 @item TeX. If you want LilyPond to use kpathsea support (recommended),
69 make sure you have tetex 1.0 or newer (1.0.6 is known to work). You may
70 need to install a tetex-devel or tetex-dev package too.
72 @item Texinfo (version 4.0 or newer).
73 Check out @uref{ftp://ftp.gnu.org/gnu/texinfo/,ftp://ftp.gnu.org/gnu/texinfo/}.
74 Most documentation is in texinfo.
76 @item The geometry package for LaTeX is needed to use ly2dvi.
78 @uref{ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry,ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry}
79 or at mirror site @uref{ftp://ftp.dante.de,ftp://ftp.dante.de}
81 @item MetaPost, needed for generating PostScript fonts. Please
82 note that tetex-0.4pl8 (included with Redhat 5.x) does not include
83 @file{mfplain.mp}, which is needed for producing the scalable font
86 If you do not want to use PostScript output, edit @file{mf/GNUmakefile},
87 removing the line saying @code{PFA_FILES=}
89 @item kpathsea, a library for searching (TeX) files. @code{kpathsea} is
90 usually included with your installation of TeX.
96 GNU LilyPond does use a lot of resources. For operation you need the
101 @item A PostScript printer and/or viewer (such as Ghostscript) is strongly
102 recommended. Xdvi will show all embedded PostScript too if you have
103 Ghostscript installed.
104 @item GUILE 1.3.4, check out @uref{http://www.gnu.org/programs/guile.html,http://www.gnu.org/software/guile/}
107 For running LilyPond successfully you have to help TeX and MetaFont find
108 various files. The recommended way of doing so is adjusting the
109 environment variables in the start-up scripts of your shell. Appropriate
110 Csh and sh scripts are left in @file{buildscripts/out/lilypond-profile}
111 and @file{buildscripts/out/lilypond-login} after compilation.
113 The empty path component represents TeX and MetaFont's default search
114 paths. Scripts with the proper paths for the bourne and C-shell
115 respectively are generated in @file{buildscripts/out/lilypond-profile}
116 and @file{buildscripts/out/lilypond-login} during compilation.
118 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
119 recommended for comfortable use.
123 The website is the most convenient form to use for reading the
124 documentation on-line documentation. It is made by entering @example
129 This does require a functioning LilyPond. The binary doesn't have to
132 If you want to auto-generate Lily's website, you'll need some additional
136 @item xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
137 users: it is included within the package libgr-progs).
139 @uref{ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz,ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz}
141 @item pnmtopng, which is also in libgr-progs for RedHat. The original is
143 @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
145 The version of @file{pnmtopng} that is distributed with RedHat 5.1 and
146 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
149 @item @uref{http://pertsserver.cs.uiuc.edu/~hull/bib2html,Bib2html}.
150 Which, in turn depends on man2html for proper installation.
151 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}.
153 The website will build without this utility, but you will not see our
154 hypertextified bibliography.
158 @section Configuring and compiling
160 to install GNU LilyPond, simply type:
162 gunzip -c lilypond-x.y.z | tar xf -
164 ./configure # fill in your standard prefix with --prefix
169 This will install a number of files, something close to:
172 /usr/local/man/man1/midi2ly.1
173 /usr/local/man/man1/abc2ly.1
174 /usr/local/man/man1/etf2ly.1
175 /usr/local/man/man1/convert-mudela.1
176 /usr/local/man/man1/mudela-book.1
177 /usr/local/man/man1/lilypond.1
178 /usr/local/bin/lilypond
179 /usr/local/bin/midi2ly
180 /usr/local/bin/convert-mudela
181 /usr/local/bin/mudela-book
182 /usr/local/bin/abc2ly
183 /usr/local/bin/etf2ly
184 /usr/local/share/lilypond/*
185 /usr/local/share/locale/@{....@}/LC_MESSAGES/lilypond.mo
189 The above assumes that you are root and have the GNU development
190 tools, and your make is GNU make. If this is not the case, you can
191 adjust your environment variables to your taste:
195 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
200 @code{CPPFLAGS} are the preprocessor flags.
202 The configure script is Cygnus configure, and it will accept
203 @code{--help}. If you are not root, you will probably have to make it
204 with a different @code{--prefix} option. Our favourite location is
208 ./configure --prefix=$HOME/usr
212 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
214 Since GNU LilyPond currently is beta, you are advised to also use
223 Options to configure include:
226 @item @code{--enable-printing}
227 Enable debugging print routines (lilypond @code{-D} option)
228 @item @code{--enable-optimise}
229 Set maximum optimisation: compile with @code{-O2}. This can be
230 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
231 @item @code{--enable-profiling}
232 Compile with support for profiling.
233 @item @code{--enable-config}
234 Output to a different configuration file. Needed for multi-platform
238 All options are documented in the @file{configure} help
239 The option @code{--enable-optimise} is recommended for Real Life usage.
249 everything will be compiled, but nothing will be installed. The
250 resulting binaries can be found in the subdirectories @file{out/} (which
251 contain all files generated during compilation).
253 @section Configuring for multiple platforms
255 If you want to compile LilyPond with different configuration settings,
256 then, you can use the @code{--enable-config} option. Example: suppose I
257 want to build with and without profiling. Then I'd use the
258 following for the normal build,
262 ./configure --prefix=~ --disable-optimise --enable-checking
268 and for the profiling version, I specify a different configuration.
272 ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
274 make config=prof install
281 if you have done a successful @code{make}, then a simple
291 If you are doing an upgrade, please remember to remove obsolete
292 @file{.pk} and @file{.tfm} files of the fonts. A script has been
293 provided to do the work for you, see @file{bin/clean-fonts.sh}.
296 @section Redhat linux
298 RedHat Linux users can compile an RPM. A spec file is in
299 @file{make/out/lilypond.spec}, it is distributed along with the
302 You can make the rpm by issuing
305 rpm -tb lilypond-x.y.z.tar.gz
306 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
310 Precompiled i386 RedHat RPMS are available from
311 @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/}.
313 For compilation on a RedHat system you need these packages,
314 in addition to the those needed for running:
317 @item libstdc++-devel
325 @section Debian GNU/linux
327 A Debian package is also available; see
328 @uref{http://packages.debian.org/lilypond,http://packages.debian.org/lilypond}
329 or contact Anthony Fok @email{foka@@debian.org} for more information.
331 The build scripts are in the subdirectory @file{debian/}; you can
332 make the .deb by doing
336 tar xzf lilypond-x.y.z.tar.gz
339 dpkg -i ../lilypond_x.y.z*deb
343 For compilation on a Debian GNU/Linux system you need these packages,
344 in addition to the those needed for running:
347 @item libstdc++<your-libstdc++-version-here>-dev
348 @item libguile<your-libguile-version-here>-dev
358 @section Windows NT/95
360 Separate instructions on building for W32 are available; See the files
361 in @file{Documentation/ntweb/}, included with the sources.
365 For help and questions use @email{help-gnu-music@@gnu.org} and
366 @email{gnu-music-discuss@@gnu.org}. Please consult the faq before
367 mailing your problems.
369 If you find bugs, please send bug reports to
370 @email{bug-gnu-music@@gnu.org}.
372 Bugs that are LilyPond's fault are listed in our TODO list on the
373 web, or demonstrated in @file{input/bugs/}.
375 Bugs that are not LilyPond's fault are documented here.
378 @unnumbered LinuxPPC Bugs:
381 @item egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
382 fixed in egcs-1.1.2-12f or gcc-2.95-0a, @uref{ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/}
384 @item egcs-1.0.2 (LinuxPPC R4):
385 all compiling with @code{-O2} is suspect, in particular guile-1.3, and
386 Lily herself will break.
391 @unnumbered Linux-i386
394 @item SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
396 Lily will crash during parsing (which suggests a C++ library
397 incompatibility). Precise cause, precise platform description or
398 solution are not known.
400 Note that this only happens on some computers with the said platform.
404 LilyPond occasionally crashes while parsing the initialisation files.
405 This is a very obscure bug, and usually entering the commandline
406 differently "fixes" it.
414 lilypond -I. ./input.ly
421 __libc_malloc (bytes=16384)
423 yyFlexLexer::yy_create_buffer ()
424 Includable_lexer::new_input (this=0x8209a00, s=@{strh_ = @{
427 This behaviour has been observed with machines that have old libg++
428 versions (LinuxPPC feb '98, RedHat 4.x).
437 @item Sparc64/Solaris 2.6, GNU make-3.77
439 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or newer.
442 @item Sparc64/Solaris 2.6, ld
453 The following is from the gcc install/SPECIFIC file.
455 Some versions of the AIX binder (linker) can fail with a relocation
456 overflow severe error when the -bbigtoc option is used to link
457 GCC-produced object files into an executable that overflows the TOC. A
458 fix for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND
459 -BBIGTOC) is available from IBM Customer Support and from its
460 27service.boulder.ibm.com website as PTF U455193.
462 Binutils does not support AIX 4.3 (at least through release 2.9). GNU
463 as and GNU ld will not work properly and one should not configure GCC
464 to use those GNU utilities. Use the native AIX tools which do
465 interoperate with GCC.
468 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
470 LDFLAGS='-Wl,-bbigtoc' ./configure