INSTALL - compiling and installing GNU LilyPond
***********************************************
-ABSTRACT
+Abstract
========
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
+and symlinks, which comes in handy when you have to compile LilyPond
more often.
-OBTAINING
+Obtaining
=========
- 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.
+ 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/).
_If you upgrade by patching do remember to rerun autoconf after
applying the patch_.
-PREREQUISITES
+ 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/'.
+
+ 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
+
+Prerequisites
=============
For compilation you need:
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 *Note w32::.
-
- * EGCS 1.1 or newer. Check out < ftp://ftp.gnu.org/pub/gcc/>
+ * Although we recommend to use Unix, LilyPond is known to run on
+ Windows NT/95/98 as well. See Section Windows NT/95,es.
- * Python 1.5, Check out <ftp://ftp.python.org> or
- <ftp://ftp.cwi.nl/pub/python>.
+ * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/pub/gcc/'.
- * GUILE 1.3, check out
- <http://www.gnu.org/software/guile/guile.html>.
+ * Python 1.5, Check out `ftp://ftp.python.org' or
+ `ftp://ftp.cwi.nl/pub/python'.
- * GNU make. Check out <ftp://ftp.gnu.org/make/>.
+ * GUILE 1.3.4, check out
+ http://www.gnu.org/software/guile/guile.html
+ (http://www.gnu.org/software/guile/guile.html).
- * Flex (version 2.5.4 or newer). Check out
- <ftp://ftp.gnu.org/flex/>.
+ * GNU make. Check out ftp://ftp.gnu.org/make/
+ (ftp://ftp.gnu.org/make/).
- * Bison (version 1.25 or newer). Check out
- <ftp://ftp.gnu.org/bison/>.
+ * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
+ (ftp://ftp.gnu.org/flex/).
- * Texinfo. Check out <ftp://ftp.gnu.org/pub/texinfo/>. Most
- documentation is in texinfo.
+ * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
+ (ftp://ftp.gnu.org/bison/).
- * Yodl. Needed for obsolete docs (1.31.17)
- <ftp://ftp.lilypond.org/pub/yodl>.
+ * 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.
* 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>
+ 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)
- * 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
+ * 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.
+ If you do not want to use PostScript output, edit `mf/GNUmakefile'.
-RUNNING
+
+Running
=======
GNU LilyPond does use a lot of resources. For operation you need the
strongly recommended. Xdvi will show all embedded PostScript
too if you have Ghostscript installed.
- * GUILE 1.3, check out <http://www.gnu.org/programs/guile.html>
+ * 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
LilyPond is a hiddeously big, slow and bloated program. A fast CPU
and plenty of RAM is recommended for comfortable use.
-WEBSITE
+Website
=======
The website is the most convenient form to use for reading the
documentation on-line documentation. It is made by entering
- make website
- This does require a fully functioning
+ make htmldoc
+ This does require a functioning LilyPond. The binary doesn't have
+to be installed.
If you want to auto-generate Lily's website, you'll need some
additional conversion tools.
- * YODL 1.31.15 or later.
-
* 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
+ (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
* 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>.i
+ 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
The version of `pnmtopng' that is distributed with RedHat 5.1 and
5.2 contains a bug: pnmtopng is dynamically linked to the wrong
You can then install the new pnmtopng into `/usr/local/bin/'
- * Bib2html <http://pertsserver.cs.uiuc.edu/~hull/bib2html.>
+ * 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
+ (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.
- * 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
+Configuring and compiling
=========================
to install GNU LilyPond, simply type:
/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
`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
+`--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
Options to configure include:
-`*--enable-printing*'
- Enable debugging print routines (lilypond *-D* option)
+``--enable-printing''
+ Enable debugging print routines (lilypond `-D' option)
-`*--enable-optimise*'
- Set maximum optimisation: compile with *-O2*. This can be
+``--enable-optimise''
+ Set maximum optimisation: compile with `-O2'. This can be
unreliable on some compiler/platform combinations (eg, DEC Alpha
and PPC)
-`*--enable-profiling*'
+``--enable-profiling''
Compile with support for profiling.
-`*--enable-config*'
+``--enable-config''
Output to a different configuration file. Needed for
multi-platform builds
All options are documented in the `configure' help The option
-*-enable-optimise* is recommended for Real Life usage.
+`--enable-optimise' is recommended for Real Life usage.
If you do
resulting binaries can be found in the subdirectories `out/' (which
contain all files generated during compilation).
-CONFIGURING FOR MULTIPLE PLATFORMS
+Configuring for multiple platforms
==================================
If you want to compile LilyPond with different configuration
-settings, then, you can use the *-enable-config* option. Example:
+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,
make config=optprof
make config=optprof install
-INSTALLING
+Installing
==========
- If you have done a successful `make', then a simple
+ if you have done a successful `make', then a simple
make install
`.pk' and `.tfm' files of the fonts. A script has been provided to do
the work for you, see `bin/clean-fonts.sh'.
-CAVEATS
-=======
-
- * The -O2 option triggers bugs on various platforms (PowerPC,
- Alpha). If you experience problems, you should first try
- turning off this.
-
- * On PPC you need at least EGCS-1.1.2f.
-
-REDHAT LINUX
+Redhat linux
============
RedHat Linux users can compile an RPM. A spec file is in
rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
Precompiled i386 RedHat RPMS are available from
-<ftp://freshmeat.net/pub/rpms/lilypond/> and
-<http://linux.umbc.edu/software/lilypond/rpms/>.
+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 thoes needed for running:
+addition to the those needed for running:
* glibc-devel
* libstdc++-devel
* bison
-DEBIAN GNU/LINUX
+ * texinfo
+
+Debian GNU/linux
================
- A Debian package is also available; contact Anthony Fok
-<foka@debian.org>. The build scripts are in the subdirectory `debian/'.
+ A Debian package is also available; see
+http://packages.debian.org/lilypond
+(http://packages.debian.org/lilypond) or contact Anthony Fok
+<foka@debian.org> for more information. The build scripts are in the
+subdirectory `debian/'.
-WINDOWS NT/95
+Windows NT/95
=============
- Separate instructions on building for W32 are available
-<../../outdir/README-W32.html>.
+ Separate instructions on building for W32 are available; See the
+files in `Documentation/ntweb/', included with the sources.
-BUGS
-====
+Problems
+========
- Send bug reports to bug-gnu-music@gnu.org. For help and questions
-use help-gnu-music@gnu.org and gnu-music-discuss@gnu.org. Please
-consult the faq before mailing your problems.
+ For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>. Please consult the faq before mailing
+your problems.
-AUTHORS
-=======
+ If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
+
+ Known bugs that are LilyPond's fault are listed in `TODO', or
+demonstrated in `input/bugs/'.
+
+ Known bugs that are not LilyPond's fault are documented here.
+
+LinuxPPC Bugs:
+**************
+
+ * 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/'
+
+ * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
+ particular guile-1.3, and Lily herself will break.
+
+Linux-i386
+**********
+
+ * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+
+ Lily will crash during parsing (which suggests a C++ library
+ incompatibility). Precise cause, precise platform description or
+ solution are not known.
+
+ Note that this only happens on some computers with the said
+ platform.
+
+ * libg++ 2.7
+
+ LilyPond occasionally crashes while parsing the initialisation
+ files. This is a very obscure bug, and usually entering the
+ commandline differently "fixes" it.
+
+ lilypond input.ly
+
+ and
+ lilypond -I. ./input.ly
+ makes a difference
+
+ Typical stacktrace:
+ SIGSEGV
+ __libc_malloc (bytes=16384)
+ ?? ()
+ yyFlexLexer::yy_create_buffer ()
+ Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
+
+ This behaviour has been observed with machines that have old libg++
+ versions (LinuxPPC feb '98, RedHat 4.x).
+
+Solaris:
+********
+
+ * Sparc64/Solaris 2.6, GNU make-3.77
+
+ GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
+ newer.
+
+ * Sparc64/Solaris 2.6, ld
+
+ Not yet resolved.
+
+AIX
+***
+
+ * AIX 4.3 ld
- Han-Wen Nienhuys <hanwen@cs.uu.nl>
+ 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.
- Jan Nieuwenhuizen <janneke@gnu.org>
+ 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.
- In case of problems, please use the mailing list for help.
+ add -Wl,-bbigtoc to USER_LDFLAGS, ie:
+ LDFLAGS='-Wl,-bbigtoc' ./configure
- Have fun!
projects / lilypond.git / blobdiff