=head1 NAME INSTALL - installing GNU LilyPond =head1 DESCRIPTION This page documents installation and compilation of GNU LilyPond =head1 ABSTRACT You do something which looks remotely like configure make make install The detailed instructions follow here. =head1 PREREQUISITES For compilation you need. =over 5 =item * A GNU system: GNU LilyPond is known to run on these GNU systems: Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix and Solaris. If you have the Cygnus WINDOWS32 port of the GNU utils, it will even work in Windows NT/95, but we don't promise to support it. =item * GNU C++ v2.7 or better. =item * GNU make. =item * Flex (2.5.1 or better). =item * Bison. (Version 1.25 or better) =back =head1 RUNNING GNU LilyPond does use a lot of resources. For operation you need the following: =over 5 =item * TeX =item * A PostScript printer and/or viewer (such as Ghostscript) is strongly recommended. Xdvi will show all embedded PostScript too if you have Ghostscript installed. =back =head1 RECOMMENDED Although not strictly necessary, these are recommended to have. =over 5 =item * Perl-5. Most documentation was created with the perl's Plain Old Documentation. (I use 5.003) =item * Python. Although perl is nice, python is better. We will shift towards python for build scripts =item * GNU find =item * A fast computer (a full page of music typically takes 1 minute on my 486/133, using the B<--enable-checking> compile. It's lot slower than most MusiXTeX preprocessors) =back =head1 CONFIGURING and COMPILING to install GNU LilyPond, simply type: configure make install This will install the following files: /usr/local/man/man1/mi2mu.1 /usr/local/man/man1/convert-mudela.1 /usr/local/man/man1/mudela-book.1 /usr/local/man/man1/lilypond.1 /usr/local/lib/libflower.{so,a} /usr/local/bin/lilypond /usr/local/bin/mi2mu /usr/local/share/lilypond/* /usr/lib/texmf/texmf/tex/lilypond/* The TeX include directory is detected dynamically, but it can be adjusted with B<--enable-tex-prefix> and B<--enable-tex-dir>. The above assumes that you are root and have the GNU development tools, and your make is GNU make. If this is not the case, you can adjust your environment variables to your taste: export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR" configure C are the preprocessor flags. the configure script is Cygnus configure, and it will accept B<--help>. If you are not root, you will probably have to make it with configure --prefix=/home/me_myself_and_I/ In this case, you will have to set MFINPUTS, and TEXINPUTS accordingly. If you want to install GNU LilyPond in F, and your TeX has no default hooks for local stuff (mine is broken too), you can do: configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf Since GNU LilyPond currently is beta, you are advised to also use --enable-debugging --enable-checking other options include: =over 4 =item B<--enable-shared> Make a shared library (gnu/linux, solaris (?) only ) =item B<--enable-printing> Enable debugging print routines (lilypond B<-d> option) =item B<--enable-optimise> Set maximum optimisation: compile with B<-O2> =item B<--enable-profiling> Compile with support for profiling =item B<--enable-tex-prefix> Set the directory where TeX and Metafont live =item B<--enable-tex-dir> Set then directory TeX input is in (detected as a subdir of tex-prefix) =item B<--enable-mf-dir> Set the directory mf input is in (idem) =item B<--enable-out-dir> Set the directory for machine generated output. =back All options are documented in the F help The option B<--enable-optimise> is recommended for Real Life usage. If you do make all everything will be compiled, but nothing will be installed. The resulting binaries can be found in the subdirectories F (which contain all files generated during compilation). =head2 Building for multiple hosts LilyPond does not follow the GNU standards when it comes to configuring and making Makefiles. In LilyPond, F generates I output in output directories (called F, by default). You can have multiple compiles from the same source-tree, by overriding the setting for the output directory. Example: on my system, I do debugging and lots compiling. For this I use the configuration as follows: configure --prefix=~ --enable-debugging --enable-printing --enable-checking make all and I want to do profiling. For that I use configure --prefix=~ --enable-debugging --disable-printing\ --disable-checking --enable-profiling --enable-optimise\ --enable-out-dir=out-profile make OUTDIR_NAME=out-profile all These two commands build two entirely separate versions of LilyPond. In Real Life, you would probably also want to have two different prefixes. On my machine this is no problem; I never do C. My prefix dirs are linked back to my source directory. =head1 INSTALLING If you have done a successful C, then a simple make install should do the trick. If you are doing an upgrade, please remember to remove obsolete .pk and .tfm files of the fonts. A script has been provided to do the work, see F. =head1 CAVEATS =over 5 =item * The -O2 option to gcc triggers a gcc bug on DEC Alpha in dstream.cc. You should turn off this flag for this file. =item * Perl5.003 and Perl5.004 use different syntax for pod2html. =back =head1 EXAMPLE This is what I type in my xterm: lilypond someinput.ly tex someinput.tex xdvi someinput& This is what the output looks like over here: GNU LilyPond 0.0.78 #4/FlowerLib 1.1.24 #0 Parsing ... [/home/hw/share/lilypond/init// <..etc..> init//performer.ly]]][input/kortjakje.ly] Creating elements ...[8][16][24][25] Preprocessing elements... Calculating column positions ... [14][25] Postprocessing elements... TeX output to someinput.tex ... Creating MIDI elements ...MIDI output to someinput.midi ... hw:~/musix/spacer$ xdvi someinput& [1] 855 Check out the input files, some of them have comments Please refer to the man page for more information. =head1 REDHAT LINUX RedHat Linux users should be able to get a RPM. A spec file is in F. You should be able to create an rpm as a normal user. Be sure you have a F<~/.rpmrc>, and edit the RPM-dir in F. (If you create the RPM as a normal user the permissions will not be set correctly, unfortunately) =head1 DEBIAN GNU/LINUX A Debian package is also available; contact Anthony Fok . The build scripts are in the subdirectory debian/ =head1 WINDOWS NT/95 So, you're stuck with Windows, eh? Well, don't worry, you just need (to get) Cygnus' windows32 port of gnu development stuff; have a look at http://www.cygnus.com/gnu-win32. To make GNU LilyPond under, brr, aargh, shudder... windows32, well, simply type: bash configure make B If you rely on broken DOS/Windows tools such as pkzip/WinZIP to unpack the distribution, make sure the B source tree is unpacked correctly, in particular the empty out directories (F, F et. al.) =head1 MUSIXTEX Previous versions (before 0.1.39) used fonts from the TeX macro package "MusixTeX". You can still use these, but they are not supported. Since LilyPond's Feta font is much prettier, you'd be seriously misguided if you used them, but anyway, here are the installation instructions for those deprecated fonts. [obsolete] I use the MusixTeX fonts those found in MusixTeX T.73. Beware, the clef symbol seems to have changed its position in some versions, (notably Egler's, a.k.a. OpusTeX). The MusixTeX fonts are included in MusixTeX (T73 or better), which can be had from any CTAN site, e.g. at =over 4 =item ftp://ftp.shsu.edu/tex-archive/macros/musixtex/taupin =item ftp://ftp.tex.ac.uk/tex-archive/macros/musixtex/taupin =item ftp://ftp.dante.de/tex-archive/macros/musixtex/taupin =back You only need the contents of the F subdirectory of the package. The primary site of the Taupin version is ftp://hprib.lps.u-psud.fr/pub/music_zips/musixtex.zip Install the musixtex fonts in a directory which TeX and MF knows (if you are root, look for a directory which contains the directories with AMS and CM source (*.mf) files. Create a subdir lilypond or musixtex and copy the fonts into that). Do not forget to rehash TeX (if applicable) Example: my fonts are in F, and I have a symlink pointing to that in F. After I copied the files, I ran "texhash" Andreas Egler's version of MusixTeX, now called OpusTeX, will also work. Andreas moved some characters around in the fonts, so you have to edit the definitions in F. =head1 AUTHORS Han-Wen Nienhuys Jan Nieuwenhuizen Have fun!