]> git.donarmstrong.com Git - lilypond.git/blobdiff - INSTALL.txt
* Ignore test failures on non-i386/amd64 architectures (Closes:
[lilypond.git] / INSTALL.txt
index 411a5e943f38955be1e53d24baab5c8fdc04f32f..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
+
+
+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).
+
+   Building LilyPond is a very involved process, so we *highly*
+recommend using the precompiled binaries.
+
+Precompiled binaries
+====================
+
+Downloading
+-----------
+
+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/'
+
+   We currently create binaries for
+
+     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
+
+
+Known issues and warnings
+.........................
 
-Obtaining
-=========
+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.
 
-   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/).
+Compiling from source
+=====================
 
-   There are three options for downloading sources.
+Downloading source code
+-----------------------
 
-   * if you don't have any version, then you can  download  the entire
-     `.tar.gz' file.
+Download source
 
-   * if you have an unpacked source   tree of a previous version, you
-     may use the diffs .
+   * tarballs from `http://lilypond.org/download/' by HTTP.
 
-     _If you upgrade by patching do remember to rerun autoconf after
-     applying the patch_.
+   * tarballs from `http://download.linuxaudio.org/lilypond/' by HTTP.
 
-   * if you have the `.tar.gz' file of a previous release, you can use
-     xdelta (ftp://ftp.xcf.berkeley.edu/pub/xdelta/).   This is much
-     safer than using normal diffs, and is the recommended way.
+   * GIT from git.sv.gnu.org
+     (http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary)
 
-     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
+          git clone git://git.sv.gnu.org/lilypond.git
 
-Build requirements
-==================
+     The repository does not contain generated files.  To create
+     `configure', run
+          ./autogen.sh
 
-   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 Jan's windows page
-(http://appel.lilypond.org/lilypond/gnu-windows/).
+   For information on packaging, see `http://lilypond.org/devel'.
 
-   You need the following packages to compile Lilypond.
+Requirements
+------------
 
-   * 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/).
+Compilation
+...........
 
