3 INSTALL - compiling and installing GNU LilyPond
4 ***********************************************
9 You can get the latest version of LilyPond at
10 ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
11 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
13 _If you upgrade by patching do remember to rerun autoconf after
16 If you do not want to download the entire archive for each version,
17 the safest method for upgrading is to use `xdelta', see
18 `ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
20 The following command produces `lilypond-1.3.122.tar.gz' from
21 `lilypond-1.3.121' identical (up to compression dates) to the .122 on
23 xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
28 For compilation you need:
30 * A GNU system: GNU LilyPond is known to run on these GNU systems:
31 Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
34 * Lots of disk space: LilyPond takes between 30 and 100 mb to
35 compile if you use debugging information. If you are short on
36 disk-space run configure with `--disable-debugging'.
38 * Although we recommend to use Unix, LilyPond is known to run on
39 Windows NT/95/98 as well. See Section Windows NT/95,es.
41 * A reasonable C++ compiler: EGCS 1.1, GCC 2.95.2 or newer. Check
42 out `ftp://ftp.gnu.org/gnu/gcc/'.
44 * Python 1.5, Check out `ftp://ftp.python.org' or
45 `ftp://ftp.cwi.nl/pub/python'.
47 * GUILE 1.3.4 or newer, check out
48 http://www.gnu.org/software/guile/guile.html
49 (http://www.gnu.org/software/guile/guile.html). Version 1.4 is
50 recommended for better performance.
52 * GNU Make. Check out ftp://ftp.gnu.org/gnu/make/
53 (ftp://ftp.gnu.org/gnu/make/).
55 * Flex (version 2.5.4a or newer). Check out
56 ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/
57 (ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/).
59 * Bison (version 1.25 or newer). Check out
60 ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
62 * TeX. If you want LilyPond to use kpathsea support (recommended),
63 make sure you have tetex 1.0 or newer (1.0.6 is known to work).
64 You may need to install a tetex-devel or tetex-dev package too.
66 * Texinfo (version 4.0 or newer). Check out
67 ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/texinfo/).
68 Most documentation is in texinfo.
70 * The geometry package for LaTeX is needed to use ly2dvi. Available
72 ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
73 (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
74 or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
76 * MetaPost, needed for generating PostScript fonts. Please note that
77 tetex-0.4pl8 (included with Red Hat 5.x) does not include
78 `mfplain.mp', which is needed for producing the scalable font
81 If you do not want to use PostScript output, edit `mf/GNUmakefile',
82 removing the line saying `PFA_FILES='
84 * kpathsea, a library for searching (TeX) files. `kpathsea' is
85 usually included with your installation of TeX.
91 GNU LilyPond does use a lot of resources. For operation you need the
96 * A PostScript printer and/or viewer (such as Ghostscript) is
97 strongly recommended. Xdvi will show all embedded PostScript
98 too if you have Ghostscript installed.
100 * GUILE 1.3.4, or newer. Check out
101 http://www.gnu.org/software/guile/
102 (http://www.gnu.org/programs/guile.html)
104 For running LilyPond successfully you have to help TeX and MetaFont
105 find various files. The recommended way of doing so is adjusting the
106 environment variables in the start-up scripts of your shell. Appropriate
107 Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
108 `buildscripts/out/lilypond-login' after compilation.
110 The empty path component represents TeX and MetaFont's default search
111 paths. Scripts with the proper paths for the bourne and C-shell
112 respectively are generated in `buildscripts/out/lilypond-profile' and
113 `buildscripts/out/lilypond-login' during compilation.
115 LilyPond is a big and slow program. A fast CPU and plenty of RAM is
116 recommended for comfortable use.
121 The website is the most convenient form to use for reading the
122 documentation on-line documentation. It is made by entering
125 This does require a functioning LilyPond. The binary doesn't have to
128 If you want to auto-generate Lily's website, you'll need some
129 additional conversion tools.
131 * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities)
132 (For Red Hat Linux users: it is included within the
133 package libgr-progs). The original is at
134 ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
135 (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
137 * pnmtopng (also in libgr-progs for Red Hat). The original is at
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 Red Hat 5.1 and
142 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
145 * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
146 Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/bib2html/).
147 Bibtex2html is available in debian, while bib2html is in some rpm
148 based distributions. Bib2html, in turn depends on man2html for
149 proper installation. man2html can be had from
150 http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
151 (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
153 The website will build without bib converter utility, but you will
154 not see our hypertextified bibliography.
157 Configuring and compiling
158 =========================
160 to install GNU LilyPond, simply type:
161 gunzip -c lilypond-x.y.z | tar xf -
163 ./configure # fill in your standard prefix with --prefix
167 This will install a number of files, something close to:
169 /usr/local/man/man1/midi2ly.1
170 /usr/local/man/man1/abc2ly.1
171 /usr/local/man/man1/etf2ly.1
172 /usr/local/man/man1/convert-ly.1
173 /usr/local/man/man1/lilypond-book.1
174 /usr/local/man/man1/lilypond.1
175 /usr/local/bin/lilypond
176 /usr/local/bin/midi2ly
177 /usr/local/bin/convert-ly
178 /usr/local/bin/lilypond-book
179 /usr/local/bin/abc2ly
180 /usr/local/bin/pmx2ly
181 /usr/local/bin/musedata2ly
182 /usr/local/bin/etf2ly
183 /usr/local/share/lilypond/*
184 /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo
186 The above assumes that you are root and have the GNU development
187 tools, and your make is GNU make. If this is not the case, you can
188 adjust your environment variables to your taste:
191 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
194 `CPPFLAGS' are the preprocessor flags.
196 The configure script is Cygnus configure, and it will accept
197 `--help'. If you are not root, you will probably have to make it with a
198 different `--prefix' option. Our favourite location is
201 ./configure --prefix=$HOME/usr
203 In this case, you will have to set up MFINPUTS, and TEXINPUTS
206 Since GNU LilyPond currently is beta, you are advised to also use
212 Options to configure include:
214 ``--enable-printing''
215 Enable debugging print routines (lilypond `-D' option)
217 ``--enable-optimise''
218 Set maximum optimisation: compile with `-O2'. This can be
219 unreliable on some compiler/platform combinations (eg, DEC Alpha
222 ``--enable-profiling''
223 Compile with support for profiling.
225 ``--enable-config=CONF''
226 Output to different configuration files. Enables different binary
227 builds alongside eachother, eg, multi-configuration (debugging,
228 profiling), or multi-platform builds. Use `make conf=CONF' to
229 build for a specific configuration.
231 All options are documented in the `configure' help The option
232 `--enable-optimise' is recommended for Real Life usage.
239 everything will be compiled, but nothing will be installed. The
240 resulting binaries can be found in the subdirectories `out/' (which
241 contain all files generated during compilation).
243 Configuring for multiple platforms
244 ==================================
246 If you want to build multiple versions of LilyPond with different
247 configuration settings, you can use the `--enable-config=CONF' option.
248 You should use `make conf=CONF' to generate the output in `out-CONF'.
249 Example: suppose I want to build with and without profiling. Then I'd
250 use the following for the normal build,
253 ./configure --prefix=~ --disable-optimise --enable-checking
257 and for the profiling version, I specify a different configuration.
260 ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
262 make conf=prof install
267 if you have done a successful `make', then a simple
274 If you are doing an upgrade, please remember to remove obsolete
275 `.pk' and `.tfm' files of the fonts. A script has been provided to do
276 the work for you, see `bin/clean-fonts.sh'.
281 Red Hat Linux users can compile an RPM. A spec file is in
282 `make/out/lilypond.spec'; it is distributed along with the sources.
284 You can make the rpm by issuing
286 rpm -tb lilypond-x.y.z.tar.gz
287 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
289 Precompiled Red Hat 7.0 i386 RPMS are available from
290 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
292 For compilation on a Red Hat system you need these packages, in
293 addition to the those needed for running:
311 A Debian package is also available. You may install it easily by
312 using apt-get as root:
314 apt-get install lilypond1.3
318 * http://packages.debian.org/lilypond
319 (http://packages.debian.org/lilypond)
321 * http://ftp.debian.org/debian/pool/main/l/lilypond1.3/
322 (http://ftp.debian.org/debian/pool/main/l/lilypond1.3/) for latest
323 package uploaded to Debian unstable;
325 * http://people.debian.org/~foka/lilypond/
326 (http://people.debian.org/~foka/lilypond/) for latest
327 semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2
328 (potato) users. The official stable Debian 2.2r2 is stuck with
329 the old LilyPond-1.3.24.
331 You may contact Anthony Fok <foka@debian.org> for more information.
333 The build scripts are in the subdirectory `debian/'; you can make
334 the .deb by doing, for example:
337 # dpkg --purge lilypond lilypond1.3
339 $ tar xzf lilypond-1.3.122.tar.gz
340 $ cd lilypond-1.3.122
341 $ dch -p -v 1.3.122-0.local.1 "Local build."
344 # dpkg -i ../lilypond1.3_1.3.122*.deb
348 For compilation on a Debian GNU/Linux system you need these packages,
349 in addition to the those needed for running:
351 * g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
353 * libguile<your-libguile-version-here>-dev
355 * make, m4, flex, bison
359 * groff, texinfo, bibtex2html (not in 2.2r2)
361 * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
363 * dpkg-dev, debhelper, fakeroot
365 * gs, netpbm, pnmtopng
367 Most of these are listed on the Build-Depends line in the
368 debian/control file. To ensure the creation of the lilypond deb is
369 trouble-free, we recommend that you first install the following packages
370 before starting dpkg-buildpackage by running apt-get as root.
372 For Debian 2.2 (or 2.2r2, 2.2r3):
374 apt-get install task-debian-devel task-c++-dev \
375 python-base libguile6-dev tetex-bin tetex-dev \
376 tetex-extra flex bison texinfo groff gs \
377 netpbm pnmtopng m4 gettext
379 For Debian in development ("unstable", the future 2.3 or 3.0):
381 apt-get install task-debian-devel task-c++-dev \
382 python-base libguile9-dev tetex-bin libkpathsea-dev \
383 tetex-extra flex bison texinfo bibtex2html groff gs \
384 netpbm pnmtopng m4 gettext
386 And, just so that old fonts from previous versions of LilyPond won't
387 interfere with your build, you may want to do this before the build too:
389 dpkg --purge lilypond lilypond1.3
394 Separate instructions on building for W32 are available; See the
395 files in `Documentation/ntweb/', included with the sources.
400 For help and questions use <help-gnu-music@gnu.org> and
401 <gnu-music-discuss@gnu.org>. Please consult the faq before mailing
404 If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
406 Bugs that are LilyPond's fault are listed in our TODO list on the
407 web, or demonstrated in `input/bugs/'.
409 Bugs that are not LilyPond's fault are documented here.
414 * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
415 fixed in egcs-1.1.2-12f or gcc-2.95-0a,
416 `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
418 * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
419 particular guile-1.3, and Lily herself will break.
424 * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
426 Lily will crash during parsing (which suggests a C++ library
427 incompatibility). Precise cause, precise platform description or
428 solution are not known.
430 Note that this only happens on some computers with the said
435 LilyPond occasionally crashes while parsing the initialisation
436 files. This is a very obscure bug, and usually entering the
437 commandline differently "fixes" it.
442 lilypond -I. ./input.ly
447 __libc_malloc (bytes=16384)
449 yyFlexLexer::yy_create_buffer ()
450 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
452 This behaviour has been observed with machines that have old libg++
453 versions (LinuxPPC feb '98, Red Hat 4.x).
458 * Sparc64/Solaris 2.6, GNU make-3.77
460 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
463 * Sparc64/Solaris 2.6, ld
472 The following is from the gcc install/SPECIFIC file.
473 Some versions of the AIX binder (linker) can fail with a
474 relocation overflow severe error when the -bbigtoc option
475 is used to link GCC-produced object files into an
476 executable that overflows the TOC. A fix for APAR IX75823
477 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
478 available from IBM Customer Support and from its
479 27service.boulder.ibm.com website as PTF U455193.
481 Binutils does not support AIX 4.3 (at least through release
482 2.9). GNU as and GNU ld will not work properly and one
483 should not configure GCC to use those GNU utilities. Use
484 the native AIX tools which do interoperate with GCC.
486 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
487 LDFLAGS='-Wl,-bbigtoc' ./configure