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.4, check out
57 http://www.gnu.org/software/guile/guile.html
58 (http://www.gnu.org/software/guile/guile.html).
60 * GNU make. Check out ftp://ftp.gnu.org/make/
61 (ftp://ftp.gnu.org/make/).
63 * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
64 (ftp://ftp.gnu.org/flex/).
66 * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
67 (ftp://ftp.gnu.org/bison/).
69 * Texinfo (version 4.0 or newer). Check out
70 ftp://ftp.gnu.org/pub/texinfo/ (ftp://ftp.gnu.org/pub/texinfo/).
71 Most documentation is in texinfo.
73 * The geometry package for LaTeX is needed to use ly2dvi. Available
75 ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
76 (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
77 or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
79 * MetaPost, needed for generating PostScript fonts. Please note that
80 tetex-0.4pl8 (included with Redhat 5.x) does not include
81 `mfplain.mp', which is needed for producing the scalable font
84 If you do not want to use PostScript output, edit `mf/GNUmakefile'.
90 GNU LilyPond does use a lot of resources. For operation you need the
95 * A PostScript printer and/or viewer (such as Ghostscript) is
96 strongly recommended. Xdvi will show all embedded PostScript
97 too if you have Ghostscript installed.
99 * GUILE 1.3.4, check out http://www.gnu.org/software/guile/
100 (http://www.gnu.org/programs/guile.html)
102 For running LilyPond successfully you have to help TeX and MetaFont
103 find various files. The recommended way of doing so is adjusting the
104 environment variables in the start-up scripts of your shell. An
105 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:"
109 The empty path component represents TeX and MetaFont's default
110 search paths. Scripts with the proper paths for the bourne and C-shell
111 respectively are generated in `buildscripts/out/lilypond-profile' and
112 `buildscripts/out/lilypond-login' during compilation.
114 LilyPond is a hiddeously big, slow and bloated program. A fast CPU
115 and plenty of RAM is recommended for comfortable use.
120 The website is the most convenient form to use for reading the
121 documentation on-line documentation. It is made by entering
124 This does require a functioning LilyPond. The binary doesn't have
127 If you want to auto-generate Lily's website, you'll need some
128 additional conversion tools.
130 * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
131 users: it is included within the package libgr-progs).
133 ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
134 (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
136 * pnmtopng, which is also in libgr-progs for RedHat. The original is
138 ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
139 (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
141 The version of `pnmtopng' that is distributed with RedHat 5.1 and
142 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
143 version of libpng, which results in cropped images. Recompile it
144 from source, and make sure that the pnmtopng binary is linked
145 statically to the libpng that is included in libgr. RedHat 6.0
146 does not have this problem.
148 tar xzf libgr-2.0.13.tar.gz
154 You can then install the new pnmtopng into `/usr/local/bin/'
156 * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
157 (http://pertsserver.cs.uiuc.edu/~hull/bib2html.) Which, in
158 turn depends on man2html for proper installation. man2html can be
160 http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
161 (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
163 The website will build without this utility, but you will not see
164 our hypertextified bibliography.
166 * Doc++ (optional) to read the source code.
169 Configuring and compiling
170 =========================
172 to install GNU LilyPond, simply type:
174 gunzip -c lilypond-x.y.z | tar xf -
176 ./configure # fill in your standard prefix with --prefix
180 This will install a number of files, something close to:
182 /usr/local/man/man1/mi2mu.1
183 /usr/local/man/man1/convert-mudela.1
184 /usr/local/man/man1/mudela-book.1
185 /usr/local/man/man1/lilypond.1
186 /usr/local/bin/lilypond
188 /usr/local/bin/convert-mudela
189 /usr/local/bin/mudela-book
190 /usr/local/bin/abc2ly
191 /usr/local/share/lilypond/*
192 /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
194 The above assumes that you are root and have the GNU development
195 tools, and your make is GNU make. If this is not the case, you can
196 adjust your environment variables to your taste:
199 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
202 `CPPFLAGS' are the preprocessor flags.
204 The configure script is Cygnus configure, and it will accept
205 `--help'. If you are not root, you will probably have to make it with a
206 different `--prefix' option. Our favourite location is
209 ./configure --prefix=$HOME/usr
211 In this case, you will have to set up MFINPUTS, and TEXINPUTS
214 Since GNU LilyPond currently is beta, you are advised to also use
220 Options to configure include:
222 ``--enable-printing''
223 Enable debugging print routines (lilypond `-D' option)
225 ``--enable-optimise''
226 Set maximum optimisation: compile with `-O2'. This can be
227 unreliable on some compiler/platform combinations (eg, DEC Alpha
230 ``--enable-profiling''
231 Compile with support for profiling.
234 Output to a different configuration file. Needed for
235 multi-platform builds
237 All options are documented in the `configure' help The option
238 `--enable-optimise' is recommended for Real Life usage.
245 everything will be compiled, but nothing will be installed. The
246 resulting binaries can be found in the subdirectories `out/' (which
247 contain all files generated during compilation).
249 Configuring for multiple platforms
250 ==================================
252 If you want to compile LilyPond with different configuration
253 settings, then, you can use the `--enable-config' option. Example:
254 suppose I want to build with and without profiling. Then I'd use the
255 following for the normal build,
258 ./configure --prefix=~ --disable-optimise --enable-checking
262 and for the profiling version, I specify a different configuration.
265 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
267 make config=optprof install
272 if you have done a successful `make', then a simple
279 If you are doing an upgrade, please remember to remove obsolete
280 `.pk' and `.tfm' files of the fonts. A script has been provided to do
281 the work for you, see `bin/clean-fonts.sh'.
286 RedHat Linux users can compile an RPM. A spec file is in
287 `make/out/lilypond.spec', it is distributed along with the sources.
289 You can make the rpm by issuing
291 rpm -tb lilypond-x.y.z.tar.gz
292 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
294 Precompiled i386 RedHat RPMS are available from
295 ftp://freshmeat.net/pub/rpms/lilypond/
296 (ftp://freshmeat.net/pub/rpms/lilypond/) and
297 http://linux.umbc.edu/software/lilypond/rpms/
298 (http://linux.umbc.edu/software/lilypond/rpms/).
300 For compilation on a RedHat system you need these packages, in
301 addition to the those needed for running:
317 A Debian package is also available; contact Anthony Fok
318 <foka@debian.org>. The build scripts are in the subdirectory `debian/'.
323 Separate instructions on building for W32 are available; See the
324 files in `Documentation/ntweb/', included with the sources.
329 For help and questions use <help-gnu-music@gnu.org> and
330 <gnu-music-discuss@gnu.org>. Please consult the faq before mailing
333 If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
335 Known bugs that are LilyPond's fault are listed in `TODO', or
336 demonstrated in `input/bugs/'.
338 Known bugs that are not LilyPond's fault are documented here.
343 * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
344 fixed in egcs-1.1.2-12f or gcc-2.95-0a,
345 `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
347 * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
348 particular guile-1.3, and Lily herself will break.
353 * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
355 Lily will crash during parsing (which suggests a C++ library
356 incompatibility). Precise cause, precise platform description or
357 solution are not known.
359 Note that this only happens on some computers with the said
364 LilyPond occasionally crashes while parsing the initialisation
365 files. This is a very obscure bug, and usually entering the
366 commandline differently "fixes" it.
371 lilypond -I. ./input.ly
376 __libc_malloc (bytes=16384)
378 yyFlexLexer::yy_create_buffer ()
379 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
381 This behaviour has been observed with machines that have old libg++
382 versions (LinuxPPC feb '98, RedHat 4.x).
387 * Sparc64/Solaris 2.6, GNU make-3.77
389 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
392 * Sparc64/Solaris 2.6, ld
401 The following is from the gcc install/SPECIFIC file.
402 Some versions of the AIX binder (linker) can fail with a
403 relocation overflow severe error when the -bbigtoc option
404 is used to link GCC-produced object files into an
405 executable that overflows the TOC. A fix for APAR IX75823
406 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
407 available from IBM Customer Support and from its
408 27service.boulder.ibm.com website as PTF U455193.
410 Binutils does not support AIX 4.3 (at least through release
411 2.9). GNU as and GNU ld will not work properly and one
412 should not configure GCC to use those GNU utilities. Use
413 the native AIX tools which do interoperate with GCC.
415 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
416 LDFLAGS='-Wl,-bbigtoc' ./configure