]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
* Ignore test failures on non-i386/amd64 architectures (Closes:
[lilypond.git] / INSTALL.txt
index 378400dc449ef12e2db9fb6ddb23dfb99c39bf72..09be506e995f928b8332a23c1bdee4f0579d6ef4 100644 (file)
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
 
+Table of Contents
+*****************
 
 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
 
-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 handy when you have to compile LilyPond
-more often.
+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).
 
-Obtaining
-=========
+   Building LilyPond is a very involved process, so we *highly*
+recommend using the precompiled binaries.
 
-   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/).
+Precompiled binaries
+====================
 
-   _If you upgrade by patching do remember to rerun autoconf after
-applying the patch_.
+Downloading
+-----------
 
-   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/'.
+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/'
 
-   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
+   We currently create binaries for
 
-Prerequisites
-=============
+     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
 
-   For compilation you need:
 
-   * A GNU system: GNU LilyPond is known to run on these GNU systems:
-     Linux     (PPC, intel), FreeBSD, AIX, NeXTStep, IRIX, Digital Unix
-     and Solaris.
+Known issues and warnings
+.........................
 
-   * 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'.
+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.
 
-   * Although we recommend to use Unix, LilyPond is known to run on
-     Windows NT/95/98 as well.  See Section Windows NT/95,es.
+Compiling from source
+=====================
 
-   * EGCS 1.1 or newer. Check out `ftp://ftp.gnu.org/gnu/gcc/'.
+Downloading source code
+-----------------------
 
-   * Python 1.5, Check out `ftp://ftp.python.org' or
-     `ftp://ftp.cwi.nl/pub/python'.
+Download source
 
-   * 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.
+   * tarballs from `http://lilypond.org/download/' by HTTP.
 
