3 INSTALL - installing GNU LilyPond
7 This page documents installation and compilation of GNU LilyPond
11 You do something which looks remotely like
17 The detailed instructions follow here.
21 For compilation you need.
27 A GNU system: GNU LilyPond is known to run on these GNU systems:
28 Linux, FreeBSD, AIX, Digital Unix and Solaris.
30 If you have the Cygnus WINDOWS32 port of the GNU utils, it will even
31 work in Windows NT/95, but we don't promise to support it.
35 GNU C++ v2.7 or better, with libg++ installed. Version 2.7.2
36 or better recommended.
44 Flex (2.5.1 or better).
48 Bison. (Version 1.25 or better)
54 GNU LilyPond does use a lot of resources. For operation you need the following:
65 A PostScript printer and/or viewer (such as Ghostscript) is strongly
66 recommended. Xdvi will show all embedded PostScript too if you have
67 Ghostscript installed.
74 Although not strictly necessary, these are recommended to have.
80 Perl-5. Most documentation was created with the perl's Plain Old
81 Documentation. (I use 5.003)
85 Python. Although perl is nice, python is better. We will shift
86 towards python for build scripts
94 A fast computer (a full page of music typically takes 1 minute on my
95 486/133, using the B<--enable-checking> compile. It's lot slower than
96 most MusiXTeX preprocessors)
101 =head1 CONFIGURING and COMPILING
103 to install GNU LilyPond, simply type:
108 This will install the following files:
110 /usr/local/man/man1/mi2mu.1
111 /usr/local/man/man1/convert-mudela.1
112 /usr/local/man/man1/mudela-book.1
113 /usr/local/man/man1/lilypond.1
114 /usr/local/lib/libflower.{so,a}
115 /usr/local/bin/lilypond
117 /usr/local/share/lilypond/*
118 /usr/lib/texmf/texmf/tex/lilypond/*
120 The TeX include directory is detected dynamically, but it can be
121 adjusted with B<--enable-tex-prefix> and B<--enable-tex-dir>. The
122 above assumes that you are root and have the GNU development tools,
123 and your make is GNU make. If this is not the case, you can adjust
124 your environment variables to your taste:
126 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
129 C<CPPFLAGS> are the preprocessor flags.
131 the configure script is Cygnus configure, and it will accept
132 B<--help>. If you are not root, you will probably have to make it with
134 configure --prefix=/home/me_myself_and_I/
136 In this case, you will have to set MFINPUTS, and TEXINPUTS accordingly.
138 If you want to install GNU LilyPond in F</usr/local>, and your TeX has
139 no default hooks for local stuff (mine is broken too), you can do:
141 configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
143 Since GNU LilyPond currently is beta, you are advised to also use
148 other options include:
152 =item B<--enable-shared>
154 Make a shared library (gnu/linux, solaris (?) only )
156 =item B<--enable-printing>
158 Enable debugging print routines (lilypond B<-d> option)
160 =item B<--enable-optimise>
162 Set maximum optimisation: compile with B<-O2>
164 =item B<--enable-profiling>
166 Compile with support for profiling
168 =item B<--enable-tex-prefix>
170 Set the directory where TeX and Metafont live
172 =item B<--enable-tex-dir>
174 Set then directory TeX input is in (detected as a subdir of tex-prefix)
176 =item B<--enable-mf-dir>
178 Set the directory mf input is in (idem)
180 =item B<--enable-out-dir>
182 Set the directory for machine generated output.
186 All options are documented in the F<configure> help
187 The option B<--enable-optimise> is recommended for Real Life usage.
193 everything will be compiled, but nothing will be installed. The
194 resulting binaries can be found in the subdirectories F<out/> (which
195 contain all files generated during compilation).
197 =head2 Building for multiple hosts
199 LilyPond does not follow the GNU standards when it comes to
200 configuring and making Makefiles. In LilyPond, F<make> generates I<all>
201 output in output directories (called F<out/>, by default).
202 You can have multiple compiles from the same source-tree, by
203 overriding the setting for the output directory.
205 Example: on my system, I do debugging and lots compiling. For this I
206 use the configuration as follows:
208 configure --prefix=~ --enable-debugging --enable-printing --enable-checking
211 and I want to do profiling. For that I use
213 configure --prefix=~ --enable-debugging --disable-printing\
214 --disable-checking --enable-profiling --enable-optimise\
215 --enable-out-dir=out-profile
217 make OUTDIR_NAME=out-profile all
219 These two commands build two entirely separate versions of
220 LilyPond. In Real Life, you would probably also want to have two
221 different prefixes. On my machine this is no problem; I never do
222 C<make install>. My prefix dirs are linked back to my source directory.
227 If you have done a successful C<make>, then a simple
233 If you are doing an upgrade, please remember to remove obsolete .pk
234 and .tfm files of the fonts. A script has been provided to do the
235 work, see F<bin/clean-fonts.sh>.
243 The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You
244 should turn off this flag for this file.
248 Perl5.003 and Perl5.004 use different syntax for pod2html.
254 This is what I type in my xterm:
256 lilypond someinput.ly
260 This is what the output looks like over here:
262 GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0
263 Parsing ... [/home/hw/share/lilypond/init//
265 init//performer.ly]]][input/kortjakje.ly]
266 Creating elements ...[8][16][24][25]
267 Preprocessing elements...
268 Calculating column positions ... [14][25]
269 Postprocessing elements...
270 TeX output to someinput.tex ...
271 Creating MIDI elements ...MIDI output to someinput.midi ...
274 hw:~/musix/spacer$ xdvi someinput&
277 Check out the input files, some of them have comments
278 Please refer to the man page for more information.
282 RedHat Linux users should be able to get a RPM. A spec file is in
283 F<make/out/lilypond.spec>. You should be able to create an rpm as a
284 normal user. Be sure you have a F<~/.rpmrc>, and edit the RPM-dir in
285 F<Variables.make>. (If you create the RPM as a normal user the
286 permissions will not be set correctly, unfortunately)
289 =head1 DEBIAN GNU/LINUX
291 A Debian package is also available; contact Anthony Fok
292 <foka@debian.org>. The build scripts are in the subdirectory debian/
297 So, you're stuck with Windows, eh? Well, don't worry, you just
298 need (to get) Cygnus' windows32 port of gnu development stuff;
299 have a look at http://www.cygnus.com/gnu-win32.
301 To make GNU LilyPond under, brr, aargh, shudder... windows32, well,
307 B<Note> If you rely on broken DOS/Windows tools such as pkzip/WinZIP
308 to unpack the distribution, make sure the B<entire> source tree
309 is unpacked correctly, in particular the empty out directories
310 (F<flower/out>, F<lib/out> et. al.)
314 Previous versions (before 0.1.39) used fonts from the TeX macro
315 package "MusixTeX". You can still use these, but they are not
316 supported. Since LilyPond's Feta font is much prettier, you'd be
317 seriously misguided if you used them, but anyway, here are the
318 installation instructions for those deprecated fonts.
321 [obsolete] I use the MusixTeX fonts those found in MusixTeX
322 T.73. Beware, the clef symbol seems to have changed its position in
323 some versions, (notably Egler's, a.k.a. OpusTeX). The MusixTeX fonts
324 are included in MusixTeX (T73 or better), which can be had from any
329 =item ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin
331 =item ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin
333 =item ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin
337 You only need the contents of the F<mf/> subdirectory of the
338 package. The primary site of the Taupin version is
339 ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip
341 Install the musixtex fonts in a directory which TeX and MF knows (if
342 you are root, look for a directory which contains the directories with
343 AMS and CM source (*.mf) files. Create a subdir lilypond or musixtex
344 and copy the fonts into that). Do not forget to rehash TeX (if
347 Example: my fonts are in F</usr/local/lib/texfonts/musixtex/>, and I
348 have a symlink pointing to that in
349 F</usr/lib/texmf/texmf/fonts/source/public/>. After I copied the
350 files, I ran "texhash"
352 Andreas Egler's version of MusixTeX, now called OpusTeX, will also
353 work. Andreas moved some characters around in the fonts, so you have
354 to edit the definitions in F<tex/eglerdefs.tex>.
360 Han-Wen Nienhuys <hanwen@stack.nl>
362 Jan Nieuwenhuizen <jan@digicash.com>