-
-
INSTALL - compiling and installing GNU LilyPond
***********************************************
-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/).
-
- _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.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
+Table of Contents
+*****************
-Prerequisites
-=============
-
- For compilation you need:
+INSTALL - compiling and installing GNU LilyPond
+ Precompiled binaries
+ Downloading
+ Compiling from source
+ Downloading source code
+ Requirements
+ Compilation
+ Running requirements
+ Requirements for building documentation
+ Building LilyPond
+ Compiling
+ Compiling for multiple platforms
+ Compiling outside the source tree
+ Useful `make' variables
+ Building documentation
+ Commands for building documentation
+ Building documentation without compiling LilyPond
+ Testing LilyPond
+ Problems
+ Bison 1.875
+ Solaris
+ FreeBSD
+ International fonts
- * A GNU system: GNU LilyPond is known to run on these GNU systems:
- Linux (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
- 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'.
+There are two sets of releases for LilyPond: stable releases, and
+unstable development releases. Stable versions have an even-numbered
+`minor' version number (i.e. 2.8, 2.10, 2.12, etc). Development
+versions have an odd-numbered `minor' version number (i.e. 2.7, 2.9,
+2.11, etc).
- * Although we recommend to use Unix, LilyPond is known to run on
- Windows NT/95/98 as well. See Section Windows NT/95,es.
+ Building LilyPond is a very involved process, so we *highly*
+recommend using the precompiled binaries.
- * A reasonable C++ compiler: EGCS 1.1, GCC 2.95.2 or newer. Check
- out `ftp://ftp.gnu.org/gnu/gcc/'.
+Precompiled binaries
+====================
- * Python 1.5, Check out `ftp://ftp.python.org' or
- `ftp://ftp.cwi.nl/pub/python'.
+Downloading
+-----------
- * 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.
+Check out `http://lilypond.org/web/install/' for up to date information
+on binary packages for your platform. If your operating system is not
+covered on that general page, please see the complete list at
+`http://download.linuxaudio.org/lilypond/binaries/'
- * GNU Make. Check out ftp://ftp.gnu.org/gnu/make/
- (ftp://ftp.gnu.org/gnu/make/).
+ We currently create binaries for
- * Flex (version 2.5.4a or newer). Check out
- ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/
- (ftp://ftp.gnu.org/pub/gnu/non-gnu/flex/).
+ darwin-ppc - MacOS X powerpc
+ darwin-x86 - MacOS X intel
+ freebsd-64 - FreeBSD 6.x, x86_64
+ freebsd-x86 - FreeBSD 4.x, x86
+ linux-64 - Any GNU/Linux distribution, x86_64
+ linux-ppc - Any GNU/Linux distribution, powerpc
+ linux-x86 - Any GNU/Linux distribution, x86
+ mingw - Windows x86
- * Bison (version 1.25 or newer). Check out
- ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
- * 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.
+Known issues and warnings
+.........................
- * 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.
+If you have MacOS 10.3 or 10.4 and you would like to use Python scripts
+such as `convert-ly' and `lilypond-book', see *note Setup for MacOS X:
+(lilypond-program)Setup for MacOS X.
- * 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)
+Compiling from source
+=====================
- * 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.
+Downloading source code
+-----------------------
- If you do not want to use PostScript output, edit `mf/GNUmakefile',
- removing the line saying `PFA_FILES='
+Download source
- * kpathsea, a library for searching (TeX) files. `kpathsea' is
- usually included with your installation of TeX.
+ * tarballs from `http://lilypond.org/download/' by HTTP.
+ * tarballs from `http://download.linuxaudio.org/lilypond/' by HTTP.
-Running
-=======
+ * GIT from git.sv.gnu.org
+ (http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary)
- GNU LilyPond does use a lot of resources. For operation you need the
-following software
+ git clone git://git.sv.gnu.org/lilypond.git
- * TeX.
+ The repository does not contain generated files. To create
+ `configure', run
+ ./autogen.sh
- * A PostScript printer and/or viewer (such as Ghostscript) is
- strongly recommended. Xdvi will show all embedded PostScript
- too if you have Ghostscript installed.
+ For information on packaging, see `http://lilypond.org/devel'.
- * GUILE 1.3.4, or newer. Check out
- http://www.gnu.org/software/guile/
- (http://www.gnu.org/programs/guile.html)
+Requirements
+------------
- 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. Appropriate
-Csh and sh scripts are left in `buildscripts/out/lilypond-profile' and
-`buildscripts/out/lilypond-login' after compilation.
+Compilation
+...........
- 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.
+In addition to the packages needed for running LilyPond (see below), you
+need the following extra packages for building.
- LilyPond is a big and slow program. A fast CPU and plenty of RAM is
-recommended for comfortable use.
+ When installing a binary package FOO, you may need to install the
+FOO-devel, libFOO-dev or FOO-dev package too.
-Website
-=======
+ * FontForge (http://fontforge.sf.net/) 20060125 or newer.
- The website is the most convenient form to use for reading the
-documentation on-line documentation. It is made by entering
+ * MetaFont (http://metafont.tutorial.free.fr/) (mf-nowin, mf, mfw or
+ mfont binaries) and MetaPost
+ (http://cm.bell-labs.com/who/hobby/MetaPost.html) (mpost binary),
+ usually packaged with a LaTeX distribution like tetex or texlive.
+ * t1utils (http://www.lcdf.org/~eddietwo/type/#t1utils) (version
+ 1.33 or newer recommended).
- make web-doc
- This does require a functioning LilyPond. The executable doesn't
-have to be installed, though.
+ * New Century Schoolbook fonts, as PFB files. These are shipped with
+ X11 and Ghostscript, and are named `c059033l.pfb' `c059036l.pfb',
+ `c059013l.pfb' and `c059016l.pfb'.
- If you want to auto-generate Lily's website, you'll need some
-additional conversion tools.
+ * GUILE (http://www.gnu.org/software/guile/guile.html) (version
+ 1.8.2 or newer). If you are installing binary packages, you may
+ need to install guile-devel or guile-dev or libguile-dev too.
- * xpmtoppm (from the netpbm package: 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/contrib/utilities/netpbm-1mar1994.p1.tar.gz
- (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
+ * Texinfo (ftp://ftp.gnu.org/gnu/texinfo/) (version 4.11 or newer).
- * pnmtopng (also in libgr-progs for Red Hat). 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
+ * The GNU c++ compiler (http://gcc.gnu.org/) (version 3.4 or newer.
+ 4.x is strongly recommended).
- The version of `pnmtopng' that is distributed with Red Hat 5.1 and
- 5.2 contains a bug: pnmtopng is dynamically linked to the wrong
- version of libpng.
+ * Python (http://www.python.org) (version 2.4 or newer)
- * 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).
+ * GNU Make (ftp://ftp.gnu.org/gnu/make/) (version 3.78 or newer).
- The website will build without bib converter utility, but you will
- not see our hypertextified bibliography.
+ * gettext (http://www.gnu.org/software/gettext/gettext.html)
+ (version 0.17 or newer).
+ * Flex (http://www.gnu.org/software/flex/).
-Configuring and compiling
-=========================
+ * Perl (http://www.perl.org/).
- 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
+ * GNU Bison (http://www.gnu.org/software/bison/).
- This will install a number of files, something close to:
+ * All packages required for running, including development packages
+ with header files and libraries.
- /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/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/{....}/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:
+Running requirements
+....................
+Running LilyPond requires proper installation of the following software
- export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
- ./configure
+ * Freetype (http://www.freetype.org/) (version 2.1.10 or newer).
- `CPPFLAGS' are the preprocessor flags.
+ * FontConfig (http://fontconfig.org/) (version 2.2 or newer).
- 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
+ * Pango (http://www.pango.org/) (version 1.12 or newer).
+ * GUILE (http://www.gnu.org/software/guile/guile.html) (version
+ 1.8.2 or newer), or patch 1.8.1 with
+ `http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch'.
- ./configure --prefix=$HOME/usr
+ * Python (http://www.python.org) (version 2.4 or newer).
- In this case, you will have to set up MFINPUTS, and TEXINPUTS
-accordingly.
+ * Ghostscript (http://www.ghostscript.com) (version 8.15 or newer.
+ 8.60 recommended)
- Since GNU LilyPond currently is beta, you are advised to also use
+ * Dejaview. (This is normally installed by default)
+ International fonts are required to create music with international
+text or lyrics.
- --enable-debugging
- --enable-checking
+Requirements for building documentation
+.......................................
- Options to configure include:
+You can view the documentation online at `http://lilypond.org/doc/',
+but you can also build it locally. This process requires a successful
+compile of LilyPond, and some additional tools and packages:
-``--enable-printing''
- Enable debugging print routines (lilypond `-D' option)
+ * The netpbm utilities (http://netpbm.sourceforge.net/)
-``--enable-optimise''
- Set maximum optimisation: compile with `-O2'. This can be
- unreliable on some compiler/platform combinations (eg, DEC Alpha
- and PPC)
+ * ImageMagick
-``--enable-profiling''
- Compile with support for profiling.
+ * International fonts (see input/regression/utf-8.ly for hints about
+ which font packages are necessary for your platform)
-``--enable-config=CONF''
- Output to different configuration files. Enables different binary
- builds alongside eachother, eg, multi-configuration (debugging,
- profiling), or multi-platform builds. Use `make conf=CONF' to
- build for a specific configuration.
+ * Ghostscript 8.60 or newer, or 8.50 with the patch from
+ `http://bugs.ghostscript.com/show_bug.cgi?id=688154' and the patch
+ from `http://bugs.ghostscript.com/show_bug.cgi?id=688017'.
- All options are documented in the `configure' help The option
-`--enable-optimise' is recommended for Real Life usage.
+ * Texi2HTML (http://www.nongnu.org/texi2html/) 1.80 or newer
- If you do
+ * rsync
+Building LilyPond
+-----------------
- make all
+Compiling
+.........
- 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).
+To install GNU LilyPond, type
-Emacs mode
-==========
+ gunzip -c lilypond-x.y.z | tar xf -
+ cd lilypond-x.y.z
+ ./configure # run with --help for applicable options
+ make
+ su -c 'make install'
- 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.
+If you are not root, you should choose a `--prefix' argument that
+points into your home directory, e.g.
- Add this to your ~/.emacs or ~/.emacs.el:
- (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)))
+ ./configure --prefix=$HOME/usr
- If you have the latest LilyPond-1.3.x Debian package, LilyPond-mode
-is automatically loaded, so you need not modify your ~/.emacs file.
+Compiling for multiple platforms
+................................
-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
+of `configure'. You should use `make conf=CONF' to generate the output
+in `out-CONF'. For example, suppose you want to build with and without
+profiling, then use the following for the normal build
- If you want to build multiple versions of LilyPond with different
-configuration settings, you can use the `--enable-config=CONF' option.
-You should use `make conf=CONF' to generate the output in `out-CONF'.
-Example: suppose I want to build with and without profiling. Then I'd
-use the following for the normal build,
+ ./configure --prefix=$HOME/usr/ --enable-checking
+ make
+ make install
+ and for the profiling version, specify a different configuration
- ./configure --prefix=~ --disable-optimise --enable-checking
- make
- make install
+ ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
- and for the profiling version, I specify a different configuration.
+Compiling outside the source tree
+.................................
+It is possible to compile LilyPond in a build tree different from the
+source tree, with `--srcdir' option of `configure':
- ./configure --prefix=~ --enable-profiling --enable-config=prof --enable-optimise --disable-checking
- make conf=prof
- make conf=prof install
+ mkdir lily-build && cd lily-build
+ SOURCEDIR/configure --srcdir=SOURCEDIR
-Installing
-==========
+Useful `make' variables
+.......................
- if you have done a successful `make', then a simple
+If a less verbose build output if desired, the variable `QUIET_BUILD'
+may be set to `1' on `make' command line, or in `local.make' at top of
+the build tree.
+Building documentation
+----------------------
- make install
+This requires a successful compile of LilyPond, or using an external
+LilyPond binary.
- should do the trick.
+Commands for building documentation
+...................................
- 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'.
+The documentation is built by issuing
-Red Hat Linux
-=============
+ make doc
- Red Hat Linux users can compile an RPM. A spec file is in
-`make/out/lilypond.spec'; it is distributed along with the sources.
+ After compilation, the HTML documentation tree is available in
+`out-www/offline-root/', and can be browsed locally.
- You can make the rpm by issuing
+ The HTML, PDF and if available Info files can be installed into the
+standard documentation path by issuing
- rpm -tb lilypond-x.y.z.tar.gz
- rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+ make install-doc
- Precompiled Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
+This also installs Info documentation with images if the installation
+prefix is properly set; otherwise, instructions to complete proper
+installation of Info documentation are printed on standard output.
- For compilation on a Red Hat system you need these packages, in
-addition to the those needed for running:
- * glibc-devel
+ Compilation of documentation in Info format with images can be done
+separately by issuing
- * libstdc++-devel
+ make info
- * guile-devel
+Separate installation of this documentation is done by issuing
- * flex
+ make install-info
- * bison
+Note that to get the images in Info documentation, `install-doc' target
+creates symbolic links to HTML and PDF installed documentation tree in
+`PREFIX/share/info', in order to save disk space, whereas
+`install-info' copies images in `PREFIX/share/info' subdirectories.
- * texinfo
+ It is possible to build a documentation tree in
+`out-www/online-root/', with special processing, so it can be used on a
+website with content negotiation for automatic language selection; this
+can be achieved by issuing
- * tetex-devel
+ make WEB_TARGETS=online doc
-SuSE
-====
+and both `offline' and `online' targets can be generated by issuing
- [TODO: document this]
+ make WEB_TARGETS="offline online" doc
- Install `tetex', `te_mpost', `te_kpath'.
+ Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
-Debian GNU/Linux
-================
+ make help
- A Debian package is also available. You may install it easily by
-using apt-get as root:
+from every directory in the build tree. Most targets for documentation
+maintenance are available from `Documentation/'; for more information,
+see the Contributors' Guide, section _Documentation work_.
- apt-get install lilypond1.3
+ The makefile variable `QUIET_BUILD' may be set to `1' for a less
+verbose build output, just like for building the programs.
- 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;
+Known issues and warnings
+.........................
- * 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.
+The most time consuming task for building the documentation is running
+LilyPond to build images of music, and there cannot be several
+simultaneously running `lilypond-book' instances, so `-j' `make' option
+does not significantly speed up the build process. To help speed it
+up, the makefile variable CPU_COUNT may be set in `local.make' or on
+the command line to the number of `.ly' files that LilyPond should
+process simultaneously, e.g. on a bi-processor or dual core machine
- You may contact Anthony Fok <foka@debian.org> for more information.
+ make -j3 CPU_COUNT=3 doc
- The build scripts are in the subdirectory `debian/'; you can make
-the .deb by doing, for example:
+The recommended value of CPU_COUNT is one plus the number of cores or
+processors, but it is advisable to set it to a smaller value if your
+system has not enough RAM to run that many simultaneous LilyPond
+instances.
- $ 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
- $ su - root
- # dpkg -i ../lilypond1.3_1.3.122*.deb
- # exit
- $
+ If source files have changed since last documentation build, output
+files that need to be rebuilt are normally rebuilt, even if you do not
+run `make doc-clean' first. However, building dependencies in the
+documentation are so complex that rebuilding of some targets may not be
+triggered as they should be; a workaround is to force rebuilding by
+touching appropriate files, e.g.
- For compilation on a Debian GNU/Linux system you need these packages,
-in addition to the those needed for running:
+ touch Documentation/user/*.itely
+ touch input/lsr/*.ly
- * g++, cpp, libc6-dev, libstdc++<your-libstdc++-version-here>-dev
+Building documentation without compiling LilyPond
+.................................................
- * libguile<your-libguile-version-here>-dev
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
- * make, m4, flex, bison
+ From a fresh Git checkout, do
- * gettext
+ ./autogen.sh # ignore any warning messages
+ cp GNUmakefile.in GNUmakefile
+ make -C python
+ nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
- * groff, texinfo, bibtex2html (not in 2.2r2)
+ Please note that this may break sometimes - for example, if a new
+feature is added with a test file in input/regression, even the latest
+development release of LilyPond will fail to build the docs.
- * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+ You may build the manual without building all the `input/*' stuff:
+change directory, for example to `Documentation/user', issue `make
+doc', which will build documentation in a subdirectory `out-www' from
+the source files in current directory. In this case, if you also want
+to browse the documentation in its post-processed form, change back to
+top directory and issue
- * dpkg-dev, debhelper, fakeroot
+ make out=www WWW-post
- * gs, netpbm, pnmtopng
- 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.
+Known issues and warnings
+.........................
- For Debian 2.2 (or 2.2r2, 2.2r3):
+You may also need to create a script for `pngtopnm' and `pnmtopng'. On
+GNU/Linux, I use this:
- apt-get install task-debian-devel task-c++-dev \
- python-base libguile6-dev tetex-bin tetex-dev \
- tetex-extra flex bison texinfo groff gs \
- netpbm pnmtopng m4 gettext
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
- For Debian in development ("unstable", the future 2.3 or 3.0):
+ On MacOS X, I use this:
- 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
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
- 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:
+Testing LilyPond
+----------------
- dpkg --purge lilypond lilypond1.3
+LilyPond comes with an extensive suite that exercises the entire
+program. This suite can be used to automatically check the impact of a
+change. This is done as follows
-Windows NT/95
-=============
+ make test-baseline
+ _## apply your changes, compile_
+ make check
- Separate instructions on building for W32 are available; See the
-files in `Documentation/ntweb/', included with the sources.
+ This will leave an HTML page `out/test-results/index.html'. This
+page shows all the important differences that your change introduced,
+whether in the layout, MIDI, performance or error reporting.
-Problems
-========
+ To rerun tests, use
- 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 test-redo _## redo files differing from baseline_
+ make test-clean _## remove all test results_
- If you find bugs, please send bug reports to <bug-gnu-music@gnu.org>.
+and then run `make check' again.
- Bugs that are LilyPond's fault are listed in our TODO list on the
-web, or demonstrated in `input/bugs/'.
+ For tracking memory usage as part of this test, you will need GUILE
+CVS; especially the following patch:
+`http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch'.
- Bugs that are not LilyPond's fault are documented here.
+ For checking the coverage of the test suite, do the following
-LinuxPPC Bugs:
-**************
+ ./scripts/auxiliar/build-coverage.sh
+ _# uncovered files, least covered first_
+ ./scripts/auxiliar/coverage.py --summary out-cov/*.cc
+ _# consecutive uncovered lines, longest first_
+ ./scripts/auxiliar/coverage.py --uncovered out-cov/*.cc
- * 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/'
+Problems
+--------
- * egcs-1.0.2 (LinuxPPC R4): all compiling with `-O2' is suspect, in
- particular guile-1.3, and Lily herself will break.
+For help and questions use <lilypond-user@gnu.org>. Send bug reports
+to <bug-lilypond@gnu.org>.
-Linux-i386
-**********
+ Bugs that are not fault of LilyPond are documented here.
- * SuSE6.2 and similar platforms (glibc 2.1, libstdc++ 2.9.0)
+Bison 1.875
+...........
- Lily will crash during parsing (which suggests a C++ library
- incompatibility). Precise cause, precise platform description or
- solution are not known.
+There is a bug in bison-1.875: compilation fails with "parse error
+before `goto'" in line 4922 due to a bug in bison. To fix, please
+recompile bison 1.875 with the following fix
- Note that this only happens on some computers with the said
- platform.
+ $ cd lily; make out/parser.cc
+ $ vi +4919 out/parser.cc
+ # append a semicolon to the line containing "__attribute__ ((__unused__))
+ # save
+ $ make
- * libg++ 2.7
+Solaris
+.......
- LilyPond occasionally crashes while parsing the initialisation
- files. This is a very obscure bug, and usually entering the
- commandline differently "fixes" it.
+Solaris7, ./configure
- lilypond input.ly
+ `./configure' needs a POSIX compliant shell. On Solaris7, `/bin/sh'
+is not yet POSIX compliant, but `/bin/ksh' or bash is. Run configure
+like
- and
- lilypond -I. ./input.ly
- makes a difference
+ CONFIG_SHELL=/bin/ksh ksh -c ./configure
- Typical stacktrace:
- SIGSEGV
- __libc_malloc (bytes=16384)
- ?? ()
- yyFlexLexer::yy_create_buffer ()
- Includable_lexer::new_input (this=0x8209a00, s={strh_ = {
+or
- This behaviour has been observed with machines that have old libg++
- versions (LinuxPPC feb '98, Red Hat 4.x).
+ CONFIG_SHELL=/bin/bash bash -c ./configure
-Solaris:
-********
+FreeBSD
+.......
- * Sparc64/Solaris 2.6, GNU make-3.77
+To use system fonts, dejaview must be installed. With the default
+port, the fonts are installed in `usr/X11R6/lib/X11/fonts/dejavu'.
- GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
- newer.
+ Open the file `$LILYPONDBASE/usr/etc/fonts/local.conf' and add the
+following line just after the `<fontconfig>' line. (Adjust as necessary
+for your hierarchy.)
- * Sparc64/Solaris 2.6, ld
+ <dir>/usr/X11R6/lib/X11/fonts</dir>
- Not yet resolved.
+International fonts
+...................
-AIX
-***
+On MacOS X, all fonts are installed by default. However, finding all
+system fonts requires a bit of configuration; see this post
+(http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html)
+on the `lilypond-user' mailing list.
- * AIX 4.3 ld
+ On Linux, international fonts are installed by different means on
+every distribution. We cannot list the exact commands or packages that
+are necessary, as each distribution is different, and the exact package
+names within each distribution changes. Here are some hints, though:
- 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.
+Red Hat Fedora
- 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.
+ taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
+ ttfonts-zh_CN fonts-ja fonts-hebrew
- add -Wl,-bbigtoc to USER_LDFLAGS, ie:
- LDFLAGS='-Wl,-bbigtoc' ./configure
+Debian GNU/Linux
+ apt-get install emacs-intl-fonts xfonts-intl-.* \
+ ttf-kochi-gothic ttf-kochi-mincho \
+ xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi