INSTALL - compiling and installing GNU LilyPond
***********************************************
-Abstract
-========
-
- TODO: document xdeltas
-
- 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.
-
Obtaining
=========
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/). Refer to the links document
-for mirror sites.
+(ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/).
_If you upgrade by patching do remember to rerun autoconf after
applying the patch_.
+ 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
=============
* A GNU system: GNU LilyPond is known to run on these GNU systems:
Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
- and Solaris.
+ and Solaris.
* 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
+ * Although we recommend to use Unix, LilyPond is known to run on
Windows NT/95/98 as well. See Section Windows NT/95,es.
- * EGCS 1.1 or newer. Check out ftp://ftp.gnu.org/pub/gcc/
- (ftp://ftp.gnu.org/pub/gcc/)
+ * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/gnu/gcc/'.
- * Python 1.5, Check out ftp://ftp.python.org (ftp://ftp.python.org)
- or ftp://ftp.cwi.nl/pub/python (ftp://ftp.cwi.nl/pub/python).
+ * Python 1.5, Check out `ftp://ftp.python.org' or
+ `ftp://ftp.cwi.nl/pub/python'.
- * GUILE 1.3, check out http://www.gnu.org/software/guile/guile.html
- (http://www.gnu.org/software/guile/guile.html).
+ * GUILE 1.3.4 or newer, check out
+ http://www.gnu.org/software/guile/guile.html
+ (http://www.gnu.org/software/guile/guile.html). Version 1.4 is
+ recommended for better performance.
- * GNU make. Check out ftp://ftp.gnu.org/make/
- (ftp://ftp.gnu.org/make/).
+ * GNU Make. Check out ftp://ftp.gnu.org/gnu/make/
+ (ftp://ftp.gnu.org/gnu/make/).
- * Flex (version 2.5.4 or newer). Check out ftp://ftp.gnu.org/flex/
- (ftp://ftp.gnu.org/flex/).
+ * Flex (version 2.5.4a or newer). Check out
+ ftp://ftp.gnu.org/gnu/flex/ (ftp://ftp.gnu.org/gnu/flex/).
- * Bison (version 1.25 or newer). Check out ftp://ftp.gnu.org/bison/
- (ftp://ftp.gnu.org/bison/).
+ * Bison (version 1.25 or newer). Check out
+ ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
- * Texinfo. Check out ftp://ftp.gnu.org/pub/texinfo/
- (ftp://ftp.gnu.org/pub/texinfo/). Most documentation is in
- texinfo.
+ * TeX. If you want LilyPond to use kpathsea support (recommended),
+ make sure you have tetex 1.0 or newer (1.0.6 is known to work).
+ You may need to install a tetex-devel or tetex-dev package too.
+
+ * Texinfo (version 4.0 or newer). Check out
+ ftp://ftp.gnu.org/gnu/texinfo/ (ftp://ftp.gnu.org/gnu/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.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',
+ removing the line saying `PFA_FILES='
+
+ * kpathsea, a library for searching (TeX) files. `kpathsea' is
+ usually included with your installation of TeX.
+
Running
=======
GNU LilyPond does use a lot of resources. For operation you need the
following software
- * TeX
+ * TeX.
* 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, 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
-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:"
+environment variables in the start-up scripts of your shell. Appropriate
+Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
+`buildscripts/out/lilypond-login' after compilation.
- The empty path component represents TeX and MetaFont's default
-search paths. Scripts with the proper paths for the bourne and C-shell
+ 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.
- LilyPond is a hiddeously big, slow and bloated program. A fast CPU
-and plenty of RAM is recommended for comfortable use.
+ LilyPond is a big and slow program. A fast CPU and plenty of RAM is
+recommended for comfortable use.
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.
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
- cd png
- rm libpng.so*
- make pnmtopng
-
- You can then install the new pnmtopng into `/usr/local/bin/'
-
- * Bib2html http://pertsserver.cs.uiuc.edu/~hull/bib2html.
- (http://pertsserver.cs.uiuc.edu/~hull/bib2html.) Which, in
- turn depends on man2html for proper installation. man2html can be
- had from
+ version of libpng.
+
+ * 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.
- * Doc++ (optional) to read the source code.
-
-
- 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:
-
gunzip -c lilypond-x.y.z | tar xf -
cd lilypond-x.y.z
./configure # fill in your standard prefix with --prefix
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/midi2ly.1
+ /usr/local/man/man1/abc2ly.1
+ /usr/local/man/man1/etf2ly.1
+ /usr/local/man/man1/convert-ly.1
+ /usr/local/man/man1/lilypond-book.1
/usr/local/man/man1/lilypond.1
/usr/local/bin/lilypond
- /usr/local/bin/mi2mu
+ /usr/local/bin/midi2ly
+ /usr/local/bin/convert-ly
+ /usr/local/bin/lilypond-book
+ /usr/local/bin/abc2ly
+ /usr/local/bin/pmx2ly
+ /usr/local/bin/musedata2ly
+ /usr/local/bin/etf2ly
/usr/local/share/lilypond/*
- /usr/local/share/locale/{it,nl}/LC_MESSAGES/lilypond.mo
+ /usr/local/share/locale/{....}/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
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
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
+ ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
+ make config=prof
+ make config=prof install
Installing
==========
`.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
============
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/).
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
For compilation on a RedHat system you need these packages, in
addition to the those needed for running:
* texinfo
+ * tetex-devel
+
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/'; you can make
+the .deb by doing
+
+
+ tar xzf lilypond-x.y.z.tar.gz
+ cd lilypond-x.y.z
+ dpkg-buildpackage
+ dpkg -i ../lilypond_x.y.z*deb
+
+ For compilation on a Debian GNU/Linux system you need these packages,
+in addition to the those needed for running:
+ * libc6-dev
+
+ * libstdc++<your-libstdc++-version-here>-dev
+
+ * libguile<your-libguile-version-here>-dev
+
+ * flex
+
+ * bison
+
+ * gettext
+
+ * texinfo
+
+ * tetex-dev
+
+ * debhelper
Windows NT/95
=============
- Separate instructions on building for W32 are available; See file
-README-W32, included with the sources.
+ Separate instructions on building for W32 are available; See the
+files in `Documentation/ntweb/', included with the sources.
+
+Problems
+========
-Bugs
-====
+ For help and questions use <help-gnu-music@gnu.org> and
+<gnu-music-discuss@gnu.org>. Please consult the faq before mailing
+your 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.
+ If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
-Authors
-=======
+ Bugs that are LilyPond's fault are listed in our TODO list on the
+web, or demonstrated in `input/bugs/'.
+
+ 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