3 INSTALL - compiling and installing GNU LilyPond
4 ***********************************************
9 This document explains what you need to install LilyPond, and what
10 you should do. If you are going to compile and install LilyPond often,
11 e.g. when doing development, you might want to check out the
12 `buildscripts/set-lily.sh' script. It sets some environment variables
13 and symlinks, which comes in handly when you have to compile LilyPond
19 You can get the latest version of LilyPond at
20 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
21 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
23 _If you upgrade by patching do remember to rerun autoconf after
26 If you do not want to download the entire archive for each version,
27 the safest method for upgrading is to use `xdelta', see
28 `ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
30 The following command produces `lilypond-1.1.55.tar.gz' from
31 `lilypond-1.1.54' identical (up to compression dates) to the .55 on the
33 xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
38 For compilation you need:
40 * A GNU system: GNU LilyPond is known to run on these GNU systems:
41 Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
44 * Lots of disk space: LilyPond takes between 30 and 100 mb to
45 compile if you use debugging information. If you are short on
46 disk-space run configure with `--disable-debugging'.
48 * Although we recommend to use Unix, LilyPond is known to run on
49 Windows NT/95/98 as well. See Section Windows NT/95,es.
51 * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
53 * Python 1.5, Check out `ftp://ftp.python.org' or
54 `ftp://ftp.cwi.nl/pub/python'.
56 * GUILE 1.3, check out http://www.gnu.org/software/guile/guile.html
57 (http://www.gnu.org/software/guile/guile.html).
59 * GNU make. Check out ftp://ftp.gnu.org/make/
60 (ftp://ftp.gnu.org/make/).
62 * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
63 (ftp://ftp.gnu.org/flex/).
65 * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
66 (ftp://ftp.gnu.org/bison/).
68 * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
69 (ftp://ftp.gnu.org/pub/texinfo/). Most documentation is in
72 * The geometry package for LaTeX is needed to use ly2dvi. Available
74 ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
75 (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
76 or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
78 * MetaPost, if you want to use direct PostScript output. Please note
79 that tetex-0.4pl8 (included with Redhat 5.x) does not include
80 `mfplain.mp', which is needed for producing the scaleable font
87 GNU LilyPond does use a lot of resources. For operation you need the
92 * A PostScript printer and/or viewer (such as Ghostscript) is
93 strongly recommended. Xdvi will show all embedded PostScript
94 too if you have Ghostscript installed.
96 * GUILE 1.3, check out http://www.gnu.org/software/guile/
97 (http://www.gnu.org/programs/guile.html)
99 For running LilyPond successfully you have to help TeX and MetaFont
100 find various files. The recommended way of doing so is adjusting the
101 environment variables in the start-up scripts of your shell. An
102 example is given here for the Bourne shell:
103 export MFINPUTS="/usr/local/share/lilypond/mf:"
104 export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
106 The empty path component represents TeX and MetaFont's default
107 search paths. Scripts with the proper paths for the bourne and C-shell
108 respectively are generated in `buildscripts/out/lilypond-profile' and
109 `buildscripts/out/lilypond-login' during compilation.
111 LilyPond is a hiddeously big, slow and bloated program. A fast CPU
112 and plenty of RAM is recommended for comfortable use.
117 The website is the most convenient form to use for reading the
118 documentation on-line documentation. It is made by entering
121 This does require a fully functioning
123 If you want to auto-generate Lily's website, you'll need some
124 additional conversion tools.
126 * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
127 users: it is included within the package libgr-progs).
129 ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
130 (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
132 * pnmtopng, which is also in libgr-progs for RedHat. The original is
134 ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
135 (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
137 The version of `pnmtopng' that is distributed with RedHat 5.1 and
138 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
139 version of libpng, which results in cropped images. Recompile it
140 from source, and make sure that the pnmtopng binary is linked
141 statically to the libpng that is included in libgr. RedHat 6.0
142 does not have this problem.
144 tar xzf libgr-2.0.13.tar.gz
150 You can then install the new pnmtopng into `/usr/local/bin/'
152 * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
153 (http://pertsserver.cs.uiuc.edu/~hull/bib2html.) Which, in
154 turn depends on man2html for proper installation. man2html can be
156 http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
157 (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
159 The website will build without this utility, but you will not see
160 our hypertextified bibliography.
162 * Doc++ (optional) to read the source code.
165 Configuring and compiling
166 =========================
168 to install GNU LilyPond, simply type:
170 gunzip -c lilypond-x.y.z | tar xf -
172 ./configure # fill in your standard prefix with --prefix
176 This will install a number of files, something close to:
178 /usr/local/man/man1/mi2mu.1
179 /usr/local/man/man1/convert-mudela.1
180 /usr/local/man/man1/mudela-book.1
181 /usr/local/man/man1/lilypond.1
182 /usr/local/bin/lilypond
184 /usr/local/bin/convert-mudela
185 /usr/local/bin/mudela-book
186 /usr/local/bin/abc2ly
187 /usr/local/share/lilypond/*
188 /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
190 The above assumes that you are root and have the GNU development
191 tools, and your make is GNU make. If this is not the case, you can
192 adjust your environment variables to your taste:
195 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
198 `CPPFLAGS' are the preprocessor flags.
200 The configure script is Cygnus configure, and it will accept
201 `--help'. If you are not root, you will probably have to make it with a
202 different `--prefix' option. Our favourite location is
205 ./configure --prefix=$HOME/usr
207 In this case, you will have to set up MFINPUTS, and TEXINPUTS
210 Since GNU LilyPond currently is beta, you are advised to also use
216 Options to configure include:
218 ``--enable-printing''
219 Enable debugging print routines (lilypond `-D' option)
221 ``--enable-optimise''
222 Set maximum optimisation: compile with `-O2'. This can be
223 unreliable on some compiler/platform combinations (eg, DEC Alpha
226 ``--enable-profiling''
227 Compile with support for profiling.
230 Output to a different configuration file. Needed for
231 multi-platform builds
233 All options are documented in the `configure' help The option
234 `--enable-optimise' is recommended for Real Life usage.
241 everything will be compiled, but nothing will be installed. The
242 resulting binaries can be found in the subdirectories `out/' (which
243 contain all files generated during compilation).
245 Configuring for multiple platforms
246 ==================================
248 If you want to compile LilyPond with different configuration
249 settings, then, you can use the `--enable-config' option. Example:
250 suppose I want to build with and without profiling. Then I'd use the
251 following for the normal build,
254 ./configure --prefix=~ --disable-optimise --enable-checking
258 and for the profiling version, I specify a different configuration.
261 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
263 make config=optprof install
268 if you have done a successful `make', then a simple
275 If you are doing an upgrade, please remember to remove obsolete
276 `.pk' and `.tfm' files of the fonts. A script has been provided to do
277 the work for you, see `bin/clean-fonts.sh'.
282 RedHat Linux users can compile an RPM. A spec file is in
283 `make/out/lilypond.spec', it is distributed along with the sources.
285 You can make the rpm by issuing
287 rpm -tb lilypond-x.y.z.tar.gz
288 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
290 Precompiled i386 RedHat RPMS are available from
291 ftp://freshmeat.net/pub/rpms/lilypond/
292 (ftp://freshmeat.net/pub/rpms/lilypond/) and
293 http://linux.umbc.edu/software/lilypond/rpms/
294 (http://linux.umbc.edu/software/lilypond/rpms/).
296 For compilation on a RedHat system you need these packages, in
297 addition to the those needed for running:
313 A Debian package is also available; contact Anthony Fok
314 <foka@debian.org>. The build scripts are in the subdirectory `debian/'.
319 Separate instructions on building for W32 are available; See the
320 files in `Documentation/ntweb/', included with the sources.
325 For help and questions use <help-gnu-music@gnu.org> and
326 <gnu-music-discuss@gnu.org>. Please consult the faq before mailing
329 If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
331 Known bugs that are LilyPond's fault are listed in `TODO', or
332 demonstrated in `input/bugs/'.
334 Known bugs that are not LilyPond's fault are documented here.
339 * Guile 1.3.2 is buggy in several respects. Do not use it for
345 * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
346 fixed in egcs-1.1.2-12f or gcc-2.95-0a,
347 `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
349 * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
350 particular guile-1.3, and Lily herself will break.
355 * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
357 Lily will crash during parsing (which suggests a C++ library
358 incompatibility). Precise cause, precise platform description or
359 solution are not known.
361 Note that this only happens on some computers with the said
364 * GUILE A binary RPM of Guile 1.3 has been distributed from the
365 LilyPond ftp site. This binary was made in RedHat 5.x, and it
366 will fail if this RPM is used with RedHat 6.x.
370 LilyPond occasionally crashes while parsing the initialisation
371 files. This is a very obscure bug, and usually entering the
372 commandline differently "fixes" it.
377 lilypond -I. ./input.ly
382 __libc_malloc (bytes=16384)
384 yyFlexLexer::yy_create_buffer ()
385 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
387 This behaviour has been observed with machines that have old libg++
388 versions (LinuxPPC feb '98, RedHat 4.x).
393 * Sparc64/Solaris 2.6, GNU make-3.77
395 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
398 * Sparc64/Solaris 2.6, ld
407 The following is from the gcc install/SPECIFIC file.
408 Some versions of the AIX binder (linker) can fail with a
409 relocation overflow severe error when the -bbigtoc option
410 is used to link GCC-produced object files into an
411 executable that overflows the TOC. A fix for APAR IX75823
412 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
413 available from IBM Customer Support and from its
414 27service.boulder.ibm.com website as PTF U455193.
416 Binutils does not support AIX 4.3 (at least through release
417 2.9). GNU as and GNU ld will not work properly and one
418 should not configure GCC to use those GNU utilities. Use
419 the native AIX tools which do interoperate with GCC.
421 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
422 LDFLAGS='-Wl,-bbigtoc' ./configure