- NSTALL - compiling and installing GNU LilyPond
- HWN & JCN
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
-Contents
+Abstract
+========
- 1: ABSTRACT
-2: OBTAINING
-3: PREREQUISITES
-4: RUNNING
-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: BUGS
-13: AUTHORS
+ This document explains what you need to install LilyPond, and what
+you should do. If you are going to compile and install LilyPond often,
+e.g. when doing development, you might want to check out the
+`buildscripts/set-lily.sh' script. It sets some environment variables
+and symlinks, which comes in handy when you have to compile LilyPond
+more often.
-1: ABSTRACT
+Obtaining
+=========
-This document explains what you need to install LilyPond,
-and what you should do. If you are going to compile and
-install LilyPond often, e.g. when doing development, 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.
+ You can get the latest version of LilyPond at
+ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
-2: OBTAINING
+ _If you upgrade by patching do remember to rerun autoconf after
+applying the patch_.
-You can get the latest version of LilyPond at
-ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/. Refer to the links
-document for mirror sites.
+ If you do not want to download the entire archive for each version,
+the safest method for upgrading is to use `xdelta', see
+`ftp://ftp.xcf.berkeley.edu/pub/xdelta/'.
-If you upgrade by patching do remember to rerun autoconf
-after applying the patch.
+ The following command produces `lilypond-1.1.55.tar.gz' from
+`lilypond-1.1.54' identical (up to compression dates) to the .55 on the
+FTP site.
+ xdelta patch lilypond-1.1.54-1.1.55.xd lilypond-1.1.54.tar.gz
-3: PREREQUISITES
+Prerequisites
+=============
-For compilation you need:
+ For compilation you need:
-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.
+ * A GNU system: GNU LilyPond is known to run on these GNU systems:
+ Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
+ and Solaris.
-o Lots of disk space: LilyPond takes between 30 and 100
- mb to compile if you use debugging information. If you
- are short on disk-space run configure with --disable-
- debugging.
+ * Lots of disk space: LilyPond takes between 30 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.
+ * Although we recommend to use Unix, LilyPond is known to run on
+ Windows NT/95/98 as well. See Section Windows NT/95,es.
-o EGCS 1.1 or newer.
+ * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
-o Python 1.5, Check out ftp://ftp.python.org or
- ftp://ftp.cwi.nl/pub/python.
+ * Python 1.5, Check out `ftp://ftp.python.org' or
+ `ftp://ftp.cwi.nl/pub/python'.
-o GUILE 1.3, check out http://www.gnu.org/soft-
- ware/guile/guile.html.
+ * GUILE 1.3.4, check out
+ http://www.gnu.org/software/guile/guile.html
+ (http://www.gnu.org/software/guile/guile.html).
-o GNU make. Check out ftp://ftp.gnu.org.
+ * GNU make. Check out ftp://ftp.gnu.org/make/
+ (ftp://ftp.gnu.org/make/).
-o Flex (version 2.5.4 or newer). Check out
- ftp://ftp.gnu.org.
+ * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
+ (ftp://ftp.gnu.org/flex/).
-o Bison (version 1.25 or newer). Check out
- ftp://ftp.gnu.org.
+ * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
+ (ftp://ftp.gnu.org/bison/).
-o Yodl. All documentation will be in Yodl. (1.31.15)
- ftp://ftp.lilypond.org/pub/yodl. You need the latest
- version of YODL, because the tutorial will trigger a
- bug in earlier versions.
+ * Texinfo (version 4.0 or newer). Check out
+ ftp://ftp.gnu.org/pub/texinfo/ (ftp://ftp.gnu.org/pub/texinfo/).
+ Most documentation is in texinfo.
-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
+ * The geometry package for LaTeX is needed to use ly2dvi. Available
+ at
+ ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry
+ (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry)
+ or at mirror site ftp://ftp.dante.de (ftp://ftp.dante.de)
-o MetaPost, if you want to use direct PostScript output.
- Please note that tetex-0.4pl8 (included with Redhat
- 5.x) does not include mfplain.mp, which is needed for
- producing the scaleable font files.
+ * MetaPost, needed for generating PostScript fonts. Please note that
+ tetex-0.4pl8 (included with Redhat 5.x) does not include
+ `mfplain.mp', which is needed for producing the scalable font
+ files.
-4: RUNNING
+ If you do not want to use PostScript output, edit `mf/GNUmakefile'.
-GNU LilyPond does use a lot of resources. For operation you
-need the following software
-o TeX
+Running
+=======
-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.
+ GNU LilyPond does use a lot of resources. For operation you need the
+following software
-o GUILE 1.3, check out http://www.gnu.org/pro-
- grams/guile.html
+ * TeX
-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:
+ * A PostScript printer and/or viewer (such as Ghostscript) is
+ strongly recommended. Xdvi will show all embedded PostScript
+ too if you have Ghostscript installed.
+ * GUILE 1.3.4, check out http://www.gnu.org/software/guile/
+ (http://www.gnu.org/programs/guile.html)
+
+ 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:
export MFINPUTS="/usr/local/share/lilypond/mf:"
export TEXINPUTS="/usr/local/share/lilypond/tex:/usr/local/share/lilypond/ps:"
-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.
-
-LilyPond is a hiddeously big, slow and bloated program. A
-fast CPU and plenty of RAM is recommended for comfortable
-use.
-
-5: WEBSITE
-
-The website is the most convenient form to use for reading
-the documentation on-line documentation. It is made by
-entering
+ The empty path component represents TeX and MetaFont's default
+search paths. Scripts with the proper paths for the bourne and C-shell
+respectively are generated in `buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' during compilation.
- make website
+ LilyPond is a hiddeously big, slow and bloated program. A fast CPU
+and plenty of RAM is recommended for comfortable use.
-This does require a fully functioning
+Website
+=======
-If you want to auto-generate Lily's website, you'll need
-some additional conversion tools.
+ The website is the most convenient form to use for reading the
+documentation on-line documentation. It is made by entering
-o YODL 1.31.15 or later.
+ make htmldoc
+ This does require a functioning LilyPond. The binary doesn't have
+to be installed.
-o xpmtoppm (from the Portable Bitmap Utilities) (For Red-
- Hat Linux users: it is included within the package
- libgr-progs). the original is at ftp://ftp.x.org/con-
- trib/utilities/netpbm-1mar1994.p1.tar.gz
+ If you want to auto-generate Lily's website, you'll need some
+additional conversion tools.
-o pnmtopng, which is also in libgr-progs for RedHat. The
- original is at
- ftp://swrinde.nde.swri.edu/pub/png/applications/pnm-
- topng-2.37.2.tar.gz.i
+ * xpmtoppm (from the Portable Bitmap Utilities) (For RedHat Linux
+ users: it is included within the package libgr-progs).
+ the original is at
+ ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
- The version of pnmtopng that is distributed with RedHat
- 5.1 and 5.2 contains a bug: pnmtopng is dynamically
- linked to the wrong version of libpng, which results in
+ * pnmtopng, which is also in libgr-progs for RedHat. The original is
+ at
+ ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz
+ (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).i
- cropped images. Recompile it from source, and make
- sure that the pnmtopng binary is linked statically to
- the libpng that is included in libgr. RedHat 6.0 does
- not have this problem.
+ The version of `pnmtopng' that is distributed with RedHat 5.1 and
+ 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
+ version of libpng, which results in cropped images. Recompile it
+ from source, and make sure that the pnmtopng binary is linked
+ statically to the libpng that is included in libgr. RedHat 6.0
+ does not have this problem.
tar xzf libgr-2.0.13.tar.gz
make
rm libpng.so*
make pnmtopng
- You can then install the new pnmtopng into
- /usr/local/bin/
+ You can then install the new pnmtopng into `/usr/local/bin/'
-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.
+ * Bib2html (http://pertsserver.cs.uiuc.edu/~hull/bib2html).
+ Which, in turn depends on man2html for proper installation.
+ man2html can be had from
+ http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05
+ (http://askdonald.ask.uni-karlsruhe.de/hppd/hpux/Networking/WWW/Man2html-1.05).
- The website will build without this utility, but you
- will not see our hypertextified bibliography.
+ The website will build without this utility, but you will not see
+ our hypertextified bibliography.
-o Doc++ (optional) to read the source code.
+ * DOC++ (http://www.zib.de/Visual/software/doc++/index.html) A
+ documentation system for C++ sources, which is used for the
+ LilyPond sources.
-You also have to install buildscripts/out/ps-to-gifs in a
-directory that is in the path.
+Configuring and compiling
+=========================
-6: CONFIGURING and COMPILING
+ to install GNU LilyPond, simply type:
-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
- 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:
-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/bin/convert-mudela
+ /usr/local/bin/mudela-book
+ /usr/local/bin/abc2ly
+ /usr/local/share/lilypond/*
+ /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
- /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 development
+tools, and your make is GNU make. If this is not the case, you can
+adjust your environment variables to your taste:
-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
+ export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
+ ./configure
-CPPFLAGS are the preprocessor flags.
+ `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
+ 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
- ./configure --prefix=$HOME/usr
-In this case, you will have to set up MFINPUTS, and TEXIN-
-PUTS accordingly.
+ ./configure --prefix=$HOME/usr
-Since GNU LilyPond currently is beta, you are advised to
-also use
+ In this case, you will have to set up MFINPUTS, and TEXINPUTS
+accordingly.
- --enable-debugging
- --enable-checking
+ Since GNU LilyPond currently is beta, you are advised to also use
-Options to configure include:
---enable-printing
- Enable debugging print routines (lilypond -D option)
+ --enable-debugging
+ --enable-checking
---enable-optimise
- Set maximum optimisation: compile with -O2. This can
- be unreliable on some compiler/platform combinations
- (eg, DEC Alpha and PPC)
+ Options to configure include:
---enable-profiling
+``--enable-printing''
+ Enable debugging print routines (lilypond `-D' option)
+
+``--enable-optimise''
+ Set maximum optimisation: compile with `-O2'. This can be
+ unreliable on some compiler/platform combinations (eg, DEC Alpha
+ and PPC)
+
+``--enable-profiling''
Compile with support for profiling.
---enable-config
+``--enable-config''
Output to a different configuration file. Needed for
- multi-platform builds
+ multi-platform builds
+
+ All options are documented in the `configure' help The option
+`--enable-optimise' is recommended for Real Life usage.
+
+ If you do
-All options are documented in the configure help The option
---enable-optimise is recommended for Real Life usage.
-If you do
+ make all
- make all
+ 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).
-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).
+Configuring for multiple platforms
+==================================
-7: 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,
-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,
./configure --prefix=~ --disable-optimise --enable-checking
make
make install
-and for the profiling version, I specify a different config-
-uration.
+ and for the profiling version, I specify a different configuration.
+
./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
make config=optprof
make config=optprof install
-8: INSTALLING
+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 obsolete
+`.pk' and `.tfm' files of the fonts. A script has been provided to do
+the work for you, see `bin/clean-fonts.sh'.
+
+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
+
+ Precompiled i386 RedHat RPMS are available from
+ftp://freshmeat.net/pub/rpms/lilypond/
+(ftp://freshmeat.net/pub/rpms/lilypond/) and
+http://linux.umbc.edu/software/lilypond/rpms/
+(http://linux.umbc.edu/software/lilypond/rpms/).
+
+ For compilation on a RedHat system you need these packages, in
+addition to the those needed for running:
+ * glibc-devel
+
+ * libstdc++-devel
+
+ * guile-devel
+
+ * flex
+
+ * bison
+
+ * texinfo
+
+Debian GNU/linux
+================
+
+ A Debian package is also available; contact Anthony Fok
+<foka@debian.org>. The build scripts are in the subdirectory `debian/'.
+
+Windows NT/95
+=============
+
+ Separate instructions on building for W32 are available; See the
+files in `Documentation/ntweb/', included with the sources.
+
+Problems
+========
-If you have done a successful make, then a simple
+ For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>. Please consult the faq before mailing
+your problems.
- make install
+ If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
-should do the trick.
+ Known bugs that are LilyPond's fault are listed in `TODO', or
+demonstrated in `input/bugs/'.
-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.
+ Known bugs that are not LilyPond's fault are documented here.
-CAVEATS
+LinuxPPC Bugs:
+**************
-o The -O2 option triggers bugs on various platforms
- (PowerPC, Alpha). If you experience problems, you
- should first try turning off this.
+ * egcs-1.1.2-12c (stock LinuxPPC R5) has a serious bug, upgrade to
+ fixed in egcs-1.1.2-12f or gcc-2.95-0a,
+ `ftp://dev.linuxppc.org/users/fsirl/R5/RPMS/ppc/'
-o On PPC you need at least EGCS-1.1.2f.
+ * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
+ particular guile-1.3, and Lily herself will break.
-9: REDHAT LINUX
+Linux-i386
+**********
-RedHat Linux users can compile an RPM. A spec file is in
-make/out/lilypond.spec, it is distributed along with the
-sources.
+ * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
-You can make the rpm by issuing
+ Lily will crash during parsing (which suggests a C++ library
+ incompatibility). Precise cause, precise platform description or
+ solution are not known.
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+ Note that this only happens on some computers with the said
+ platform.
-Precompiled i386 RedHat RPMS are available from ftp://fresh-
-meat.net/pub/rpms/lilypond/ and http://linux.umbc.edu/soft-
-ware/lilypond/rpms/.
+ * libg++ 2.7
-For compilation on a RedHat system you need these packages,
-in addition to the thoes needed for running:
+ LilyPond occasionally crashes while parsing the initialisation
+ files. This is a very obscure bug, and usually entering the
+ commandline differently "fixes" it.
-o glibc-devel
+ lilypond input.ly
-o libstdc++-devel
+ and
+ lilypond -I. ./input.ly
+ makes a difference
-o guile-devel
+ Typical stacktrace:
+ SIGSEGV
+ __libc_malloc (bytes=16384)
+ ?? ()
+ yyFlexLexer::yy_create_buffer ()
+ Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
-o flex
+ This behaviour has been observed with machines that have old libg++
+ versions (LinuxPPC feb '98, RedHat 4.x).
-o bison
+Solaris:
+********
-10: DEBIAN GNU/LINUX
+ * Sparc64/Solaris 2.6, GNU make-3.77
-A Debian package is also available; contact Anthony Fok
-foka@debian.org. The build scripts are in the subdirectory
-debian/.
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
-11: WINDOWS NT/95
+ * Sparc64/Solaris 2.6, ld
-Separate instructions on building for W32 are avaible in the
-file README-W32.yo.
+ Not yet resolved.
-12: BUGS
+AIX
+***
-Send bug reports to bug-gnu-music@gnu.org. For help and
-questions use help-gnu-music@gnu.org and gnu-music-dis-
-cuss@gnu.org. Please consult the faq before mailing your
-problems.
+ * AIX 4.3 ld
-13: AUTHORS
+ The following is from the gcc install/SPECIFIC file.
+ Some versions of the AIX binder (linker) can fail with a
+ relocation overflow severe error when the -bbigtoc option
+ is used to link GCC-produced object files into an
+ executable that overflows the TOC. A fix for APAR IX75823
+ (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
+ available from IBM Customer Support and from its
+ 27service.boulder.ibm.com website as PTF U455193.
-Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ Binutils does not support AIX 4.3 (at least through release
+ 2.9). GNU as and GNU ld will not work properly and one
+ should not configure GCC to use those GNU utilities. Use
+ the native AIX tools which do interoperate with GCC.
-Jan Nieuwenhuizen <janneke@gnu.org>
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
-In case of problems, please use the mailing list for help.
-Have fun!
projects / lilypond.git / blobdiff