3 INSTALL - installing GNU LilyPond
7 This page documents installation and compilation of GNU LilyPond
11 For compilation you need.
17 A Unix system with GNU tools. GNU LilyPond is known to run on these
18 unices: Linux, AIX, Digital Unix and Solaris.
20 If you have the Cygnus WINDOWS32 port of the GNU utils, it will even
21 work in Windows NT/95, but don't promise to support it.
25 GNU C++ v2.7 or better, with libg++ installed. Version 2.7.2
26 or better recommended.
34 Flex (2.5.1 or better).
38 Bison. (Version 1.25 or better)
44 GNU LilyPond does use a lot of resources. For operation you need the following:
55 The MusixTeX fonts (I included those found in MusixTeX T.73). Beware,
56 the clef symbol seems to have changed its position in some versions,
57 (notably Egler's, a.k.a. OpusTeX). The MusixTeX fonts are included in
58 MusixTeX (T73 or better), which can be had from any CTAN site, e.g. at
62 =item ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin
64 =item ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin
66 =item ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin
70 You only need the contents of the F<mf/> subdirectory of the
71 package. The primary site of the Taupin version is
72 ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip
76 Although not strictly necessary, these are recommended to have.
82 Perl. Most scripts are written in Perl. The documentation was created
83 with the perl's Plain Old Documentation.
91 A fast computer (a full page of music typically takes 1 minute
92 on my 486/133, using the B<--enable-checking> compile. It's lot slower
93 than most MusiXTeX preprocessors)
98 =head1 CONFIGURING and COMPILING
100 to install GNU LilyPond, simply type:
105 This will install the following files:
107 /usr/local/man/man1/mi2mu.1
108 /usr/local/man/man5/mudela.5
109 /usr/local/man/man1/lilypond.1
110 /usr/local/lib/libflower.{so,a}
111 /usr/local/bin/lilypond
113 /usr/local/share/lilypond/*
114 /usr/lib/texmf/texmf/tex/lilypond/*
116 The TeX include directory is detected dynamically, but it can be
117 adjusted with B<--enable-tex-prefix> and B<--enable-tex-dir>. The
118 above assumes that you are root and have the gnu development tools,
119 and your make is gnu make. If this is not the case, you can adjust
120 your environment variables to your taste:
122 export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
125 C<CPPFLAGS> are the preprocessor flags.
127 the configure script is Cygnus configure, and it will accept
128 B<--help>. If you are not root, you will probably have to make it with
130 configure --prefix=/home/me_myself_and_I/
132 In this case, you will have to set MFINPUTS, and TEXINPUTS accordingly.
134 If you want to install GNU LilyPond in F</usr/local>, and your TeX has
135 no default hooks for local stuff (mine is broken too), you can do:
137 configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
139 Since GNU LilyPond currently is beta, you are advised to also use
144 other options include:
148 =item --enable-shared
150 Make a shared library (gnu/linux, solaris (?) only )
152 =item --enable-printing
154 Enable debugging print routines (lilypond B<-d> option)
156 =item --enable-optimise
158 Set maximum optimisation
160 =item --enable-profiling
162 Compile with support for profiling
164 =item --enable-tex-prefix
166 Set the directory where texmf lives
168 =item --enable-tex-dir
170 Set then directory tex input is in (detected as a subdir of tex-prefix)
172 =item --enable-mf-dir
174 Set then directory mf input is in (idem)
178 All options are documented in the F<configure> help
179 The option B<--enable-optimise> is recommended for Real Life usage.
185 everything will be compiled, but nothing will be installed. The
186 resulting binaries can be found in the subdirectories F<out/> (which
187 contain all files generated during compilation).
192 If you have done a successful C<make>, then a simple
198 Install the musixtex fonts in a directory which TeX and MF knows (if
199 you are root, look for a directory which contains the directories with
200 AMS and CM source (*.mf) files. Create a subdir lilypond or musixtex
201 and copy the fonts into that). Do not forget to rehash TeX (if
204 Example: my fonts are in F</usr/local/lib/texfonts/musixtex/>, and I
205 have a symlink pointing to that in
206 F</usr/lib/texmf/texmf/fonts/source/public/>. After I copied the
207 files, I ran "texhash"
217 The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You
218 should turn off this flag for this file.
224 This is what I type in my xterm:
226 lilypond someinput.ly
230 This is what the output looks like over here:
232 hw:~/musix/spacer$ lilypond input/kortjakje.ly
233 GNU LilyPond 0.0.71 #20/FlowerLib 1.1.20 #0
234 Parsing ... [/home/hw/share/lilypond/init//symbol.ini <..snip..>
235 .. .ini]][input/kortjakje.ly]
236 Creating elements ...
237 Preprocessing elements...
238 Calculating column positions ... [3][8][13][17][21][25]
239 Postprocessing elements...
240 TeX output to lelie.tex ...
242 hw:~/musix/spacer$ tex lelie
243 This is TeX, Version 3.14159 (C version 6.1)
245 Hyphenation patterns for english, dutch, german, loaded.
246 (/home/hw/lib/texmf/tex/lilypond/lilyponddefs.tex) [1] )
247 Output written on lelie.dvi (1 page, 8944 bytes).
248 Transcript written on lelie.log.
250 hw:~/musix/spacer$ xdvi lelie&
253 Check out the input files, some of them have comments
254 Please refer to the man page for more information.
258 RedHat Linux users should be able to get a RPM. A spec file is in
259 F<make/out/lilypond.spec>. You should be able to create an rpm as a normal
260 user. Be sure you have a ~/.rpmrc, and edit the RPM-dir in
261 F<Variables.make>. (If you create the RPM as a normal user the
262 permissions will not be set correctly, unfortunately)
269 you need the cygnus windows32 gnu port development stuff; have a look
270 at http://www.cygnus.com/gnu-win32.
272 to make GNU LilyPond under, brr, aargh, well, simply type:
279 Han-Wen Nienhuys <hanwen@stack.nl>
281 Jan Nieuwenhuizen <jan@digicash.com>