1 article(INSTALL - compiling and installing GNU LilyPond)(HWN & JCN)()
5 This document explains what you need to install LilyPond, and what you
6 should do. If you are going to compile and install LilyPond often,
7 e.g. when doing development, you might want to check out the
8 file(buildscripts/set-lily.sh) script. It sets some environment
9 variables and symlinks, which comes in handly when you have to compile
14 You can get the latest version of LilyPond at
15 lurl(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/). Refer to the links
16 document for mirror sites.
18 em(If you upgrade by patching do remember to rerun autoconf after
23 For compilation you need:
26 it()A GNU system: GNU LilyPond is known to run on these GNU systems: Linux
27 (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and
30 it()Lots of disk space: LilyPond takes between 30 and 100 mb to
31 compile if you use debugging information. If you are short on
32 disk-space run configure with code(--disable-debugging).
34 Although we recommend to use Unix, LilyPond is known to run on Windows
35 NT/95/98 as well. See Section ref(w32).
37 it() EGCS 1.1 or newer.
41 lurl(ftp://ftp.python.org) or lurl(ftp://ftp.cwi.nl/pub/python).
43 it() GUILE 1.3, check out lurl(http://www.gnu.org/software/guile/guile.html).
46 Check out lurl(ftp://ftp.gnu.org).
48 it()Flex (version 2.5.4 or newer).
49 Check out lurl(ftp://ftp.gnu.org).
51 it()Bison (version 1.25 or newer).
52 Check out lurl(ftp://ftp.gnu.org).
54 it()Yodl. All documentation will be in Yodl. (1.30.17)
55 lurl(ftp://ftp.lilypond.org/pub/yodl)
57 it()The geometry package for LaTeX is needed to use ly2dvi.
59 lurl(ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
60 or at mirror site lurl(ftp://ftp.dante.de)
62 it()MetaPost, if you want to use direct PostScript output. Please
63 note that tetex-0.4pl8 (included with Redhat 5.x) does not include
64 file(mfplain.mp), which is needed for producing the scaleable font files.
70 GNU LilyPond does use a lot of resources. For operation you need the
75 it()A PostScript printer and/or viewer (such as Ghostscript) is strongly
76 recommended. Xdvi will show all embedded PostScript too if you have
77 Ghostscript installed.
78 it() GUILE 1.3, check out lurl(http://www.gnu.org/programs/guile.html)
82 For running LilyPond successfully you have to help TeX and MetaFont
83 find various files. The recommended way of doing so is adjusting the
84 environment variables in the start-up scripts of your shell. An
85 example is given here for the Bourne shell:
86 verb(export MFINPUTS="/usr/local/share/lilypond/mf:"
87 export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
89 The empty path component
90 represents TeX() and MetaFont's default search paths. Scripts with
91 the proper paths for the bourne and C-shell respectively are generated in
92 file(buildscripts/out/lilypond-profile) and
93 file(buildscripts/out/lilypond-login) during compilation.
95 LilyPond is a hideously slow program. A fast CPU and plenty of RAM is
96 recommended for comfortable use.
101 If you want to auto-generate Lily's website, you'll need some additional
105 it()xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
106 users: it is included within the package libgr-progs).
108 lurl(ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
110 it()pnmtopng, which is also in libgr-progs for RedHat. The original is
112 lurl(ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
114 The version of file(pnmtopng) that is distributed with RedHat 5.1 and
115 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
116 version of libpng. Recompile it from source, and make sure that the
117 pnmtopng binary is linked statically to the libpng that is included in
118 libgr. RedHat 6.0 does not have this problem.
120 verb( tar xzf libgr-2.0.13.tar.gz
127 You can then install the new pnmtopng into file(/usr/local/bin/)
129 it()Bib2html lurl(http://pertsserver.cs.uiuc.edu/~hull/bib2html.)
130 Which, in turn depends on man2html for proper installation.
131 man2html can be had from lurl(http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
133 The website will build without this utility, but you will not see our
134 hypertextified bibliography.
136 TeTeX users should not forget to rerun texhash.
139 You also have to install file(buildscripts/out/ps-to-gifs) in a
140 directory that is in the path.
143 sect(CONFIGURING and COMPILING)
145 to install GNU LilyPond, simply type:
147 gunzip -c lilypond-x.y.z | tar xf -
149 ./configure # fill in your standard prefix with --prefix
154 This will install a number of files, something close to:
156 /usr/local/man/man1/mi2mu.1
157 /usr/local/man/man1/convert-mudela.1
158 /usr/local/man/man1/mudela-book.1
159 /usr/local/man/man1/lilypond.1
160 /usr/local/bin/lilypond
162 /usr/local/share/lilypond/*
163 /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
167 The above assumes that you are root and have the GNU development
168 tools, and your make is GNU make. If this is not the case, you can
169 adjust your environment variables to your taste:
172 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
176 code(CPPFLAGS) are the preprocessor flags.
178 The configure script is Cygnus configure, and it will accept
179 bf(--help). If you are not root, you will probably have to make it
180 with a different bf(--prefix) option. Our favourite location is
183 ./configure --prefix=$HOME/usr
186 In this case, you will have to set up MFINPUTS, and TEXINPUTS accordingly.
188 Since GNU LilyPond currently is beta, you are advised to also use
195 Options to configure include:
198 dit(bf(--enable-printing))
199 Enable debugging print routines (lilypond bf(-D) option)
200 dit(bf(--enable-optimise))
201 Set maximum optimisation: compile with bf(-O2). This can be
202 unreliable on some compiler/platform combinations (eg, DEC Alpha and PPC)
203 dit(bf(--enable-profiling))
204 Compile with support for profiling.
205 dit(bf(--enable-config))
206 Output to a different configuration file. Needed for multi-platform
210 All options are documented in the file(configure) help
211 The option bf(--enable-optimise) is recommended for Real Life usage.
219 everything will be compiled, but nothing will be installed. The
220 resulting binaries can be found in the subdirectories file(out/) (which
221 contain all files generated during compilation).
223 sect(CONFIGURING FOR MULTIPLE PLATFORMS)
225 If you want to compile LilyPond with different configuration settings,
226 then, you can use the bf(--enable-config) option. Example: suppose I
227 want to build with and without profiling. Then I'd use the
228 following for the normal build,
231 ./configure --prefix=~ --disable-optimise --enable-checking
236 and for the profiling version, I specify a different configuration.
239 ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
241 make config=optprof install
247 If you have done a successful code(make), then a simple
255 If you are doing an upgrade, please remember to remove obsolete
256 file(.pk) and file(.tfm) files of the fonts. A script has been
257 provided to do the work for you, see file(bin/clean-fonts.sh).
262 it()The -O2 option triggers bugs on various platforms (PowerPC, Alpha).
263 If you experience problems, you should first try turning off
265 it() On PPC you need at least EGCS-1.1.2f.
270 This is what I type in my xterm:
273 lilypond someinput.ly
278 This is what the output looks like over here:
281 GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
282 Parsing ... [/home/hw/share/lilypond/init//
284 init//performer.ly]]][input/kortjakje.ly]
285 Creating elements ...[8][16][24][25]
286 Preprocessing elements...
287 Calculating column positions ... [14][25]
288 Postprocessing elements...
289 TeX output to someinput.tex ...
290 Creating MIDI elements ...MIDI output to someinput.midi ...
293 hw:~/musix/spacer$ xdvi someinput&
297 Check out the input files, some of them have comments
298 Please refer to the man page for more information.
302 RedHat Linux users can compile an RPM. A spec file is in
303 file(make/out/lilypond.spec), it is distributed along with the
306 You can make the rpm by issuing
308 rpm -tb lilypond-x.y.z.tar.gz
309 rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
312 Precompiled i386 RedHat RPMS are available from
313 lurl(http://linux.umbc.edu/software/lilypond/rpms/).
317 sect(DEBIAN GNU/LINUX)
319 A Debian package is also available; contact Anthony Fok
320 email(foka@debian.org). The build scripts are in the subdirectory
328 Separate instructions on building for W32 are avaible
329 url(in the file README-W32.yo)(../../DOEXPAND(outdir)/README-W32.html).
333 nemail(Han-Wen Nienhuys)(hanwen@cs.uu.nl)
335 nemail(Jan Nieuwenhuizen)(janneke@gnu.org)