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.1.55.tar.gz' from
21 `lilypond-1.1.54' identical (up to compression dates) to the .55 on the
23 xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.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/gnu/flex/ (ftp://ftp.gnu.org/gnu/flex/).
58 * Bison (version 1.25 or newer). Check out
59 ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
61 * TeX. If you want LilyPond to use kpathsea support (recommended),
62 make sure you have tetex 1.0 or newer (1.0.6 is known to work).
63 You may need to install a tetex-devel or tetex-dev package too.
65 * Texinfo (version 4.0 or newer). Check out
66 ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/texinfo/).
67 Most documentation is in texinfo.
69 * The geometry package for LaTeX is needed to use ly2dvi. Available
71 ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
72 (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
73 or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
75 * MetaPost, needed for generating PostScript fonts. Please note that
76 tetex-0.4pl8 (included with Redhat 5.x) does not include
77 `mfplain.mp', which is needed for producing the scalable font
80 If you do not want to use PostScript output, edit `mf/GNUmakefile',
81 removing the line saying `PFA_FILES='
83 * kpathsea, a library for searching (TeX) files. `kpathsea' is
84 usually included with your installation of TeX.
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, or newer. Check out
100 http://www.gnu.org/software/guile/
101 (http://www.gnu.org/programs/guile.html)
103 For running LilyPond successfully you have to help TeX and MetaFont
104 find various files. The recommended way of doing so is adjusting the
105 environment variables in the start-up scripts of your shell. Appropriate
106 Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
107 `buildscripts/out/lilypond-login' after compilation.
109 The empty path component represents TeX and MetaFont's default search
110 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 big and slow program. A fast CPU and plenty of RAM is
115 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 netpbm package: the Portable Bitmap Utilities)
131 (For RedHat Linux users: it is included within the package
132 libgr-progs). the original is at
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 (also in libgr-progs for RedHat). The original is at
137 ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
138 (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
140 The version of `pnmtopng' that is distributed with RedHat 5.1 and
141 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
144 * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
145 Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/bib2html/).
146 Bibtex2html is available in debian, while bib2html is in some rpm
147 based distributions. Bib2html, in turn depends on man2html for
148 proper installation. man2html can be had from
149 http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
150 (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
152 The website will build without bib converter utility, but you will
153 not see our hypertextified bibliography.
156 Configuring and compiling
157 =========================
159 to install GNU LilyPond, simply type:
160 gunzip -c lilypond-x.y.z | tar xf -
162 ./configure # fill in your standard prefix with --prefix
166 This will install a number of files, something close to:
168 /usr/local/man/man1/midi2ly.1
169 /usr/local/man/man1/abc2ly.1
170 /usr/local/man/man1/etf2ly.1
171 /usr/local/man/man1/convert-ly.1
172 /usr/local/man/man1/lilypond-book.1
173 /usr/local/man/man1/lilypond.1
174 /usr/local/bin/lilypond
175 /usr/local/bin/midi2ly
176 /usr/local/bin/convert-ly
177 /usr/local/bin/lilypond-book
178 /usr/local/bin/abc2ly
179 /usr/local/bin/pmx2ly
180 /usr/local/bin/musedata2ly
181 /usr/local/bin/etf2ly
182 /usr/local/share/lilypond/*
183 /usr/local/share/locale/{....}/LC_MESSAGES/lilypond.mo
185 The above assumes that you are root and have the GNU development
186 tools, and your make is GNU make. If this is not the case, you can
187 adjust your environment variables to your taste:
190 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
193 `CPPFLAGS' are the preprocessor flags.
195 The configure script is Cygnus configure, and it will accept
196 `--help'. If you are not root, you will probably have to make it with a
197 different `--prefix' option. Our favourite location is
200 ./configure --prefix=$HOME/usr
202 In this case, you will have to set up MFINPUTS, and TEXINPUTS
205 Since GNU LilyPond currently is beta, you are advised to also use
211 Options to configure include:
213 ``--enable-printing''
214 Enable debugging print routines (lilypond `-D' option)
216 ``--enable-optimise''
217 Set maximum optimisation: compile with `-O2'. This can be
218 unreliable on some compiler/platform combinations (eg, DEC Alpha
221 ``--enable-profiling''
222 Compile with support for profiling.
225 Output to a different configuration file. Needed for
226 multi-platform builds
228 All options are documented in the `configure' help The option
229 `--enable-optimise' is recommended for Real Life usage.
236 everything will be compiled, but nothing will be installed. The
237 resulting binaries can be found in the subdirectories `out/' (which
238 contain all files generated during compilation).
240 Configuring for multiple platforms
241 ==================================
243 If you want to compile LilyPond with different configuration
244 settings, then, you can use the `--enable-config' option. Example:
245 suppose I want to build with and without profiling. Then I'd use the
246 following for the normal build,
249 ./configure --prefix=~ --disable-optimise --enable-checking
253 and for the profiling version, I specify a different configuration.
256 ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
258 make config=prof install
263 if you have done a successful `make', then a simple
270 If you are doing an upgrade, please remember to remove obsolete
271 `.pk' and `.tfm' files of the fonts. A script has been provided to do
272 the work for you, see `bin/clean-fonts.sh'.
277 RedHat Linux users can compile an RPM. A spec file is in
278 `make/out/lilypond.spec', it is distributed along with the sources.
280 You can make the rpm by issuing
282 rpm -tb lilypond-x.y.z.tar.gz
283 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
285 Precompiled RedHat-7.0 i386 RPMS are available from
286 `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
288 For compilation on a RedHat system you need these packages, in
289 addition to the those needed for running:
307 A Debian package is also available; see
308 http://packages.debian.org/lilypond
309 (http://packages.debian.org/lilypond) or contact Anthony Fok
310 <foka@debian.org> for more information.
312 The build scripts are in the subdirectory `debian/'; you can make
316 tar xzf lilypond-x.y.z.tar.gz
319 dpkg -i ../lilypond_x.y.z*deb
321 For compilation on a Debian GNU/Linux system you need these packages,
322 in addition to the those needed for running:
325 * libstdc++<your-libstdc++-version-here>-dev
327 * libguile<your-libguile-version-here>-dev
344 Separate instructions on building for W32 are available; See the
345 files in `Documentation/ntweb/', included with the sources.
350 For help and questions use <help-gnu-music@gnu.org> and
351 <gnu-music-discuss@gnu.org>. Please consult the faq before mailing
354 If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
356 Bugs that are LilyPond's fault are listed in our TODO list on the
357 web, or demonstrated in `input/bugs/'.
359 Bugs that are not LilyPond's fault are documented here.
364 * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
365 fixed in egcs-1.1.2-12f or gcc-2.95-0a,
366 `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
368 * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
369 particular guile-1.3, and Lily herself will break.
374 * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
376 Lily will crash during parsing (which suggests a C++ library
377 incompatibility). Precise cause, precise platform description or
378 solution are not known.
380 Note that this only happens on some computers with the said
385 LilyPond occasionally crashes while parsing the initialisation
386 files. This is a very obscure bug, and usually entering the
387 commandline differently "fixes" it.
392 lilypond -I. ./input.ly
397 __libc_malloc (bytes=16384)
399 yyFlexLexer::yy_create_buffer ()
400 Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
402 This behaviour has been observed with machines that have old libg++
403 versions (LinuxPPC feb '98, RedHat 4.x).
408 * Sparc64/Solaris 2.6, GNU make-3.77
410 GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
413 * Sparc64/Solaris 2.6, ld
422 The following is from the gcc install/SPECIFIC file.
423 Some versions of the AIX binder (linker) can fail with a
424 relocation overflow severe error when the -bbigtoc option
425 is used to link GCC-produced object files into an
426 executable that overflows the TOC. A fix for APAR IX75823
427 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
428 available from IBM Customer Support and from its
429 27service.boulder.ibm.com website as PTF U455193.
431 Binutils does not support AIX 4.3 (at least through release
432 2.9). GNU as and GNU ld will not work properly and one
433 should not configure GCC to use those GNU utilities. Use
434 the native AIX tools which do interoperate with GCC.
436 add -Wl,-bbigtoc to USER_LDFLAGS, ie:
437 LDFLAGS='-Wl,-bbigtoc' ./configure