-INSTALL(1) LilyPond documentation INSTALL(1)
-NAME
- INSTALL - installing GNU LilyPond
-DESCRIPTION
- This page documents installation and compilation of GNU
- LilyPond
-ABSTRACT
- You do something which looks remotely like
- configure
- make
- make install
- The detailed instructions follow here.
+ INSTALL - compiling and installing GNU LilyPond
-PREREQUISITES
- For compilation you need.
+ HWN & JCN
- o 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.
+Contents
- o GNU C++ version 2.7 or newer (yes, 2.8 is fine).
+ 1: ABSTRACT
+2: PREREQUISITES
+3: RUNNING
+4: RECOMMENDED
+5: WEBSITE
+6: CONFIGURING and COMPILING
+7: CONFIGURING FOR MULTIPLE PLATFORMS
+8: INSTALLING
+9: REDHAT LINUX
+10: DEBIAN GNU/LINUX
+11: WINDOWS NT/95
+12: AUTHORS
- o Python
-RUNNING
- GNU LilyPond does use a lot of resources. For operation
- you need the following:
+1: ABSTRACT
- o TeX
- o A PostScript printer and/or viewer (such as
- Ghostscript) is strongly recommended. Xdvi will show
- all embedded PostScript too if you have Ghostscript
- installed.
+This document explains what you need to install LilyPond,
+and what you should do. If you are going to compile and
+install LilyPond very often you might want to check out the
+buildscripts/set-lily.sh script. It sets some environment
+variables and symlinks, which comes in handly when you have
+to compile LilyPond more often.
-RECOMMENDED
- Although not strictly necessary, these are recommended to
- have.
- o GNU make.
+2: PREREQUISITES
- o Flex (version 2.5.4 or newer).
- o Bison (version 1.25 or newer).
+For compilation you need:
- o Perl-5. Most documentation was created with the
- perl's Plain Old Documentation. (I use 5.003)
+o A GNU system: GNU LilyPond is known to run on these GNU
+ systems: Linux (PPC, intel), FreeBSD, AIX, NeXTStep,
+ IRIX, Digital Unix and Solaris.
-6/May/98 LilyPond 0.1.62 1
+o Lots of disk space: LilyPond takes between 50 and 100
+ mb to compile if you use debugging information. If you
+ are short on disk-space run configure with --disable-
+ debugging.
+ Although we recommend to use Unix, LilyPond is known to
+ run on Windows NT/95/98 as well. See Section 11.
+o GNU C++ version 2.8 or newer (egcs-1.1 or newer is also
+ fine).
+o Python 1.5 (Strictly speaking, you shouldn't need
+ Python for compiling and installing, but you'll need it
+ to regenerate the font tables, e.g.).
-INSTALL(1) LilyPond documentation INSTALL(1)
+o GUILE 1.3 (no, GUILE 1.2 won't work), check out
+ http://www.gnu.org/programs/guile.html.
- o Python. Although perl is nice, python is better. We
- will shift towards python for build scripts
+3: RUNNING
- o GNU find
- o A fast computer (a full page of music typically takes
- 1 minute on my 486/133, using the --enable-checking
- compile. It's lot slower than most MusiXTeX
- preprocessors)
+GNU LilyPond does use a lot of resources. For operation you
+need the following:
-CONFIGURING and COMPILING
- to install GNU LilyPond, simply type:
- configure
- make
- make install
+o TeX
- This will install the following files:
+o A PostScript printer and/or viewer (such as
+ Ghostscript) is strongly recommended. Xdvi will show
+ all embedded PostScript too if you have Ghostscript
- /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 --enable-tex-prefix and --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:
+ installed.
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- configure
+o GUILE 1.3 (no, GUILE 1.2 won't work), check out
+ http://www.gnu.org/programs/guile.html
- CPPFLAGS are the preprocessor flags.
+For running LilyPond successfully you have to help TeX and
+MetaFont find various files. The recommended way of doing
+so is adjusting the environment variables in the start-up
+scripts of your shell. An example is given here for the
+Bourne shell:
- the configure script is Cygnus configure, and it will
- accept --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 /usr/local, and
- your TeX has no default hooks for local stuff (mine is
- broken too), you can do:
+ export MFINPUTS="/usr/local/share/lilypond/mf:"
+ export TEXINPUTS="/usr/local/share/lilypond/tex:"
-6/May/98 LilyPond 0.1.62 2
+The empty path component represents and MetaFont's default
+search paths. Scripts with the proper paths for the bourne
+and C-shell respectively are generated in build-
+scripts/out/lilypond-profile and buildscripts/out/lilypond-
+login during compilation.
+4: RECOMMENDED
+Although not strictly necessary, these are recommended to
+have.
-INSTALL(1) LilyPond documentation INSTALL(1)
+o GNU make. Check out ftp://ftp.gnu.org or any mirror of
+ this site.
- configure --prefix=/usr/local --enable-tex-prefix=/usr/lib/texmf
+o Flex (version 2.5.4 or newer). Check out
+ ftp://ftp.gnu.org or any mirror of this site.
- Since GNU LilyPond currently is beta, you are advised to
- also use
+o Bison (version 1.25 or newer). Check out
+ ftp://ftp.gnu.org or any mirror of this site.
- --enable-debugging
- --enable-checking
+o GUILE 1.3 (no, GUILE 1.2 won't work), check out
+ http://www.gnu.org/programs/guile.html
- other options include:
- --enable-shared
- Make a shared library (gnu/linux, solaris (?) only )
+o Python (version 1.5 or newer). Check out
+ ftp://ftp.python.org or ftp://ftp.cwi.nl/pub/python.
- --enable-printing
- Enable debugging print routines (lilypond -d option)
- --enable-optimise
- Set maximum optimisation: compile with -O2
+o Yodl. All documentation will be in Yodl. (1.30.17)
+ ftp://pcnov095.win.tue.nl/pub/yodl
+ http://www.cs.uu.nl/~hanwen/yodl
- --enable-profiling
- Compile with support for profiling
- --enable-tex-prefix
- Set the directory where TeX and Metafont live
+o Texinfo. (version 3.12 or newer)
- --enable-tex-dir
- Set then directory TeX input is in (detected as a
- subdir of tex-prefix). This should be a directory
- that is reachable both for tex and latex. On my
- system the best choice would be
- /usr/lib/texmf/texmf/tex/generic//.
- --enable-mf-dir
- Set the directory mf input is in (idem). On my
- system the best choice would be
- /usr/lib/texmf/texmf/fonts/source/public/.
+o GNU find Check out ftp://ftp.gnu.org or any mirror of
+ this site.
- --enable-config
- Output to different configuration files. Needed for
- multi-platform builds
- All options are documented in the configure help The
- option --enable-optimise is recommended for Real Life
- usage.
+o The geometry package for LaTeX is needed to use ly2dvi.
+ Available at ftp://ftp.ctan.org/tex-
+ archive/macros/latex/contrib/supported/geometry or at
+ mirror site ftp://ftp.dante.de
- If you do
- make all
+o A fast computer (a full page of music typically takes 1
+ minute on my 486/133, using the --enable-checking com-
+ pile. It's lot slower than most MusiXTeX preprocessors)
- everything will be compiled, but nothing will be
- installed. The resulting binaries can be found in the
- subdirectories out/ (which contain all files generated
- during compilation).
+5: WEBSITE
+If you want to auto-generate Lily's website, you'll need
+some additional conversion tools.
-6/May/98 LilyPond 0.1.62 3
+o xpmtoppm (from the Portable Bitmap Utilities) (For Red-
+ Hat Linux users: it is included within the package
+ libgr-progs).
+o Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
+ Which, in turn depends on man2html for proper installa-
+ tion. man2html can be had from http://askdon-
+ ald.ask.uni-karlsruhe.de/hppd/hpux/Network-
+ ing/WWW/Man2html-1.05.
+ TeTeX users should not forget to rerun texhash.
+Building the website requires pnmtopng. The version of pnm-
+topng that is distributed with RedHat 5.1 contains a bug
+(pnmtopng is dynamically linked to the wrong version of
+libpng). Recompile it from source, and make sure that the
+pnmtopng binary is linked statically to the libpng that is
+included in libgr.
-INSTALL(1) LilyPond documentation INSTALL(1)
+ tar xzf libgr-2.0.13.tar.gz
+ make
+ cd png
+ rm libpng.so*
+ make pnmtopng
-CONFIGURING FOR MULTIPLE PLATFORMS
- If you want to compile LilyPond with different
- configuration settings, then, you can use the --enable-
- config option. Example: suppose I want to build with and
- without profiling. Then I'd use the following for the
- normal build,
- configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
- and for the profiling version, I specify a different
- configuration.
- configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
- make configuration=optprof
- make configuration=optprof install
+You can then install the new pnmtopng into /usr/local/bin/
-INSTALLING
- If you have done a successful make, then a simple
- make install
+6: CONFIGURING and COMPILING
+
+
+to install GNU LilyPond, simply type:
+
+
+
+
+
+ gunzip -c lilypond-x.y.z | tar xf -
+ cd lilypond-x.y.z
+ configure # fill in your standard prefix with --prefix
+ make
+ make install
+
+
+
+
+
+This will install a number of files, something close to:
+
+
+
+
+
+ /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/bin/lilypond
+ /usr/local/bin/mi2mu
+ /usr/local/share/lilypond/*
+ /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+
+
+
+
+
+The above assumes that you are root and have the GNU devel-
+opment 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
+
+
+
+
+
+CPPFLAGS are the preprocessor flags.
+
+The configure script is Cygnus configure, and it will accept
+--help. If you are not root, you will probably have to make
+it with a different --prefix option. Our favourite location
+is
- 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 bin/clean-fonts.sh.
-CAVEATS
- o The -O2 option to gcc triggers a gcc bug on DEC Alpha
- in dstream.cc. You should turn off this flag for this
- file.
- o Perl5.003 and Perl5.004 use different syntax for
- pod2html.
-EXAMPLE
- This is what I type in my xterm:
- lilypond someinput.ly
- tex someinput.tex
- xdvi someinput&
+ configure --prefix=$HOME/usr
- This is what the output looks like over here:
+In this case, you will have to set up MFINPUTS, and TEXIN-
+PUTS accordingly.
+Since GNU LilyPond currently is beta, you are advised to
+also use
-6/May/98 LilyPond 0.1.62 4
+ --enable-debugging
+ --enable-checking
-INSTALL(1) LilyPond documentation INSTALL(1)
+Options to configure include:
- 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 ...
+--enable-guile
+ Link in GUILE (experimental)
- hw:~/musix/spacer$ xdvi someinput&
- [1] 855
+--enable-printing
+ Enable debugging print routines (lilypond -D option)
- Check out the input files, some of them have comments
- Please refer to the man page for more information.
+--enable-optimise
+ Set maximum optimisation: compile with -O2. This can
+ be unreliable on some compiler/platform combinations
+ (eg, DEC Alpha and PPC)
-REDHAT LINUX
- RedHat Linux users can compile an RPM. A spec file is in
- make/out/lilypond.spec. You should install a gif file
- called lelie_icon.gif along with the sources. You can
- generate this gif file by typing
+--enable-profiling
+ Compile with support for profiling.
- make gifs
+--enable-config
+ Output to a different configuration file. Needed for
+ multi-platform builds
- in the directory Documentation.
+All options are documented in the configure help The option
+--enable-optimise is recommended for Real Life usage.
-DEBIAN GNU/LINUX
- A Debian package is also available; contact Anthony Fok
- <foka@debian.org>. The build scripts are in the
- subdirectory debian/
+If you do
-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
- Note If you rely on broken DOS/Windows tools such as
- pkzip/WinZIP to unpack the distribution, make sure the
- entire source tree is unpacked correctly, in particular
- the empty out directories (flower/out, lib/out et. al.)
-AUTHORS
- Han-Wen Nienhuys <hanwen@cs.ruu.nl>
- Jan Nieuwenhuizen <jan@digicash.com>
+ make all
-6/May/98 LilyPond 0.1.62 5
+everything will be compiled, but nothing will be installed.
+The resulting binaries can be found in the subdirectories
+out/ (which contain all files generated during compilation).
+7: CONFIGURING FOR MULTIPLE PLATFORMS
-INSTALL(1) LilyPond documentation INSTALL(1)
+If you want to compile LilyPond with different configuration
+settings, then, you can use the --enable-config option.
+Example: suppose I want to build with and without profil-
+ing. Then I'd use the following for the normal build,
- Have fun!
+ configure --prefix=~ --disable-optimise --enable-checking
+ make
+ make install
+and for the profiling version, I specify a different config-
+uration.
+
+
+
+
+
+
+ configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
+ make config=optprof
+ make config=optprof install
+
+
+
+
+
+
+8: INSTALLING
+
+
+If you have done a successful make, then a simple
+
+
+
+
+
+
+ make install
+
+
+
+
+
+should do the trick.
+
+If you are doing an upgrade, please remember to remove obso-
+lete .pk and .tfm files of the fonts. A script has been
+provided to do the work for you, see bin/clean-fonts.sh.
+
+
+CAVEATS
+
+
+
+o The -O2 option to gcc triggers a gcc bug on DEC Alpha
+ in dstream.cc. You should turn off this flag for this
+
+
+ file.
+
+
+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.
+9: REDHAT LINUX
+RedHat Linux users can compile an RPM. A spec file is in
+make/out/lilypond.spec, it is distributed along with the
+sources.
+You can make the rpm by issuing
+ rpm -tb lilypond-x.y.z.tar.gz
+ rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+10: DEBIAN GNU/LINUX
+A Debian package is also available; contact Anthony Fok
+foka@debian.org <foka@debian.org>. The build scripts are in
+the subdirectory debian/.
+11: WINDOWS NT/95
+Separate instructions on building for W32 are avaible in the
+file README-W32.yo.
+12: AUTHORS
-6/May/98 LilyPond 0.1.62 6
+Han-Wen Nienhuys <hanwen@cs.uu.nl>
+Jan Nieuwenhuizen <janneke@gnu.org>
+Have fun!
projects / lilypond.git / blobdiff