-   * GNU Make.  Check out ftp://ftp.gnu.org/gnu/make/
-     (ftp://ftp.gnu.org/gnu/make/).
+   * tarballs from `http://download.linuxaudio.org/lilypond/' by HTTP.
 
-   * Flex (version 2.5.4 or newer).  Check out
-     ftp://ftp.gnu.org/gnu/flex/ (ftp://ftp.gnu.org/gnu/flex/).
+   * GIT from git.sv.gnu.org
+     (http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary)
 
-   * Bison (version 1.25 or newer).  Check out
-     ftp://ftp.gnu.org/gnu/bison/ (ftp://ftp.gnu.org/gnu/bison/).
+          git clone git://git.sv.gnu.org/lilypond.git
 
-   * 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.
+     The repository does not contain generated files.  To create
+     `configure', run
+          ./autogen.sh
 
-   * 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.
+   For information on packaging, see `http://lilypond.org/devel'.
 
-   * 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)
+Requirements
+------------
 
-   * 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.
+Compilation
+...........
 
-     If you do not want to use PostScript output, edit `mf/GNUmakefile'.
+In addition to the packages needed for running LilyPond (see below), you
+need the following extra packages for building.
 
-   * kpathsea, a library for searching (TeX) files.  `kpathsea' is
-     usually included with your installation of TeX.
+   When installing a binary package FOO, you may need to install the
+FOO-devel, libFOO-dev or FOO-dev package too.
 
+   * FontForge (http://fontforge.sf.net/) 20060125 or newer.
 
-Running
-=======
+   * 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.
 
-   GNU LilyPond does use a lot of resources. For operation you need the
-following software
+   * t1utils (http://www.lcdf.org/~eddietwo/type/#t1utils) (version
+     1.33 or newer recommended).
 
-   * TeX.
+   * 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'.
 
-   * 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 (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.
 
-   * GUILE 1.3.4, check out http://www.gnu.org/software/guile/
-     (http://www.gnu.org/programs/guile.html)
+   * Texinfo (ftp://ftp.gnu.org/gnu/texinfo/) (version 4.11 or newer).
 
-   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 GNU c++ compiler (http://gcc.gnu.org/) (version 3.4 or newer.
+     4.x is strongly recommended).
 
-   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.
+   * Python (http://www.python.org) (version 2.4 or newer)
 
-   LilyPond is a hiddeously big, slow and bloated program.  A fast CPU
-and plenty of RAM is recommended for comfortable use.
+   * GNU Make (ftp://ftp.gnu.org/gnu/make/) (version 3.78 or newer).
 
-Website
-=======
+   * gettext (http://www.gnu.org/software/gettext/gettext.html)
+     (version 0.17 or newer).
 
-   The website is the most convenient form to use for reading the
-documentation on-line documentation. It is made by entering
+   * Flex (http://www.gnu.org/software/flex/).
 
-       make htmldoc
-   This does require a  functioning  LilyPond. The binary doesn't have
-to be installed.
+   * Perl (http://www.perl.org/).
 
-   If you want to auto-generate Lily's website, you'll need some
-additional conversion tools.
+   * GNU Bison (http://www.gnu.org/software/bison/).
 
-   * 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)
+   * All packages required for running, including development packages
+     with header files and libraries.
 
-   * 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
 
-     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.
+Running requirements
+....................
 
-           tar xzf libgr-2.0.13.tar.gz
-                make
-                cd png
-                rm libpng.so*
-                make pnmtopng
+Running LilyPond requires proper installation of the following software
 
-     You can then install the new pnmtopng into `/usr/local/bin/'
+   * Freetype (http://www.freetype.org/) (version 2.1.10 or newer).
 
-   * 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).
+   * FontConfig (http://fontconfig.org/) (version 2.2 or newer).
 
-     The website will build without this utility, but you will not see
-     our hypertextified bibliography.
+   * Pango (http://www.pango.org/) (version 1.12 or newer).
 
-   * DOC++ (http://www.zib.de/Visual/software/doc++/index.html)     A
-     documentation system for C++ sources, which is used for the
-     LilyPond sources.
+   * 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'.
 
-Configuring and compiling
-=========================
+   * Python (http://www.python.org) (version 2.4 or newer).
 
-   to install GNU LilyPond, simply type:
+   * Ghostscript (http://www.ghostscript.com) (version 8.15 or newer.
+     8.60 recommended)
 
-       gunzip -c lilypond-x.y.z | tar xf -
-       cd lilypond-x.y.z
-       ./configure             # fill in your standard prefix with --prefix
-       make
-       make install
+   * Dejaview.  (This is normally installed by default)
 
-   This will install a number of files, something close to:
+   International fonts are required to create music with international
+text or lyrics.
 
-       /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
+Requirements for building documentation
+.......................................
 
-   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:
+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:
 
+   * The netpbm utilities (http://netpbm.sourceforge.net/)
 
-       export CPPFLAGS="-I /home/me/my_include -DWEIRD_FOOBAR"
-       ./configure
+   * ImageMagick
 
-   `CPPFLAGS' are the preprocessor flags.
+   * International fonts (see input/regression/utf-8.ly for hints about
+     which font packages are necessary for your platform)
 
-   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
+   * 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'.
 
+   * Texi2HTML (http://www.nongnu.org/texi2html/) 1.80 or newer
 
-       ./configure --prefix=$HOME/usr
+   * rsync
 
-   In this case, you will have to set up MFINPUTS, and TEXINPUTS
-accordingly.
+Building LilyPond
+-----------------
 
-   Since GNU LilyPond currently is beta, you are advised to also use
+Compiling
+.........
 
+To install GNU LilyPond, type
 
-       --enable-debugging
-       --enable-checking
+     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'
 
-   Options to configure include:
+If you are not root, you should choose a `--prefix' argument that
+points into your home directory, e.g.
 
-``--enable-printing''
-     Enable debugging print routines (lilypond `-D' option)
+     ./configure --prefix=$HOME/usr
 
-``--enable-optimise''
-     Set maximum optimisation: compile with `-O2'.  This can be
-     unreliable on some compiler/platform combinations (eg, DEC Alpha
-     and PPC)
+Compiling for multiple platforms
+................................
 
-``--enable-profiling''
-     Compile with support for profiling.
+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
 
-``--enable-config''
-     Output to a different configuration file.  Needed for
-     multi-platform     builds
+     ./configure --prefix=$HOME/usr/ --enable-checking
+     make
+     make install
 
-   All options are documented in the `configure' help The option
-`--enable-optimise' is recommended for Real Life usage.
+   and for the profiling version, specify a different configuration
 
-   If you do
+     ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+     make conf=prof
+     make conf=prof install
 
+Compiling outside the source tree
+.................................
 
-       make all
+It is possible to compile LilyPond in a build tree different from the
+source tree, with `--srcdir' option of `configure':
 
-   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).
+     mkdir lily-build && cd lily-build
+     SOURCEDIR/configure --srcdir=SOURCEDIR
 
-Configuring for multiple platforms
-==================================
+Useful `make' variables
+.......................
 
-   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 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
+----------------------
 
-           ./configure --prefix=~ --disable-optimise --enable-checking
-           make
-           make install
+This requires a successful compile of LilyPond, or using an external
+LilyPond binary.
 
-   and for the profiling version, I specify a different configuration.
+Commands for building documentation
+...................................
 
+The documentation is built by issuing
 
-           ./configure --prefix=~ --enable-profiling --enable-config=optprof --enable-optimise --disable-checking
-           make config=optprof
-           make config=optprof install
+     make doc
 
-Installing
-==========
+   After compilation, the HTML documentation tree is available in
+`out-www/offline-root/', and can be browsed locally.
 
-   if you have done a successful `make', then a simple
+   The HTML, PDF and if available Info files can be installed into the
+standard documentation path by issuing
 
+     make install-doc
 
-       make install
+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.
 
-   should do the trick.
+   Compilation of documentation in Info format with images can be done
+separately by issuing
 
-   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'.
+     make info
 
-Redhat linux
-============
+Separate installation of this documentation is done by issuing
 
-   RedHat Linux users can compile an RPM. A spec file is in
-`make/out/lilypond.spec', it is distributed along with the sources.
+     make install-info
 
-   You can make the rpm by issuing
+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.
 
-       rpm -tb lilypond-x.y.z.tar.gz
-       rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+   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
 
-   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/).
+     make WEB_TARGETS=online doc
 
-   For compilation on a RedHat system you need these packages, in
-addition to the those needed for running:
-   * glibc-devel
+and both `offline' and `online' targets can be generated by issuing
 
-   * libstdc++-devel
+     make WEB_TARGETS="offline online" doc
 
-   * guile-devel
+   Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
 
-   * flex
+     make help
 
-   * bison
+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_.
 
-   * texinfo
+   The makefile variable `QUIET_BUILD' may be set to `1' for a less
+verbose build output, just like for building the programs.
 
-Debian GNU/linux
-================
 
-   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
-=============
+Known issues and warnings
+.........................
 
-   Separate instructions on building for W32 are available; See the
-files in `Documentation/ntweb/', included with the sources.
+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
 
-Problems
-========
+     make -j3 CPU_COUNT=3 doc
+
+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.
+
+   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.
+
+     touch Documentation/user/*.itely
+     touch input/lsr/*.ly
+
+Building documentation without compiling LilyPond
+.................................................
+
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
+
+   From a fresh Git checkout, do
+
+     ./autogen.sh   # ignore any warning messages
+     cp GNUmakefile.in GNUmakefile
+     make -C python
+     nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
+
+   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.
+
+   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
 
-   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 out=www WWW-post
 
-   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 issues and warnings
+.........................
 
-   Known bugs that are not LilyPond's fault are documented here.
+You may also need to create a script for `pngtopnm' and `pnmtopng'.  On
+GNU/Linux, I use this:
 
-LinuxPPC Bugs:
-**************
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
 
-   * 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/'
+   On MacOS X, I use this:
+
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
+
+Testing LilyPond
+----------------
+
+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
+
+     make test-baseline
+     _## apply your changes, compile_
+     make check
+
+   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.
+
+   To rerun tests, use
+
+     make test-redo           _## redo files differing from baseline_
+     make test-clean          _## remove all test results_
+
+and then run `make check' again.
+
+   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'.
+
+   For checking the coverage of the test suite, do the following
+
+     ./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
+
+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, RedHat 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