-
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
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
- Problems
- FLex-2.5.4a and gcc-3.0
- Python-2.1[.1]
- Linux-2.4.0, Guile-1.4 -with-threads
- NetBSD
- Solaris:
- AIX
-
-
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.
- 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/).
+Precompiled binaries
+====================
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 development releases from
- `ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/' by FTP and
- `http://ftp.cs.uu.nl/pub/GNU/LilyPond/', by HTTP.
-
- * `ftp://sca.uwaterloo.ca/pub/' by FTP (Canadian mirror)
-
- * at `lilypond.org' `ftp://ftp.lilypond.org/pub/LilyPond/' by FTP and
- `http://www.lilypond.org/ftp/' by HTTP.
-
- 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.
-
- For Red Hat Linux and SuSE Linux, `.spec' files are included in the
-tarball; see instructions below.
-
-Precompiled binaries
---------------------
+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/'
- If you want to track bleeding edge development, try:
+ We currently create binaries for
- * 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
+ 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
- * 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.
+Known issues and warnings
+.........................
- * Red Hat i386
- (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/)
+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.
- * SuSE (ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE)
+Compiling from source
+=====================
- * LinuxPPC (ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/)
+Downloading source code
+-----------------------
- * Windows (http://www.lilypond.org/gnu-windows/)
+Download source
-Upgrading
----------
+ * tarballs from `http://lilypond.org/download/' by HTTP.
- There are two options for upgrading sources.
+ * tarballs from `http://download.linuxaudio.org/lilypond/' by HTTP.
- * if you have an unpacked source tree of a previous version, you may
- the patches.
+ * GIT from git.sv.gnu.org
+ (http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary)
- _If you upgrade by patching do remember to rerun autoconf after
- applying the patch_.
+ git clone git://git.sv.gnu.org/lilypond.git
- * 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 patches, and is the recommended way.
+ The repository does not contain generated files. To create
+ `configure', run
+ ./autogen.sh
- 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
+ For information on packaging, see `http://lilypond.org/devel'.
Requirements
-============
+------------
Compilation
------------
+...........
- You need the following packages to compile Lilypond.
+In addition to the packages needed for running LilyPond (see below), you
+need the following extra packages for building.
- * 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/).
+ When installing a binary package FOO, you may need to install the
+FOO-devel, libFOO-dev or FOO-dev package too.
- * Python (version 1.5 or newer). Check out the python website
- (http://www.python.org).
+ * FontForge (http://fontforge.sf.net/) 20060125 or newer.
- * 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.
+ * 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 Make. Check out the GNU make FTP directory
- (ftp://ftp.gnu.org/gnu/make/).
+ * t1utils (http://www.lcdf.org/~eddietwo/type/#t1utils) (version
+ 1.33 or newer recommended).
- * Flex (version 2.5.4a or newer). Check out the Flex webpage
- (http://www.gnu.org/software/flex/).
+ * 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'.
- * Bison (version 1.25 or newer). Check out the bison webpage
- (http://www.gnu.org/software/bison/)
+ * 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.
- * TeX.
+ * Texinfo (ftp://ftp.gnu.org/gnu/texinfo/) (version 4.11 or newer).
- TeX is used as an output backend.
+ * The GNU c++ compiler (http://gcc.gnu.org/) (version 3.4 or newer.
+ 4.x is strongly recommended).
- 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.
+ * Python (http://www.python.org) (version 2.4 or newer)
- * 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/).
+ * GNU Make (ftp://ftp.gnu.org/gnu/make/) (version 3.78 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.
+ * gettext (http://www.gnu.org/software/gettext/gettext.html)
+ (version 0.17 or newer).
- * 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.
+ * Flex (http://www.gnu.org/software/flex/).
- In the very unlikely case that kpathsea is not available for your
- platform (ie, you're not running GNU/Linux, Windows, or any recent
- UNIX), you can compile LilyPond without kpathsea support. In that
- case, you'll probably have to indicate where TeX's tfm files live.
- Invoke configure something like:
+ * Perl (http://www.perl.org/).
- ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
+ * GNU Bison (http://www.gnu.org/software/bison/).
- * pktrace, [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.
+ * 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)
- 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
+ * Dejaview. (This is normally installed by default)
- make web-doc
+ International fonts are required to create music with international
+text or lyrics.
- Building the website requires some additional tools:
+Requirements for building documentation
+.......................................
- * 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)
+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:
- * pnmtopng. The original is at in the pnmtopng FTP site
- (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
+ * The netpbm utilities (http://netpbm.sourceforge.net/)
- * 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)
+ * ImageMagick
-Building LilyPond
-==================
+ * International fonts (see input/regression/utf-8.ly for hints about
+ which font packages are necessary for your platform)
- 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
+ * 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'.
- 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'.
+ * Texi2HTML (http://www.nongnu.org/texi2html/) 1.80 or newer
- If you are not root, you should choose a `--prefix' argument that
-points into your home directory, eg.
+ * rsync
- ./configure --prefix=$HOME/usr
+Building LilyPond
+-----------------
- 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.
+Compiling
+.........
-Configuring for multiple platforms
-----------------------------------
+To install GNU LilyPond, type
- 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,
+ 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=~ --enable-checking
- make
- make install
+If you are not root, you should choose a `--prefix' argument that
+points into your home directory, e.g.
- and for the profiling version, I specify a different configuration.
+ ./configure --prefix=$HOME/usr
+Compiling for multiple platforms
+................................
- ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
- make conf=prof
- make conf=prof install
+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
-Emacs mode
-==========
+ ./configure --prefix=$HOME/usr/ --enable-checking
+ make
+ make install
- 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/'.
+ and for the profiling version, specify a different configuration
- 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)))
+ ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+ make conf=prof
+ make conf=prof install
- 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 outside the source tree
+.................................
-Compiling for distributions
-===========================
+It is possible to compile LilyPond in a build tree different from the
+source tree, with `--srcdir' option of `configure':
-Red Hat Linux
--------------
+ mkdir lily-build && cd lily-build
+ SOURCEDIR/configure --srcdir=SOURCEDIR
- Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+Useful `make' variables
+.......................
- You can also compile them yourself. A spec file is in
-`make/out/lilypond.redhat.spec'. This file is distributed along with
-the sources. You can make the rpm by issuing
+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.
- 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
+Building documentation
+----------------------
- For running on a Red Hat system you need these packages: guile,
-tetex, tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
+This requires a successful compile of LilyPond, or using an external
+LilyPond binary.
- 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.
+Commands for building documentation
+...................................
-LinuxPPC
---------
+The documentation is built by issuing
- Some LinuxPPC RPMS should available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+ make doc
- A LinuxPPC RPM can be made using the `lilypond.redhat.spec' file.
+ 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
- Some SUSE RPMS should available from
-`ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE'.
+ make install-doc
- 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.
+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.
- 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
+ Compilation of documentation in Info format with images can be done
+separately by issuing
-Slackware
----------
+ make info
- No precompiled packages for Slackware are available.
+Separate installation of this documentation is done by issuing
- Problems have been reported with Slackware 7.0; apparently, it ships
-with a faulty compiler. Do not compile LilyPond with -O2 on this
-platform.
+ make install-info
-Mandrake
---------
+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.
- Some binaries are available at rpmfind.net. Refer to
-`http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/'.
+ 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
- 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.
+ make WEB_TARGETS=online doc
-Debian GNU/Linux
-----------------
+and both `offline' and `online' targets can be generated by issuing
- A Debian package is also available. You may install it easily by
-running `apt-get' as root:
+ make WEB_TARGETS="offline online" doc
- apt-get install lilypond lilypond-doc
+ Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
- You can also compile the .deb for Debian yourself, do:
+ make help
- apt-get -b source lilypond
+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_.
- If you're real impatient, you may even do:
+ The makefile variable `QUIET_BUILD' may be set to `1' for a less
+verbose build output, just like for building the programs.
- 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'.
+Known issues and warnings
+.........................
- Alternatively, visit
+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
- * http://packages.debian.org/lilypond
- (http://packages.debian.org/lilypond)
+ make -j3 CPU_COUNT=3 doc
- * http://people.debian.org/~foka/lilypond/
- (http://people.debian.org/~foka/lilypond/) for latest
- 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.
+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.
- Please contact Anthony Fok <lilypond@packages.debian.org> for more
-information.
+ 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.
- The build scripts are in the subdirectory `debian/'; you can make
-the .deb by doing, for example:
+ touch Documentation/user/*.itely
+ touch input/lsr/*.ly
- $ su - root
- # dpkg --purge lilypond lilypond1.3
- # exit
- $ 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 ../lilypond_1.4.3*.deb
- # exit
- $
+Building documentation without compiling LilyPond
+.................................................
- 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.
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
- For compilation on a Debian GNU/Linux system you need these packages,
-in addition to the those needed for running:
+ From a fresh Git checkout, do
- * g++, cpp, libc6-dev, libstdc++<YOUR-LIBSTDC++-VERSION-HERE>-dev
+ ./autogen.sh # ignore any warning messages
+ cp GNUmakefile.in GNUmakefile
+ make -C python
+ nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
- * libguile<YOUR-LIBGUILE-VERSION-HERE>-dev
+ 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.
- * make, m4, flex, bison
+ 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
- * gettext
+ make out=www WWW-post
- * groff, texinfo
- * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+Known issues and warnings
+.........................
- * dpkg-dev, debhelper, fakeroot
+You may also need to create a script for `pngtopnm' and `pnmtopng'. On
+GNU/Linux, I use this:
- * gs, netpbm
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
- * pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
- in Debian testing/unstable.)
+ On MacOS X, I use this:
- 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
-by running \`apt-get' as root before building the package:
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
- For Debian 2.2:
+Testing LilyPond
+----------------
- 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
+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
- For Debian in development ("unstable", the future 2.3 or 3.0):
-
- 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
+ make test-baseline
+ _## apply your changes, compile_
+ make check
- 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:
+ 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.
- dpkg --purge lilypond lilypond1.3
+ To rerun tests, use
-Problems
-========
+ make test-redo _## redo files differing from baseline_
+ make test-clean _## remove all test results_
- 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>.
+and then run `make check' again.
- Bugs that are not fault of LilyPond are documented here.
+ 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'.
-FLex-2.5.4a and gcc-3.0
------------------------
+ For checking the coverage of the test suite, do the following
- Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
-LilyPond with gcc-3.0 you may do:
+ ./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
- 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
+Problems
+--------
- Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
+For help and questions use <lilypond-user@gnu.org>. Send bug reports
+to <bug-lilypond@gnu.org>.
-Python-2.1[.1]
---------------
+ Bugs that are not fault of LilyPond are documented here.
- Regular expressions are broken in Python 2.1.[.1], either upgrade or
-downgrade python.
+Bison 1.875
+...........
-Linux-2.4.0, Guile-1.4 -with-threads
-------------------------------------
+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
- 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):
+ $ cd lily; make out/parser.cc
+ $ vi +4919 out/parser.cc
+ # append a semicolon to the line containing "__attribute__ ((__unused__))
+ # save
+ $ make
- guile-1.4$ ./configure --without-threads; make all install
+Solaris
+.......
-NetBSD
-------
+Solaris7, ./configure
- * The flex precompiled in NetBSD-1.4.2 is broken. Download
- flex-2.5.4a, build, install.
+ `./configure' needs a POSIX compliant shell. On Solaris7, `/bin/sh'
+is not yet POSIX compliant, but `/bin/ksh' or bash is. Run configure
+like
- * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
- release)) does not include `/usr/pkg' paths. Configure using:
+ CONFIG_SHELL=/bin/ksh ksh -c ./configure
- CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+or
+ 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