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/>. Refer to the links document for
23 _If you upgrade by patching do remember to rerun autoconf after
29 For compilation you need:
31 * A GNU system: GNU LilyPond is known to run on these GNU systems:
32 Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
35 * Lots of disk space: LilyPond takes between 30 and 100 mb to
36 compile if you use debugging information. If you are short on
37 disk-space run configure with `--disable-debugging'.
39 Although we recommend to use Unix, LilyPond is known to run on
40 Windows NT/95/98 as well. See Section *Note w32::.
42 * EGCS 1.1 or newer. Check out < ftp://ftp.gnu.org/pub/gcc/>
44 * Python 1.5, Check out <ftp://ftp.python.org> or
45 <ftp://ftp.cwi.nl/pub/python>.
47 * GUILE 1.3, check out
48 <http://www.gnu.org/software/guile/guile.html>.
50 * GNU make. Check out <ftp://ftp.gnu.org/make/>.
52 * Flex (version 2.5.4 or newer). Check out
53 <ftp://ftp.gnu.org/flex/>.
55 * Bison (version 1.25 or newer). Check out
56 <ftp://ftp.gnu.org/bison/>.
58 * Texinfo. Check out <ftp://ftp.gnu.org/pub/texinfo/>. Most
59 documentation is in texinfo.
61 * Yodl. Needed for obsolete docs (1.31.17)
62 <ftp://ftp.lilypond.org/pub/yodl>.
64 * The geometry package for LaTeX is needed to use ly2dvi. Available
66 <ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry>
67 or at mirror site <ftp://ftp.dante.de>
69 * MetaPost, if you want to use direct PostScript output. Please note
70 that tetex-0.4pl8 (included with Redhat 5.x) does not include
71 `mfplain.mp', which is needed for producing the scaleable font
78 GNU LilyPond does use a lot of resources. For operation you need the
83 * A PostScript printer and/or viewer (such as Ghostscript) is
84 strongly recommended. Xdvi will show all embedded PostScript
85 too if you have Ghostscript installed.
87 * GUILE 1.3, check out <http://www.gnu.org/programs/guile.html>
89 For running LilyPond successfully you have to help TeX and MetaFont
90 find various files. The recommended way of doing so is adjusting the
91 environment variables in the start-up scripts of your shell. An
92 example is given here for the Bourne shell:
93 export MFINPUTS="/usr/local/share/lilypond/mf:"
94 export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
96 The empty path component represents TeX and MetaFont's default
97 search paths. Scripts with the proper paths for the bourne and C-shell
98 respectively are generated in `buildscripts/out/lilypond-profile' and
99 `buildscripts/out/lilypond-login' during compilation.
101 LilyPond is a hiddeously big, slow and bloated program. A fast CPU
102 and plenty of RAM is recommended for comfortable use.
107 The website is the most convenient form to use for reading the
108 documentation on-line documentation. It is made by entering
111 This does require a fully functioning
113 If you want to auto-generate Lily's website, you'll need some
114 additional conversion tools.
116 * YODL 1.31.15 or later.
118 * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
119 users: it is included within the package libgr-progs).
121 <ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz>
123 * pnmtopng, which is also in libgr-progs for RedHat. The original is
125 <ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz>.i
127 The version of `pnmtopng' that is distributed with RedHat 5.1 and
128 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
129 version of libpng, which results in cropped images. Recompile it
130 from source, and make sure that the pnmtopng binary is linked
131 statically to the libpng that is included in libgr. RedHat 6.0
132 does not have this problem.
134 tar xzf libgr-2.0.13.tar.gz
140 You can then install the new pnmtopng into `/usr/local/bin/'
142 * Bib2html <http://pertsserver.cs.uiuc.edu/~hull/bib2html.>
143 Which, in turn depends on man2html for proper installation.
144 man2html can be had from
145 <http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05>.
147 The website will build without this utility, but you will not see
148 our hypertextified bibliography.
150 * Doc++ (optional) to read the source code.
153 You also have to install `buildscripts/out/ps-to-gifs' in a
154 directory that is in the path.
156 CONFIGURING and COMPILING
157 =========================
159 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/mi2mu.1
170 /usr/local/man/man1/convert-mudela.1
171 /usr/local/man/man1/mudela-book.1
172 /usr/local/man/man1/lilypond.1
173 /usr/local/bin/lilypond
175 /usr/local/share/lilypond/*
176 /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
178 The above assumes that you are root and have the GNU development
179 tools, and your make is GNU make. If this is not the case, you can
180 adjust your environment variables to your taste:
183 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
186 `CPPFLAGS' are the preprocessor flags.
188 The configure script is Cygnus configure, and it will accept
189 *-help*. If you are not root, you will probably have to make it with a
190 different *-prefix* option. Our favourite location is
193 ./configure --prefix=$HOME/usr
195 In this case, you will have to set up MFINPUTS, and TEXINPUTS
198 Since GNU LilyPond currently is beta, you are advised to also use
204 Options to configure include:
206 `*--enable-printing*'
207 Enable debugging print routines (lilypond *-D* option)
209 `*--enable-optimise*'
210 Set maximum optimisation: compile with *-O2*. This can be
211 unreliable on some compiler/platform combinations (eg, DEC Alpha
214 `*--enable-profiling*'
215 Compile with support for profiling.
218 Output to a different configuration file. Needed for
219 multi-platform builds
221 All options are documented in the `configure' help The option
222 *-enable-optimise* is recommended for Real Life usage.
229 everything will be compiled, but nothing will be installed. The
230 resulting binaries can be found in the subdirectories `out/' (which
231 contain all files generated during compilation).
233 CONFIGURING FOR MULTIPLE PLATFORMS
234 ==================================
236 If you want to compile LilyPond with different configuration
237 settings, then, you can use the *-enable-config* option. Example:
238 suppose I want to build with and without profiling. Then I'd use the
239 following for the normal build,
242 ./configure --prefix=~ --disable-optimise --enable-checking
246 and for the profiling version, I specify a different configuration.
249 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
251 make config=optprof install
256 If you have done a successful `make', then a simple
263 If you are doing an upgrade, please remember to remove obsolete
264 `.pk' and `.tfm' files of the fonts. A script has been provided to do
265 the work for you, see `bin/clean-fonts.sh'.
270 * The -O2 option triggers bugs on various platforms (PowerPC,
271 Alpha). If you experience problems, you should first try
274 * On PPC you need at least EGCS-1.1.2f.
279 RedHat Linux users can compile an RPM. A spec file is in
280 `make/out/lilypond.spec', it is distributed along with the sources.
282 You can make the rpm by issuing
284 rpm -tb lilypond-x.y.z.tar.gz
285 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
287 Precompiled i386 RedHat RPMS are available from
288 <ftp://freshmeat.net/pub/rpms/lilypond/> and
289 <http://linux.umbc.edu/software/lilypond/rpms/>.
291 For compilation on a RedHat system you need these packages, in
292 addition to the thoes needed for running:
306 A Debian package is also available; contact Anthony Fok
307 <foka@debian.org>. The build scripts are in the subdirectory `debian/'.
312 Separate instructions on building for W32 are available
313 <../../outdir/README-W32.html>.
318 Send bug reports to bug-gnu-music@gnu.org. For help and questions
319 use help-gnu-music@gnu.org and gnu-music-discuss@gnu.org. Please
320 consult the faq before mailing your problems.
325 Han-Wen Nienhuys <hanwen@cs.uu.nl>
327 Jan Nieuwenhuizen <janneke@gnu.org>
329 In case of problems, please use the mailing list for help.