-   * Python 1.5, Check out the python website (http://www.python.org).
+In addition to the packages needed for running LilyPond (see below), you
+need the following extra packages for building.
 
-   * GUILE 1.3.4 or newer,  check out the GUILE webpage
-     (http://www.gnu.org/software/guile/guile.html).  Version 1.4 is
-     recommended for better performance.
+   When installing a binary package FOO, you may need to install the
+FOO-devel, libFOO-dev or FOO-dev package too.
 
-   * GNU Make.  Check out the GNU make FTP directory
-     (ftp://ftp.gnu.org/gnu/make/).
+   * FontForge (http://fontforge.sf.net/) 20060125 or newer.
 
-   * Flex (version 2.5.4a or newer).  Check out the Flex webpage
-     (http://www.gnu.org/software/flex/).
+   * 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.
 
-   * Bison (version 1.25 or newer).  Check out the bison webpage
-     (http://www.gnu.org/software/bison/)
+   * 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'.
 
-     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.
+   * 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.
 
-   * Texinfo (version 4.0 or newer).  The documentation of lily is
-     written in texinfo.  Check out the texinfo FTP directory
-     (ftp://ftp.gnu.org/gnu/texinfo/).
+   * Texinfo (ftp://ftp.gnu.org/gnu/texinfo/) (version 4.11 or newer).
 
-   * The geometry package for LaTeX is needed to use ly2dvi.  It is
-     available at the FTP directory for `geometry'
-     (ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/supported/geometry).
-     This package is normally included with the TeX distribution.
+   * The GNU c++ compiler (http://gcc.gnu.org/) (version 3.4 or newer.
+     4.x is strongly recommended).
 
-   * 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.
+   * Python (http://www.python.org) (version 2.4 or newer)
 
-     If you don't have MetaPost and don't want to use PostScript
-     output, then edit `mf/GNUmakefile', removing the line saying
-     `PFA_FILES='.
+   * GNU Make (ftp://ftp.gnu.org/gnu/make/) (version 3.78 or newer).
 
-   * kpathsea, a library for searching (TeX) files.  `kpathsea' is
-     usually included with your installation of TeX.
+   * gettext (http://www.gnu.org/software/gettext/gettext.html)
+     (version 0.17 or newer).
+
+   * Flex (http://www.gnu.org/software/flex/).
+
+   * Perl (http://www.perl.org/).
+
+   * GNU Bison (http://www.gnu.org/software/bison/).
+
+   * All packages required for running, including development packages
+     with header files and libraries.
 
 
 Running requirements
-====================
+....................
 
-   GNU LilyPond does use a lot of resources. For operation you need the
-following software
+Running LilyPond requires proper installation of the following software
 
-   * TeX.
+   * Freetype (http://www.freetype.org/) (version 2.1.10 or newer).
 
-   * Xdvi and ghostscript
+   * FontConfig (http://fontconfig.org/) (version 2.2 or newer).
 
-   * GUILE 1.3.4, or newer.  Check out the GUILE webpage
-     (http://www.gnu.org/software/guile.html)
+   * Pango (http://www.pango.org/) (version 1.12 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. Appropriate
-Csh and bourne sh scripts are left in
-`buildscripts/out/lilypond-profile' and
-`buildscripts/out/lilypond-login' after compilation.
+   * 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'.
 
-   LilyPond is a big and slow program.  A fast CPU and plenty of RAM is
-recommended for comfortable use.
+   * Python (http://www.python.org) (version 2.4 or newer).
 
-Website requirements
-====================
+   * Ghostscript (http://www.ghostscript.com) (version 8.15 or newer.
+     8.60 recommended)
+
+   * Dejaview.  (This is normally installed by default)
+
+   International fonts are required to create music with international
+text or lyrics.
 
-   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
-requires a successful compile of lilypond. The website is built by
-issuing
+Requirements for building documentation
+.......................................
 
-       make web-doc
+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:
 
-   Building the website requires  some additional tools:
+   * The netpbm utilities (http://netpbm.sourceforge.net/)
 
-   * xpmtoppm (from the netpbm package: the Portable Bitmap Utilities).
-     The original is at the netpbm FTP site
-     (ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.p1.tar.gz)
+   * ImageMagick
 
-   * pnmtopng. The original is at in the pnmtopng FTP site
-     (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
+   * International fonts (see input/regression/utf-8.ly for hints about
+     which font packages are necessary for your platform)
 
-   * 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).
+   * 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'.
 
-     The website will build without bib converter utility, but you will
-     not see our hypertextified bibliography.
+   * Texi2HTML (http://www.nongnu.org/texi2html/) 1.80 or newer
 
+   * rsync
 
-Configuring and compiling
-=========================
+Building LilyPond
+-----------------
 
-   to install GNU LilyPond, type:
-       gunzip -c lilypond-x.y.z | tar xf -
-       cd lilypond-x.y.z
-       ./configure             # run with --help to see appropriate options
-       make
-       make install
-             sh buildscripts/clean-fonts.sh
+Compiling
+.........
 
-   If you are doing an upgrade, you should remove all `feta' `.pk' and
-`.tfm' files.  A script has been provided to do the work for you, see
-`buildscripts/clean-fonts.sh'.
+To install GNU LilyPond, type
 
-   If you are not root, you should choose a `--prefix' argument that
-points into your home directory, eg.
+     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'
 
-       ./configure --prefix=$HOME/usr
+If you are not root, you should choose a `--prefix' argument that
+points into your home directory, e.g.
 
-   In this case, you have to insert the contents of
-`buildscripts/out/lilypond-login' or
-`buildscripts/out/lilypond-profile' into your start up scripts by hand.
+     ./configure --prefix=$HOME/usr
 
-Configuring for multiple platforms
-==================================
+Compiling for multiple platforms
+................................
 
-   If you want to build multiple versions of LilyPond with different
+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'.  Example: suppose I want to build with and without
-profiling.  Then I'd use the following for the normal build,
+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
 
-           ./configure --prefix=~ --enable-checking
-           make
-           make install
+     ./configure --prefix=$HOME/usr/ --enable-checking
+     make
+     make install
 
-   and for the profiling version, I specify a different configuration.
+   and for the profiling version, specify a different configuration
 
+     ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+     make conf=prof
+     make conf=prof install
 
-           ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
-           make conf=prof
-           make conf=prof install
+Compiling outside the source tree
+.................................
 
-Emacs mode
-==========
+It is possible to compile LilyPond in a build tree different from the
+source tree, with `--srcdir' option of `configure':
 
-   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.
+     mkdir lily-build && cd lily-build
+     SOURCEDIR/configure --srcdir=SOURCEDIR
 
-   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)))
+Useful `make' variables
+.......................
 
-   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 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.
 
-Red Hat Linux
-=============
+Building documentation
+----------------------
 
-   Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/RedHat/'.
+This requires a successful compile of LilyPond, or using an external
+LilyPond binary.
 
-   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
+Commands for building documentation
+...................................
 
-       rpm -tb lilypond-x.y.z.tar.gz
-       rpm -i /usr/src/redhat/RPMS/i386/lilypond-x.y.z
+The documentation is built by issuing
 
-   For running on a Red Hat system you need these packages: guile,
-tetex, tetex-dvips, libstdc++, python, ghostscript.
+     make doc
 
-   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.
+   After compilation, the HTML documentation tree is available in
+`out-www/offline-root/', and can be browsed locally.
 
-SuSE
-====
+   The HTML, PDF and if available Info files can be installed into the
+standard documentation path by issuing
 
-   [TODO: document this]
+     make install-doc
 
-   Install `tetex', `te_mpost', `te_kpath'.
+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.
 
-Mandrake
-========
+   Compilation of documentation in Info format with images can be done
+separately by issuing
 
-   [TODO]
+     make info
 
-Debian GNU/Linux
-================
+Separate installation of this documentation is done by issuing
+
+     make install-info
 
-   A Debian package is also available.  You may install it easily by
-using apt-get as root:
+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.
 
-       apt-get install lilypond1.3
+   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
 
-   Alternatively, visit
+     make WEB_TARGETS=online doc
 
-   * http://packages.debian.org/lilypond
-     (http://packages.debian.org/lilypond)
+and both `offline' and `online' targets can be generated by issuing
 
-   * 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;
+     make WEB_TARGETS="offline online" doc
 
-   * 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.
+   Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
 
-   You may contact Anthony Fok <foka@debian.org> for more information.
+     make help
 
-   The build scripts are in the subdirectory `debian/'; you can make
-the .deb by doing, for example:
+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_.
 
-       $ 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
-       $
+   The makefile variable `QUIET_BUILD' may be set to `1' for a less
+verbose build output, just like for building the programs.
 
-   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
 
-   * libguile<your-libguile-version-here>-dev
+Known issues and warnings
+.........................
 
-   * make, m4, flex, bison
+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
 
-   * gettext
+     make -j3 CPU_COUNT=3 doc
 
-   * groff, texinfo, bibtex2html (not in 2.2r2)
+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.
 
-   * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+   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.
 
-   * dpkg-dev, debhelper, fakeroot
+     touch Documentation/user/*.itely
+     touch input/lsr/*.ly
 
-   * gs, netpbm, pnmtopng
+Building documentation without compiling LilyPond
+.................................................
 
-   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.
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
 
-   For Debian 2.2 (or 2.2r2, 2.2r3):
+   From a fresh Git checkout, do
 
-       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
+     ./autogen.sh   # ignore any warning messages
+     cp GNUmakefile.in GNUmakefile
+     make -C python
+     nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
 
-   For Debian in development ("unstable", the future 2.3 or 3.0):
+   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.
 
-       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
+   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
 
-   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:
+     make out=www WWW-post
 
-       dpkg --purge lilypond lilypond1.3
+
+Known issues and warnings
+.........................
+
+You may also need to create a script for `pngtopnm' and `pnmtopng'.  On
+GNU/Linux, I use this:
+
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
+
+   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
-========
+--------
 
-   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>.  Send bug reports
+to <bug-lilypond@gnu.org>.
 
    Bugs that are not fault of LilyPond are documented here.
 
-NetBSD
-******
+Bison 1.875
+...........
 
-   * The flex precompiled in NetBSD-1.4.2 is broken.  Download
-     flex-2.5.4a, build, install.
+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
 
-   * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
-     release)) does not include `/usr/pkg' paths.  Configure using:
+     $ cd lily; make out/parser.cc
+     $ vi +4919 out/parser.cc
+     # append a semicolon to the line containing "__attribute__ ((__unused__))
+     # save
+     $ make
 
-          CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+Solaris
+.......
 
+Solaris7, ./configure
 
-Solaris:
-********
+   `./configure' needs a POSIX compliant shell.  On Solaris7, `/bin/sh'
+is not yet POSIX compliant, but `/bin/ksh' or bash is.  Run configure
+like
 
-   * Sparc64/Solaris 2.6, GNU make-3.77
+     CONFIG_SHELL=/bin/ksh ksh -c ./configure
 
-     GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
-     newer.
+or
 
-   * Sparc64/Solaris 2.6, ld
+     CONFIG_SHELL=/bin/bash bash -c ./configure
 
-     Not yet resolved.
+FreeBSD
+.......
 
-AIX
-***
+To use system fonts, dejaview must be installed.  With the default
+port, the fonts are installed in `usr/X11R6/lib/X11/fonts/dejavu'.
 
-   * AIX 4.3 ld
+   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.)
 
-     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.
+     <dir>/usr/X11R6/lib/X11/fonts</dir>
 
-          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.
+International fonts
+...................
 
-     add -Wl,-bbigtoc to USER_LDFLAGS, ie:
-              LDFLAGS='-Wl,-bbigtoc' ./configure
+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.
+
+   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:
+
+Red Hat Fedora
+
+    taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
+         ttfonts-zh_CN fonts-ja fonts-hebrew
+
+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