2 TITLE INFORMATION: INSTALL - compiling and installing GNU LilyPond
3 AUTHOR INFORMATION: HWN & JCN
12 6: CONFIGURING and COMPILING
13 7: CONFIGURING FOR MULTIPLE PLATFORMS
22 You do something which looks remotely like
24 configure # Check out the buildscripts/set-lily.sh script
28 The detailed instructions follow here. The
29 buildscripts/set-lily.sh script sets some environment variables
30 and symlinks, which comes in handly when you have to compile LilyPond
31 very often. It is aimed at people who run (or debug) LilyPond without
36 For compilation you need:
38 o A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
39 (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
42 o Lots of disk space: LilyPond takes between 50 and 100 mb to
43 compile if you use debugging information. If you are short on
44 disk-space run configure with --disable-debugging.
46 Although we recommend to use Unix, LilyPond is known to run on Windows
47 NT/95/98 as well. See Section [w32].
49 o GNU C++ version 2.7 or newer (2.8 and egcs are also fine).
50 o Python 1.5 (Strictly speaking, you shouldn't need Python for
51 compiling and installing, but you'll need it to regenerate the font
56 GNU LilyPond does use a lot of resources. For operation you need the following:
59 o A PostScript printer and/or viewer (such as Ghostscript) is strongly
60 recommended. Xdvi will show all embedded PostScript too if you have
61 Ghostscript installed.
65 Although not strictly necessary, these are recommended to have.
68 Check out ftp://ftp.gnu.org
69 or any mirror of this site.
71 o Flex (version 2.5.4 or newer).
72 Check out ftp://ftp.gnu.org
73 or any mirror of this site.
74 o Bison (version 1.25 or newer).
75 Check out ftp://ftp.gnu.org
76 or any mirror of this site.
78 o Python (version 1.5 or newer). Check out
79 ftp://ftp.python.org or ftp://ftp.cwi.nl/pub/python.
81 o Yodl. All documentation will be in Yodl. (1.30.17)
82 ftp://pcnov095.win.tue.nl/pub/yodl
83 http://www.cs.uu.nl/~hanwen/yodl
84 o Texinfo. (version 3.12 or newer)
87 Check out ftp://ftp.gnu.org
88 or any mirror of this site.
90 o The geometry package for LaTeX is needed to use ly2dvi.
92 ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
93 or at mirror site ftp://ftp.dante.de
95 o A fast computer (a full page of music typically takes 1 minute on my
96 486/133, using the --enable-checking compile. It's lot slower than
97 most MusiXTeX preprocessors)
101 If you want to auto-generate Lily's website, you'll need some additional
104 o xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
105 users: it is included within the package libgr-progs).
106 o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
107 Which, in turn depends on man2html for proper installation.
108 man2html can be had from http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05.
110 TeTeX users should not forget to rerun texhash.
112 6: CONFIGURING and COMPILING
114 to install GNU LilyPond, simply type:
116 configure --enable-tex-dir=XXXX --enable-mf-dir=YYYY
120 This will install a number of files, something close to:
122 /usr/local/man/man1/mi2mu.1
123 /usr/local/man/man1/convert-mudela.1
124 /usr/local/man/man1/mudela-book.1
125 /usr/local/man/man1/lilypond.1
126 /usr/local/bin/lilypond
128 /usr/local/share/lilypond/*
129 /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
130 /usr/lib/texmf/texmf/tex/lilypond/*
132 You should specify directories that are in TeX's and MetaFont's
133 include path with the options (--enable-tex-dir) and
134 --enable-mf-dir. If you don't specify any directories, the TeX
135 include directory is detected dynamically, which is unreliable. The
136 above assumes that you are root and have the GNU development tools,
137 and your make is GNU make. If this is not the case, you can adjust
138 your environment variables to your taste:
140 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
143 CPPFLAGS are the preprocessor flags.
145 The configure script is Cygnus configure, and it will accept
146 --help. If you are not root, you will probably have to make it
147 with a different --prefix option. Our favourite location is
149 configure --prefix=$HOME/usr
151 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
153 If you want to install GNU LilyPond in /usr/local, and your TeX has
154 no default hooks for local stuff, you can do:
156 configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
158 Since GNU LilyPond currently is beta, you are advised to also use
163 Other options include:
166 Make a shared library (gnu/linux, solaris (?) only ) (TEMPORARILY
170 Enable debugging print routines (lilypond -D option)
172 Set maximum optimisation: compile with -O2
174 Compile with support for profiling.
175 o --enable-tex-prefix
176 Set the directory where TeX and Metafont live.
178 Set then directory TeX input is in (detected as a subdir of
179 tex-prefix). This should be a directory that is reachable both for
180 tex and latex. On my system the best choice would be
181 /usr/lib/texmf/texmf/tex/generic//.
183 Set the directory metafont input is in (idem). On my system the best
184 choice would be /usr/lib/texmf/texmf/fonts/source/public/.
186 Output to a different configuration file. Needed for multi-platform
189 All options are documented in the configure help
190 The option --enable-optimise is recommended for Real Life usage.
196 everything will be compiled, but nothing will be installed. The
197 resulting binaries can be found in the subdirectories out/ (which
198 contain all files generated during compilation).
200 7: CONFIGURING FOR MULTIPLE PLATFORMS
202 If you want to compile LilyPond with different configuration settings,
203 then, you can use the --enable-config option. Example: suppose I
204 want to build with and without profiling. Then I'd use the
205 following for the normal build,
207 configure --prefix=~ --disable-optimise --enable-checking
211 and for the profiling version, I specify a different configuration.
213 configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
215 make config=optprof install
219 If you have done a successful make, then a simple
225 If you are doing an upgrade, please remember to remove obsolete
226 .pk and .tfm files of the fonts. A script has been
227 provided to do the work for you, see bin/clean-fonts.sh.
231 o The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You
232 should turn off this flag for this file.
236 This is what I type in my xterm:
238 lilypond someinput.ly
242 This is what the output looks like over here:
244 GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
245 Parsing ... [/home/hw/share/lilypond/init//
247 init//performer.ly]]][input/kortjakje.ly]
248 Creating elements ...[8][16][24][25]
249 Preprocessing elements...
250 Calculating column positions ... [14][25]
251 Postprocessing elements...
252 TeX output to someinput.tex ...
253 Creating MIDI elements ...MIDI output to someinput.midi ...
255 hw:~/musix/spacer$ xdvi someinput&
258 Check out the input files, some of them have comments
259 Please refer to the man page for more information.
263 RedHat Linux users can compile an RPM. A spec file is in
264 make/out/lilypond.spec. You should install a gif file called
265 lelie_icon.gif along with the sources. You can generate this
270 in the directory Documentation.
272 You can make the rpm by issuing
278 A Debian package is also available; contact Anthony Fok
279 <foka@debian.org>. The build scripts are in the subdirectory debian/
283 Separate instructions on building for W32 are avaible
284 in the file README-W32.yo.
288 Han-Wen Nienhuys <hanwen@cs.uu.nl>
290 Jan Nieuwenhuizen <janneke@gnu.org>