+Table of Contents
+*****************
+
+
+
+
+INSTALL - compiling and installing GNU LilyPond
+ Downloading
+ Source code
+ Precompiled binaries
+ Upgrading
+ Requirements
+ Compilation
+ Running requirements
+ Website requirements
+ Building LilyPond
+ Configuring for multiple platforms
+ Emacs mode
+ Compiling for distributions
+ Red Hat Linux
+ LinuxPPC
+ SuSE
+ Slackware
+ Mandrake
+ Debian GNU/Linux
+ MacOS X
+ Problems
+ FLex-2.5.4a and gcc-3.0
+ Linux-2.4.0, Guile-1.4 -with-threads
+ NetBSD
+ Solaris:
+ AIX
+
+
INSTALL - compiling and installing GNU LilyPond
***********************************************
-Downloading source code
-=======================
+ This document describes how to build LilyPond on Unix platforms. It
+is also known to run and compile on Windows NT/95/98 as well. More
+information on this topic can be found at the LilyPond on Windows page
+(http://www.lilypond.org/gnu-windows/).
+
+Downloading
+===========
+
+ Even numbered versions are `stable'. The webpages for the stable
+version (1.2) reside on the GNU servers
+(http://www.gnu.org/software/lilypond). Big enhancements go into the
+latest odd numbered version (1.3), whose webpages are on the lilypond
+site (http://www.lilypond.org/).
+
+Source code
+-----------
If you want to compile LilyPond from source, download here:
- * Download stable releases at GNU (ftp://ftp.gnu.org/gnu/lilypond/)
+ * Download development releases from
+ `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/' by FTP and
+ `http://ftp.cs.uu.nl/pub/GNU/LilyPond/', by HTTP.
- * Download development releases from by FTP
- (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/development/) and by HTTP
- (http://ftp.cs.uu.nl/pub/GNU/LilyPond/development/).
+ * `ftp://sca.uwaterloo.ca/pub/' by FTP (Canadian mirror)
- * ftp (Canadian mirror) (ftp://sca.uwaterloo.ca/pub/)
+ * at `lilypond.org' `ftp://ftp.lilypond.org/pub/LilyPond/' by FTP and
+ `http://www.lilypond.org/ftp/' by HTTP.
- * at `lilypond.org' by FTP (ftp://ftp.lilypond.org/pub/LilyPond/) and
- HTTP (http://www.lilypond.org/ftp/).
+ Of course, if your platform supports LilyPond, such as Debian
+GNU/Linux, FreeBSD, OpenBSD or NetBSD, you're encouraged to use the
+native build from source drill.
- Installing and compiling requires many additional packages, which are
-listed in the installation instructions
-(Documentation/topdocs/out-www/INSTALL.html).
+ For Red Hat Linux and SuSE Linux, `.spec' files are included in the
+tarball; see instructions below.
-Downloading binaries
-====================
+Precompiled binaries
+--------------------
- Binaries are available, but are not updated for every version
-released.
- * RedHat i386 (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/RPMS/)
+ If you want to track bleeding edge development, try:
- * LinuxPPC (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/linuxppc)
+ * Debian GNU/Linux
+ (ftp://ftp.debian.org/debian/pool/main/l/lilypond/) usually has
+ the latest binaries for the most useful stable and development
+ versions, while
- * Debian GNU/Linux Stable
- (ftp://ftp.debian.org/debian/pool/main/l/lilypond)
+ * Mandrake Cooker
+ (http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/) also
+ provides fairly recent versions.
+
+ Binaries are made available for other popular platforms, but as we
+need to compile them ourselves, they are not updated for every version
+released.
- * Debian GNU/Linux Unstable
- (ftp://ftp.debian.org/debian/pool/main/l/lilypond1.3)
+ * Red Hat i386
+ (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/)
- * Windows Stable (http://home.austin.rr.com/jbr/jeff/lilypond/)
+ * SuSE (ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE)
- * Windows Testing (ftp://ftp.lilypond.org/pub/lilypond/gnu-windows)
+ * LinuxPPC (ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/)
+
+ * Windows (http://www.lilypond.org/gnu-windows/)
Upgrading
-=========
+---------
- There are two options for upgrading sources.
+ There are two options for upgrading sources.
* if you have an unpacked source tree of a previous version, you may
the patches.
xdelta (ftp://ftp.xcf.berkeley.edu/pub/xdelta/). This is much
safer than using patches, and is the recommended way.
- The following command produces `lilypond-1.3.122.tar.gz' from
- `lilypond-1.3.121' identical (up to compression dates) to the .122
- on the FTP site.
- xdelta patch lilypond-1.3.121-1.3.122.xd lilypond-1.3.121.tar.gz
+ The following command produces `lilypond-1.4.3.tar.gz' from
+ `lilypond-1.4.2.tar.gz' identical (up to compression dates) to the
+ .3 on the FTP site.
+ xdelta patch lilypond-1.4.2-1.4.3.xd lilypond-1.4.2.tar.gz
-Build requirements
-==================
+Requirements
+============
- This document describes how to build LilyPond on Unix platforms. It
-is also known to run and compile on Windows NT/95/98 as well. More
-information on this topic can be found at the LilyPond on Windows page
-(ftp://ftp.lilypond.org/pub/LilyPond/gnu-windows/).
+Compilation
+-----------
You need the following packages to compile Lilypond.
- * A reasonably new C++ compiler: EGCS 1.1, GCC 2.95.2 or newer.
- Check out the gcc site (ftp://ftp.gnu.org/gnu/gcc/).
+ * A reasonably new version of the GNU C++ compiler: EGCS 1.1, GCC
+ 2.95.2 or newer. Check out the gcc site
+ (ftp://ftp.gnu.org/gnu/gcc/).
- * Python 1.5, Check out the python website (http://www.python.org).
+ * Python (version 1.5 or newer). Check out the python website
+ (http://www.python.org).
- * GUILE 1.3.4 or newer, check out the GUILE webpage
+ * GUILE (version 1.4 or newer). Check out the GUILE webpage
(http://www.gnu.org/software/guile/guile.html). Version 1.4 is
recommended for better performance.
TeX is used as an output backend.
- Also, TeX's libkpathsea is used to find the fonts (.mf, .afm,
- .tfm). Make sure you have tetex 1.0 or newer (1.0.6 is known to
+ Also, TeX's libkpathsea is used to find the fonts (`.mf', `.afm',
+ `.tfm'). 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.
(ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry).
This package is normally included with the TeX distribution.
- * MetaPost, needed for generating PostScript fonts. Please note that
- tetex-0.4pl8 (included with Red Hat 5.x) does not include
- `mfplain.mp', which is needed for producing the scalable font
- files.
-
- If you don't have MetaPost and don't want to use PostScript
- output, then 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. You may need to
install a tetex-devel or tetex-dev package too.
./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
+ * pktrace 1.0 or newer, [OPTIONAL], needed for generating PostScript
+ Type1 fonts. Get it from `http://www.cs.uu.nl/~hanwen/pktrace/'.
+ You will need to install some additional packages to get pktrace
+ to work.
+
Running requirements
-====================
+--------------------
GNU LilyPond does use a lot of resources. For operation you need the
following software
* TeX.
- * Xdvi and ghostscript
+ * Xdvi and Ghostscript
* GUILE 1.3.4, or newer. Check out the GUILE webpage
(http://www.gnu.org/software/guile.html)
recommended for comfortable use.
Website requirements
-====================
+--------------------
The documentation comes in the form of a website. You can view this
website on the internet, but you can also build it locally. This process
make web-doc
- Building the website requires some additional tools:
+ Building the website requires some additional tools:
* xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
The original is at the netpbm FTP site
* pnmtopng. The original is at in the pnmtopng FTP site
(ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
- * Bibtex2html (http://www.lri.fr/~filliatr/ftp/bibtex2html/), or
- Bib2html (http://www.uni-koblenz.de/ag-ki/ftp/bib2html/).
- Bibtex2html is available in debian, while bib2html is in some rpm
- based distributions. Bib2html, 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).
+ * texinfo (a development release) The documentation will build with
+ texinfo-4.0, but if you want split html pages, you're best off
+ using the lates pretest version from texinfo-4.0b
+ (ftp://texinfo.org/texinfo/pretests/texinfo-4.0b.tar.gz) or
+ texinfo-4.0b (ftp://alpha.gnu.org/gnu/texinfo-4.0b.tar.gz)
- The website will build without bib converter utility, but you will
- not see our hypertextified bibliography.
-
-
-Configuring and compiling
-=========================
+Building LilyPond
+==================
to install GNU LilyPond, type:
gunzip -c lilypond-x.y.z | tar xf -
`buildscripts/out/lilypond-profile' into your start up scripts by hand.
Configuring for multiple platforms
-==================================
+----------------------------------
If you want to build multiple versions of LilyPond with different
configuration settings, you can use the `--enable-config=CONF' option
Emacs mode
==========
- An emacs mode for LilyPond is included with the source archive as
-`lilypond-mode.el' and `lilypond-font-lock.el'. If you have an RPM, it
-is in `/usr/share/doc/lilypond-X/'. You have to install it yourself.
+ An Emacs mode for entering music and running LilyPond is included
+with the source archive as `lilypond-mode.el' and
+`lilypond-font-lock.el'. You should install these files somewhere in
+your LOAD-PATH. If you have installed a precompiled LilyPond package,
+these files can be found in `/usr/share/doc/lilypond-x.y.z/'.
- Add this to your ~/.emacs or ~/.emacs.el:
+ Add this to your `~/.emacs' or `~/.emacs.el', or install this file
+in Emacs' `site-start.d':
+ ;;; lilypond-init.el --- Startup code for LilyPond mode
+
(load-library "lilypond-mode.el")
(setq auto-mode-alist
(cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))
(add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))
- If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
-is automatically loaded, so you need not modify your `~/.emacs' file.
+ If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode
+is automatically loaded, you not even need to modify your `~/.emacs'
+file.
+
+Compiling for distributions
+===========================
Red Hat Linux
-=============
+-------------
Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
You can also compile them yourself. A spec file is in
-`make/out/lilypond.spec'. This file is distributed along with the
-sources. You can make the rpm by issuing
+`make/out/lilypond.redhat.spec'. This file is distributed along with
+the sources. You can make the rpm by issuing
- rpm -tb lilypond-x.y.z.tar.gz
+ tar xfz lilypond-x.y.z.tar.gz
+ rpm -bb lilypond-x.y.z/make/out/lilypond.redhat.spec
rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
For running on a Red Hat system you need these packages: guile,
-tetex, tetex-dvips, libstdc++, python, ghostscript.
+tetex, tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
For compilation on a Red Hat system you need these packages, in
addition to the those needed for running: glibc-devel, gcc-c++,
-libstdc++-devel, guile-devel, flex, bison, texinfo, tetex-devel, groff,
-libgr-progs.
+libstdc++-devel, guile-devel, flex, bison, texinfo, groff, pktrace.
+
+LinuxPPC
+--------
+
+ Some LinuxPPC RPMS should available from
+`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+
+ A LinuxPPC RPM can be made using the `lilypond.redhat.spec' file.
SuSE
-====
+----
- [TODO: document this]
+ Some SUSE RPMS should available from
+`ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE'.
- Install `tetex', `te_mpost', `te_kpath'.
+ You can also compile a RPM for SUSE yourself. A spec file is in
+`make/out/lilypond.suse.spec', see the instructions for building the
+Red Hat RPM.
+
+ You must have the following packages: guile tcsh tetex te_latex
+te_kpath te_mpost libpng python gpp libgpp gettext autoconf netpbm
+libnetpb gs_serv gs_lib gs_fonts guile
+
+Slackware
+---------
+
+ No precompiled packages for Slackware are available.
+
+ Problems have been reported with Slackware 7.0; apparently, it ships
+with a faulty compiler. Do not compile LilyPond with -O2 on this
+platform.
Mandrake
-========
+--------
+
+ Some binaries are available at rpmfind.net. Refer to
+`http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/'.
- [TODO]
+ You can also compile a RPM for Mandrake yourself. A spec file is in
+`make/out/lilypond.mandrake.spec', see the instructions for building
+the Red Hat RPM.
Debian GNU/Linux
-================
+----------------
A Debian package is also available. You may install it easily by
-using apt-get as root:
-
- apt-get install lilypond1.3
+running `apt-get' as root:
+
+ apt-get install lilypond lilypond-doc
+
+ You can also compile the .deb for Debian yourself, do:
+
+ apt-get -b source lilypond
+
+ If you're real impatient, you may even do:
+
+ cd lilypond-x.y.z # a previous version
+ uscan # download and build latest directly from upstream
+
+ Debian's TeX installation is a bit short on memory, you may want to
+increase it like this:
+ --- texmf.cnf.orig Sun Dec 16 23:47:07 2001
+ +++ texmf.cnf Sun Dec 16 23:46:34 2001
+ @ -411,8 +411,8 @
+ main_memory.context = 1500000
+ main_memory.mpost = 1000000
+ main_memory = 263000 % words of inimemory available; also applies to inimf&mp
+ -extra_mem_top = 0 % extra high memory for chars, tokens, etc.
+ -extra_mem_bot = 0 % extra low memory for boxes, glue, breakpoints, etc.
+ +extra_mem_top = 1000000 % extra high memory for chars, tokens, etc.
+ +extra_mem_bot = 1000000 % extra low memory for boxes, glue, breakpoints, etc.
+
+ obj_tab_size.context = 300000
+
+ @ -430,7 +430,7 @
+ % Max number of characters in all strings, including all error messages,
+ % help texts, font names, control sequences. These values apply to TeX and MP.
+ pool_size.context = 750000
+ -pool_size = 125000
+ +pool_size = 250000
+ % Minimum pool space after TeX/MP's own strings; must be at least
+ % 25000 less than pool_size, but doesn't need to be nearly that large.
+ string_vacancies.context = 45000
+
+ You could also export `extra_mem_top' and `extra_mem_bot' as
+environment variables if you do not want to or cannot modify
+`/etc/texmf/texmf.cnf'.
Alternatively, visit
* http://packages.debian.org/lilypond
(http://packages.debian.org/lilypond)
- * http://ftp.debian.org/debian/pool/main/l/lilypond1.3/
- (http://ftp.debian.org/debian/pool/main/l/lilypond1.3/) for latest
- package uploaded to Debian unstable;
-
* http://people.debian.org/~foka/lilypond/
(http://people.debian.org/~foka/lilypond/) for latest
- semi-unofficial build of LilyPond 1.3.121 for Debian 2.2r2
- (potato) users. The official stable Debian 2.2r2 is stuck with
- the old LilyPond-1.3.24.
+ semi-unofficial build of LilyPond 1.4.2 for Debian 2.2 (potato)
+ users. The official stable Debian 2.2 is stuck with the old
+ LilyPond-1.3.24. Since LilyPond-1.4 has been released, the older
+ lilypond1.3 Debian package is now obsolete.
- You may contact Anthony Fok <foka@debian.org> for more information.
+ Please contact Anthony Fok <lilypond@packages.debian.org> for more
+information.
The build scripts are in the subdirectory `debian/'; you can make
the .deb by doing, for example:
$ su - root
# dpkg --purge lilypond lilypond1.3
# exit
- $ tar xzf lilypond-1.3.122.tar.gz
- $ cd lilypond-1.3.122
- $ dch -p -v 1.3.122-0.local.1 "Local build."
- $ debuild
+ $ tar xzf lilypond-1.4.3.tar.gz
+ $ cd lilypond-1.4.3
+ $ dch -p -v 1.4.3-0.local.1 "Local build."
+ $ debuild -B
$ su - root
- # dpkg -i ../lilypond1.3_1.3.122*.deb
+ # dpkg -i ../lilypond_1.4.3*.deb
# exit
$
+ Use command `debuild' instead of `debuild -B' if you have a very
+fast machine and want to build the HTML, PS and DVI documentation too.
+
For compilation on a Debian GNU/Linux system you need these packages,
in addition to the those needed for running:
- * g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
+ * g++, cpp, libc6-dev, libstdc++<YOUR-LIBSTDC++-VERSION-HERE>-dev
- * libguile<your-libguile-version-here>-dev
+ * libguile<YOUR-LIBGUILE-VERSION-HERE>-dev
* make, m4, flex, bison
* gettext
- * groff, texinfo, bibtex2html (not in 2.2r2)
+ * groff, texinfo
* tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
* dpkg-dev, debhelper, fakeroot
- * gs, netpbm, pnmtopng
+ * gs, netpbm
+
+ * pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
+ in Debian testing/unstable.)
- Most of these are listed on the Build-Depends line in the
-debian/control file. To ensure the creation of the lilypond deb is
+ Most of these are listed on the `Build-Depends' line in the
+`debian/control' file. To ensure the creation of the lilypond deb is
trouble-free, we recommend that you first install the following packages
-before starting dpkg-buildpackage by running apt-get as root.
+by running \`apt-get' as root before building the package:
- For Debian 2.2 (or 2.2r2, 2.2r3):
+ For Debian 2.2:
apt-get install task-debian-devel task-c++-dev \
python-base libguile6-dev tetex-bin tetex-dev \
For Debian in development ("unstable", the future 2.3 or 3.0):
- apt-get install task-debian-devel task-c++-dev \
- python-base libguile9-dev tetex-bin libkpathsea-dev \
- tetex-extra flex bison texinfo bibtex2html groff gs \
- netpbm pnmtopng m4 gettext
+ apt-get install binutils cpp gcc libc6-dev \
+ g++ libstdc++2.10-dev \
+ python-base libguile-dev tetex-bin libkpathsea-dev \
+ tetex-extra flex bison texinfo groff gs \
+ netpbm m4 gettext
And, just so that old fonts from previous versions of LilyPond won't
interfere with your build, you may want to do this before the build too:
dpkg --purge lilypond lilypond1.3
+MacOS X
+-------
+
+ LilyPond has been built on Darwin, to be precise, on:
+ Darwin buoux.aspiratie.nl 5.3 Darwin Kernel Version 5.3: Thu Jan 24
+ 22:06:02 PST 2002; root:xnu/xnu-201.19.obj~1/RELEASE_PPC Power Macintosh powerpc
+
+ using:
+
+ Apple Computer, Inc. version gcc-932.1, based on gcc version 2.95.2 19991024 (release)
+
+ To make sure you have all packages needed to build LilyPond
+installed, run as root:
+
+ apt-get install bash python guile debianutils flex bison texinfo \
+ ghostscript6 netpbm m4 gettext
+
+ and:
+
+ fink install tetex
+
+ For more information about `apt-get' and `fink', see
+fink.sourceforge.net (http://fink.sf.net).
+
+ Then, configure, patch, make and install LilyPond using these
+commands:
+
+ CC="cc -I/sw/include" CXX="c++ -I/sw/include" LDFLAGS="-L/sw/lib" \
+ ./configure --prefix=/sw
+ make -C lily out/parser.hh out/parser.cc out/config.h
+ patch -p0 < darwin.patch
+ make -C lily out/parser.o
+ make DEPENDENCIES_OUTPUT=/dev/null all
+ make install
+
+ For installing, you must be root, of course.
+
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. If you find bugs, please send bug reports to
-<bug-gnu-music@gnu.org>.
+ For help and questions use <lilypond-user@gnu.org>. Please consult
+the FAQ before mailing your problems. If you find bugs, please send
+bug reports to <bug-lilypond@gnu.org>.
Bugs that are not fault of LilyPond are documented here.
+FLex-2.5.4a and gcc-3.0
+-----------------------
+
+ Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
+LilyPond with gcc-3.0 you may do:
+
+ CC=gcc-3.0 CXX=g++-3.0 ./configure --enable-config=gcc-3.0
+ make conf=gcc-3.0 -C lily out-gcc-3.0/lexer.cc
+ patch -p1 < lexer-gcc-3.0.patch
+ make conf=gcc-3.0 -C lily
+
+ Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
+
+Linux-2.4.0, Guile-1.4 -with-threads
+------------------------------------
+
+ There's a bug in certain kernels around version 2.4.0, that is
+triggered when using Guile 1.4 compiled with pthreads. You'll see
+random segmentation fault crashes of LilyPond. Upgrade to a newer
+version of Linux. If you can't do that, you may try to recompiling
+Guile without threads (YMMV):
+
+ guile-1.4$ ./configure --without-threads; make all install
+
NetBSD
-******
+------
* The flex precompiled in NetBSD-1.4.2 is broken. Download
flex-2.5.4a, build, install.
Solaris:
-********
+--------
* Sparc64/Solaris 2.6, GNU make-3.77
Not yet resolved.
AIX
-***
+---
* AIX 4.3 ld
projects / lilypond.git / blobdiff