-
+INSTALL - compiling and installing GNU LilyPond
+***********************************************
Table of Contents
*****************
+INSTALL - compiling and installing GNU LilyPond
+1 Compilation
+ 1.1 Overview of compiling
+ 1.2 Requirements
+ 1.2.1 Requirements for running LilyPond
+ 1.2.2 Requirements for compiling LilyPond
+ 1.2.3 Requirements for building documentation
+ 1.3 Getting the source code
+ 1.4 Configuring `make'
+ 1.4.1 Running `./autogen.sh'
+ 1.4.2 Running `../configure'
+ Configuration options
+ Checking build dependencies
+ Configuring target directories
+ 1.5 Compiling LilyPond
+ 1.5.1 Using `make'
+ 1.5.2 Saving time with the `-j' option
+ 1.5.3 Compiling for multiple platforms
+ 1.5.4 Useful `make' variables
+ 1.6 Post-compilation options
+ 1.6.1 Installing LilyPond from a local build
+ 1.6.2 Generating documentation
+ Documentation editor's edit/compile cycle
+ Building documentation
+ Building a single document
+ Saving time with `CPU_COUNT'
+ AJAX search
+ Installing documentation
+ Building documentation without compiling
+ 1.6.3 Testing LilyPond binary
+ 1.7 Problems
+ Bison 1.875
+ Compiling on MacOS X
+ Solaris
+ FreeBSD
+ International fonts
+ Using lilypond python libraries
+ 1.8 Concurrent stable and development versions
+ 1.9 Build system
+
+
+1 Compilation
+*************
+
+1.1 Overview of compiling
+=========================
+
+Compiling LilyPond from source is an involved process, and is only
+recommended for developers and packagers. Typical program users are
+instead encouraged to obtain the program from a package manager (on
+Unix) or by downloading a precompiled binary configured for a specific
+operating system. Pre-compiled binaries are available on the *note
+Download: (lilypond-web)Download. page.
+
+ Compiling LilyPond from source is necessary if you want to build,
+install, or test your own version of the program.
+
+ A successful compile can also be used to generate and install the
+documentation, incorporating any changes you may have made. However, a
+successful compile is not a requirement for generating the
+documentation. The documentation can be built using a Git repository
+in conjunction with a locally installed copy of the program. For more
+information, see *note Building documentation without compiling::.
+
+ Attempts to compile LilyPond natively on Windows have been
+unsuccessful, though a workaround is available (see *note LilyDev:
+(lilypond-contributor)LilyDev.).
+
+1.2 Requirements
+================
+1.2.1 Requirements for running LilyPond
+---------------------------------------
+Running LilyPond requires proper installation of the following software:
-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
+ * DejaVu fonts (http://www.dejavu-fonts.org/) (normally installed by
+ default)
+ * FontConfig (http://www.fontconfig.org/) (2.4.0 or newer)
-INSTALL - compiling and installing GNU LilyPond
-***********************************************
+ * Freetype (http://www.freetype.org/) (2.1.10 or newer)
- 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/).
+ * Ghostscript (http://www.ghostscript.com) (8.60 or newer)
-Downloading
-===========
+ * Guile (http://www.gnu.org/software/guile/guile.html) (1.8.2 or
+ newer)
- 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/).
+ * Pango (http://www.pango.org/) (1.12 or newer)
-Source code
------------
+ * Python (http://www.python.org) (2.4 or newer)
- 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.
+ International fonts are required to create music with international
+text or lyrics.
- * `ftp://sca.uwaterloo.ca/pub/' by FTP (Canadian mirror)
+1.2.2 Requirements for compiling LilyPond
+-----------------------------------------
- * at `lilypond.org' `ftp://ftp.lilypond.org/pub/LilyPond/' by FTP and
- `http://www.lilypond.org/ftp/' by HTTP.
+Below is a full list of packages needed to build LilyPond. However,
+for most common distributions there is an easy way of installing most
+all build dependencies in one go:
- 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.
+Distribution Command
+--------------------------------------------------------------------------
+Debian, Ubuntu `sudo apt-get build-dep lilypond'
+Fedora, RHEL `sudo yum-builddep lilypond'
+openSUSE, SLED `sudo zypper --build-deps-only
+ source-install lilypond'
- For Red Hat Linux and SuSE Linux, `.spec' files are included in the
-tarball; see instructions below.
+ * Everything listed in *note Requirements for running LilyPond::
-Precompiled binaries
---------------------
+ * Development packages for the above items (which should include
+ header files and libraries).
- If you want to track bleeding edge development, try:
+ Red Hat Fedora:
- * 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
+ guile-devel-VERSION
+ fontconfig-devel-VERSION
+ freetype-devel-VERSION
+ pango-devel-VERSION
+ python-devel-VERSION
- * Mandrake Cooker
- (http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/) also
- provides fairly recent versions.
+ Debian GNU/Linux:
- Binaries are made available for other popular platforms, but as we
-need to compile them ourselves, they are not updated for every version
-released.
+ guile-VERSION-dev
+ libfontconfig1-dev
+ libfreetype6-dev
+ libpango1.0-dev
+ pythonVERSION-dev
- * Red Hat i386
- (ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/RedHat/RPMS/)
+ * Flex (http://flex.sourceforge.net/)
- * SuSE (ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE)
+ * FontForge (http://fontforge.sf.net/) (20060125 or newer; 20100501
+ or newer is recommended; must be compiled with `--enable-double'.
+ Failure to do so can lead to poor intersection calculations and
+ poorly-rendered glyphs.)
- * LinuxPPC (ftp://ftp.lilypond.org/pub/LilyPond/binaries/linuxppc/)
+ * GNU Bison (http://www.gnu.org/software/bison/)
- * Windows (http://www.lilypond.org/gnu-windows/)
+ * GNU Compiler Collection (http://gcc.gnu.org/) (3.4 or newer, 4.X
+ recommended)
-Upgrading
----------
+ * GNU gettext (http://www.gnu.org/software/gettext/gettext.html)
+ (0.17 or newer)
- There are two options for upgrading sources.
+ * GNU Make (http://www.gnu.org/software/make/) (3.78 or newer)
- * if you have an unpacked source tree of a previous version, you may
- the patches.
+ * MetaFont (http://metafont.tutorial.free.fr/) (mf-nowin, mf, mfw or
+ mfont binaries), usually packaged with TeX
+ (http://www.latex-project.org/ftp.html).
- _If you upgrade by patching do remember to rerun autoconf after
- applying the patch_.
+ * MetaPost (http://cm.bell-labs.com/who/hobby/MetaPost.html) (mpost
+ binary), usually packaged with TeX
+ (http://www.latex-project.org/ftp.html).
- * 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.
+ * Perl (http://www.perl.org/)
- 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
+ * Texinfo (http://www.gnu.org/software/texinfo/) (4.11 or newer)
-Requirements
-============
+ * Type 1 utilities (http://www.lcdf.org/~eddietwo/type/#t1utils)
+ (1.33 or newer recommended)
-Compilation
------------
+1.2.3 Requirements for building documentation
+---------------------------------------------
- You need the following packages to compile Lilypond.
+You can view the documentation online at
+`http://www.lilypond.org/doc/', but you can also build it locally.
+This process requires some additional tools and packages:
- * 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/).
+ * Everything listed in *note Requirements for compiling LilyPond::
- * Python (version 1.5 or newer). Check out the python website
- (http://www.python.org).
+ * ImageMagick (http://www.imagemagick.org/)
- * 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.
+ * Netpbm (http://netpbm.sourceforge.net/)
- * GNU Make. Check out the GNU make FTP directory
- (ftp://ftp.gnu.org/gnu/make/).
+ * gzip (http://gzip.org/)
- * Flex (version 2.5.4a or newer). Check out the Flex webpage
- (http://www.gnu.org/software/flex/).
+ * rsync (http://rsync.samba.org/)
- * Bison (version 1.25 or newer). Check out the bison webpage
- (http://www.gnu.org/software/bison/)
+ * Texi2HTML (http://www.nongnu.org/texi2html/) (1.82)
- * TeX.
+ * International fonts
- TeX is used as an output backend.
+ Red Hat Fedora:
- 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.
+ fonts-arabic
+ fonts-hebrew
+ fonts-ja
+ fonts-xorg-truetype
+ taipeifonts
+ ttfonts-ja
+ ttfonts-zh_CN
- * 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/).
+ Debian GNU/Linux:
- * 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.
+ emacs-intl-fonts
+ ttf-kochi-gothic
+ ttf-kochi-mincho
+ xfonts-bolkhov-75dpi
+ xfonts-cronyx-75dpi
+ xfonts-cronyx-100dpi
+ xfonts-intl-.*
- * 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.
+1.3 Getting the source code
+===========================
- 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:
+Downloading the Git repository
+------------------------------
- ./configure --without-kpathsea --enable-tfm-path=/usr/share/texmf/fonts/tfm/public/cm/:/usr/share/texmf/fonts/tfm/ams/symbols
+In general, developers compile LilyPond from within a local Git
+repository. Setting up a local Git repository is explained in *note
+Starting with Git: (lilypond-contributor)Starting with Git.
- * 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.
+Downloading a source tarball
+----------------------------
+Packagers are encouraged to use source tarballs for compiling.
-Running requirements
---------------------
+ The tarball for the latest stable release is available on the *note
+Source: (lilypond-web)Source. page.
- GNU LilyPond does use a lot of resources. For operation you need the
-following software
+The latest source code snapshot
+(http://git.savannah.gnu.org/gitweb/?p=lilypond.git;a=snapshot) is also
+available as a tarball from the GNU Savannah Git server.
- * TeX.
+All tagged releases (including legacy stable versions and the most
+recent development release) are available here:
- * Xdvi and Ghostscript
+ `http://download.linuxaudio.org/lilypond/source/'
- * GUILE 1.3.4, or newer. Check out the GUILE webpage
- (http://www.gnu.org/software/guile.html)
+ Download the tarball to your `~/src/' directory, or some other
+appropriate place.
- 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.
+ Note: Be careful where you unpack the tarball! Any
+ subdirectories of the current folder named `lilypond/' or
+ `lilypond-X.Y.Z/' (where X.Y.Z is the release number) will be
+ overwritten if there is a name clash with the tarball.
- LilyPond is a big and slow program. A fast CPU and plenty of RAM is
-recommended for comfortable use.
+ Unpack the tarball with this command:
-Website requirements
---------------------
+ tar -xzf lilypond-X.Y.Z.tar.gz
+
+ This creates a subdirectory within the current directory called
+`lilypond-X.Y.Z/'. Once unpacked, the source files occupy about 40 MB
+of disk space.
+
+ Windows users wanting to look at the source code may have to
+download and install the free-software 7zip archiver
+(http://www.7-zip.org) to extract the tarball.
+
+1.4 Configuring `make'
+======================
+
+1.4.1 Running `./autogen.sh'
+----------------------------
+
+After you unpack the tarball (or download the Git repository), the
+contents of your top source directory should be similar to the current
+source tree listed at
+`http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=tree'.
+
+ Next, you need to create the generated files; enter the following
+command from your top source directory:
+
+ ./autogen.sh --noconfigure
+
+ This will generate a number of files and directories to aid
+configuration, such as `configure', `README.txt', etc.
+
+ Next, create the build directory with:
+
+ mkdir build/
+ cd build/
+
+ We heavily recommend building lilypond inside a separate directory
+with this method.
+
+1.4.2 Running `../configure'
+----------------------------
+
+Configuration options
+.....................
+
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
+
+The `../configure' command (generated by `./autogen.sh') provides many
+options for configuring `make'. To see them all, run:
+
+ ../configure --help
+
+Checking build dependencies
+...........................
+
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
+
+When `../configure' is run without any arguments, it will check to make
+sure your system has everything required for compilation:
+
+ ../configure
- 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
+ If any build dependency is missing, `../configure' will return with:
- make web-doc
+ ERROR: Please install required programs: FOO
- Building the website requires some additional tools:
+ The following message is issued if you are missing programs that are
+only needed for building the 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)
+ WARNING: Please consider installing optional programs: BAR
- * pnmtopng. The original is at in the pnmtopng FTP site
- (ftp://swrinde.nde.swri.edu/pub/png/applications/pnmtopng-2.37.2.tar.gz).
+ If you intend to build the documentation locally, you will need to
+install or update these programs accordingly.
- * 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)
+ Note: `../configure' may fail to issue warnings for certain
+ documentation build requirements that are not met. If you
+ experience problems when building the documentation, you may
+ need to do a manual check of *note Requirements for building
+ documentation::.
-Building LilyPond
-==================
+Configuring target directories
+..............................
- 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
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
- 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'.
+If you intend to use your local build to install a local copy of the
+program, you will probably want to configure the installation
+directory. Here are the relevant lines taken from the output of
+`../configure --help':
- If you are not root, you should choose a `--prefix' argument that
-points into your home directory, eg.
+ By default, ``make install'' will install all the files in
+ `/usr/local/bin', `/usr/local/lib' etc. You can specify an
+ installation prefix other than `/usr/local' using ``--prefix'',
+ for instance ``--prefix=$HOME''.
- ./configure --prefix=$HOME/usr
+ A typical installation prefix is `$HOME/usr':
- 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
-----------------------------------
+ Note that if you plan to install a local build on a system where you
+do not have root privileges, you will need to do something like this
+anyway--`make install' will only succeed if the installation prefix
+points to a directory where you have write permission (such as your
+home directory). The installation directory will be automatically
+created if necessary.
- If you want to build multiple versions of LilyPond with different
+ The location of the `lilypond' command installed by this process
+will be `PREFIX/bin/lilypond'; you may want to add `PREFIX/bin/' to
+your `$PATH' if it is not already included.
+
+ It is also possible to specify separate installation directories for
+different types of program files. See the full output of
+`../configure --help' for more information.
+
+ If you encounter any problems, please see *note Problems::.
+
+1.5 Compiling LilyPond
+======================
+
+1.5.1 Using `make'
+------------------
+
+ Note: make sure that you are in the `build/' subdirectory of
+ your source tree.
+
+LilyPond is compiled with the `make' command. Assuming `make' is
+configured properly, you can simply run:
+
+ make
+
+ `make' is short for `make all'. To view a list of `make' targets,
+run:
+
+ make help
+
+ TODO: Describe what `make' actually does.
+
+
+
+See also
+........
+
+
+
+ *note Generating documentation:: provides more info on the `make'
+targets used to build the LilyPond documentation.
+
+1.5.2 Saving time with the `-j' option
+--------------------------------------
+
+If your system has multiple CPUs, you can speed up compilation by
+adding `-jX' to the `make' command, where `X' is one more than the
+number of cores you have. For example, a typical Core2Duo machine
+would use:
+
+ make -j3
+
+ If you get errors using the `-j' option, and `make' succeeds without
+it, try lowering the `X' value.
+
+ Because multiple jobs run in parallel when `-j' is used, it can be
+difficult to determine the source of an error when one occurs. In that
+case, running `make' without the `-j' is advised.
+
+1.5.3 Compiling 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'. 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
- 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
- ./configure --prefix=~ --enable-profiling --enable-config=prof --disable-checking
- make conf=prof
- make conf=prof install
+ If you wish to install a copy of the build with profiling, don't
+forget to use `conf=CONF' when issuing `make install':
-Emacs mode
-==========
+ make conf=prof 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/'.
- 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)))
+See also
+........
- If you have the latest LilyPond-1.4.x Debian package, LilyPond-mode
-is automatically loaded, you not even need to modify your `~/.emacs'
-file.
-Compiling for distributions
-===========================
-Red Hat Linux
--------------
+ *note Installing LilyPond from a local build::
- Red Hat 7.0 i386 RPMS are available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+1.5.4 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
+1.6 Post-compilation options
+============================
- For running on a Red Hat system you need these packages: guile,
-tetex, tetex-latex, tetex-dvips, libstdc++, python, ghostscript.
+1.6.1 Installing LilyPond from a local build
+--------------------------------------------
- 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, groff.
+If you configured `make' to install your local build in a directory
+where you normally have write permission (such as your home directory),
+and you have compiled LilyPond by running `make', you can install the
+program in your target directory by running:
-LinuxPPC
---------
+ make install
- Some LinuxPPC RPMS should available from
-`ftp://ftp.cs.uu.nl/pub/GNU/LilyPond/binaries/'.
+ If instead, your installation directory is not one that you can
+normally write to (such as the default `/usr/local/', which typically
+is only writeable by the superuser), you will need to temporarily
+become the superuser when running `make install':
- A LinuxPPC RPM can be made using the `lilypond.redhat.spec' file.
+ sudo make install
-SuSE
-----
+or...
- Some SUSE RPMS should available from
-`ftp://ftp.lilypond.org/pub/LilyPond/binaries/SuSE'.
+ su -c 'make install'
- 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.
+ If you don't have superuser privileges, then you need to configure
+the installation directory to one that you can write to, and then
+re-install. See *note Configuring target directories::.
- 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
+1.6.2 Generating documentation
+------------------------------
-Slackware
----------
+Documentation editor's edit/compile cycle
+.........................................
- No precompiled packages for Slackware are available.
+ * Initial documentation build:
- 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 [-jX]
+ make [-jX CPU_COUNT=X] doc _## can take an hour or more_
+ make [-jX CPU_COUNT=X] doc-stage-1 _## to build only PDF documentation_
-Mandrake
---------
+ * Edit/compile cycle:
- Some binaries are available at rpmfind.net. Refer to
-`http://rpmfind.net/linux/mandrake/cooker/contrib/RPMS/'.
+ _## edit source files, then..._
- 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 [-jX] _## needed if editing outside_
+ _## Documentation/, but useful anyway_
+ _## for finding Texinfo errors._
+ make [-jX CPU_COUNT=X] doc _## usually faster than initial build._
-Debian GNU/Linux
-----------------
+ * Reset:
+
+ It is generally possible to remove the compiled documentation from
+ your system with `make doc-clean', but this method is not 100%
+ guaranteed. Instead, if you want to be sure you have a clean
+ system, we recommend that you delete your `build/' directory, and
+ begin compiling from scratch. Since the documentation compile
+ takes much longer than the non-documentation compile, this does
+ not increase the overall time by a great deal.
+
+
+Building documentation
+......................
+
+After a successful compile (using `make'), the documentation can be
+built by issuing:
+
+ make doc
+
+ or, to build only the PDF documentation and not the HTML,
+
+ make doc-stage-1
+
+ Note: The first time you run `make doc', the process can
+ easily take an hour or more with not much output on the
+ command line.
- A Debian package is also available. You may install it easily by
-running `apt-get' as root:
+ After this initial build, `make doc' only makes changes to the
+documentation where needed, so it may only take a minute or two to test
+changes if the documentation is already built.
- apt-get install lilypond lilypond-doc
+ If `make doc' succeeds, the HTML documentation tree is available in
+`out-www/offline-root/', and can be browsed locally. Various portions
+of the documentation can be found by looking in `out/' and `out-www'
+subdirectories in other places in the source tree, but these are only
+_portions_ of the docs. Please do not complain about anything which is
+broken in those places; the only complete set of documentation is in
+`out-www/offline-root/' from the top of the source tree.
- You can also compile the .deb for Debian yourself, do:
+ `make doc' sends the output from most of the compilation to
+logfiles. If the build fails for any reason, it should prompt you with
+the name of a logfile which will provide information to help you work
+out why the build failed. These logfiles are not deleted with
+`make doc-clean'. To remove all the logfiles generated by the
+compilation process, use:
- apt-get -b source lilypond
+ make log-clean
- If you're real impatient, you may even do:
+ `make doc' compiles the documents for all languages. To save some
+compile time, the English language documents can be compiled on their
+own with:
- cd lilypond-x.y.z # a previous version
- uscan # download and build latest directly from upstream
+ make LANGS='' doc
- 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
+Similarly, it is possible to compile a subset of the translated
+documentation by specifying their language codes on the command line.
+For example, the French and German translations are compiled with:
- 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'.
+ make LANGS='de fr' doc
- Alternatively, visit
+Note that this will also compile the English version.
- * http://packages.debian.org/lilypond
- (http://packages.debian.org/lilypond)
+ Compilation of documentation in Info format with images can be done
+separately by issuing:
- * 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.
+ make info
- Please contact Anthony Fok <lilypond@packages.debian.org> for more
-information.
+An issue when switching branches between master and translation is the
+appearance/disappearance of translated versions of some manuals. If
+you see such a warning from make:
- The build scripts are in the subdirectory `debian/'; you can make
-the .deb by doing, for example:
+ No rule to make target `X', needed by `Y'
- $ 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
- $
+Your best bet is to delete the file Y.dep and to try again.
- 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.
+Building a single document
+..........................
- For compilation on a Debian GNU/Linux system you need these packages,
-in addition to the those needed for running:
+It's possible to build a single document. For example, to rebuild only
+`contributor.pdf', do the following:
- * g++, cpp, libc6-dev, libstdc++<YOUR-LIBSTDC++-VERSION-HERE>-dev
+ cd build/
+ cd Documentation/
+ touch ../../Documentation/contributor.texi
+ make out=www out-www/contributor.pdf
- * libguile<YOUR-LIBGUILE-VERSION-HERE>-dev
+ If you are only working on a single document, test-building it in
+this way can give substantial time savings - recreating
+`contributor.pdf', for example, takes a matter of seconds.
- * make, m4, flex, bison
+Saving time with `CPU_COUNT'
+............................
- * gettext
+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 the `-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:
- * groff, texinfo
+ make -j3 CPU_COUNT=3 doc
- * tetex-base, tetex-bin, tetex-extra, libkpathsea-dev or tetex-dev
+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 unless
+your system has enough RAM to run that many simultaneous LilyPond
+instances. Also, values for the `-j' option that pose problems with
+`make' are less likely to pose problems with `make doc' (this applies
+to both `-j' and `CPU_COUNT'). For example, with a quad-core processor,
+it is possible for `make -j5 CPU_COUNT=5 doc' to work consistently even
+if `make -j5' rarely succeeds.
- * dpkg-dev, debhelper, fakeroot
+AJAX search
+...........
- * gs, netpbm
+To build the documentation with interactive searching, use:
- * pnmtopng (only in Debian 2.2; pnmtopng has been merged with netpbm
- in Debian testing/unstable.)
+ make doc AJAX_SEARCH=1
- 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:
+ This requires PHP, and you must view the docs via a http connection
+(you cannot view them on your local filesystem).
- For Debian 2.2:
+ Note: Due to potential security or load issues, this option is
+ not enabled in the official documentation builds. Enable at
+ your own risk.
- 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
+Installing documentation
+........................
- For Debian in development ("unstable", the future 2.3 or 3.0):
+The HTML, PDF and if available Info files can be installed into the
+standard documentation path by issuing
- 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 install-doc
- 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 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.
- dpkg --purge lilypond lilypond1.3
+ To install the Info documentation separately, run:
-Problems
-========
+ make install-info
- 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>.
+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.
+
+ 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
+
+ make WEB_TARGETS=online doc
+
+and both `offline' and `online' targets can be generated by issuing
+
+ make WEB_TARGETS="offline online" doc
+
+ Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
+
+ make help
+
+from every directory in the build tree. Most targets for documentation
+maintenance are available from `Documentation/'; for more information,
+see *note Documentation work: (lilypond-contributor)Documentation work.
+
+ The makefile variable `QUIET_BUILD' may be set to `1' for a less
+verbose build output, just like for building the programs.
+
+Building documentation without compiling
+........................................
+
+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 scripts && 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
+(i.e. mostly regression tests): change directory, for example to
+`Documentation/', 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
+
+ make out=www WWW-post
+
+
+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 with fink, I use this:
+
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
+
+ On MacOS X with macports, you should use this:
+
+export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib
+exec /opt/local/bin/pngtopnm "$@"
+
+1.6.3 Testing LilyPond binary
+-----------------------------
+
+LilyPond comes with an extensive suite that exercises the entire
+program. This suite can be used to test that the binary has been built
+correctly.
+
+ The test suite can be executed with:
+
+make test
+
+ If the test suite completes successfully, the LilyPond binary has
+been verified.
+
+ More information on the regression test suite is found at *note
+Regression tests: (lilypond-contributor)Regression tests.
+
+1.7 Problems
+============
+
+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.
-FLex-2.5.4a and gcc-3.0
------------------------
+Bison 1.875
+-----------
+
+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
+
+ $ cd lily; make out/parser.cc
+ $ vi +4919 out/parser.cc
+ # append a semicolon to the line containing "__attribute__ ((__unused__))
+ # save
+ $ make
+
+Compiling on MacOS X
+--------------------
+
+Here are special instructions for compiling under MacOS X. These
+instructions assume that dependencies are installed using MacPorts.
+(http://www.macports.org/) The instructions have been tested using OS X
+10.5 (Leopard).
+
+ First, install the relevant dependencies using MacPorts.
+
+ Next, add the following to your relevant shell initialization files.
+This is `~/.profile' by default. You should create this file if it
+does not exist.
+
+ export PATH=/opt/local/bin:/opt/local/sbin:$PATH
+ export DYLD_FALLBACK_LIBRARY_PATH=/opt/local/lib:$DYLD_FALLBACK_LIBRARY_PATH
+
+ Now you must edit the generated `config.make' file. Change
+
+ FLEXLEXER_FILE = /usr/include/FlexLexer.h
+
+to:
+
+ FLEXLEXER_FILE = /opt/local/include/FlexLexer.h
+
+ At this point, you should verify that you have the appropriate fonts
+installed with your ghostscript installation. Check `ls
+/opt/local/share/ghostscript/fonts' for: 'c0590*' files (.pfb, .pfb and
+.afm). If you don't have them, run the following commands to grab them
+from the ghostscript SVN server and install them in the appropriate
+location:
+
+ svn export http://svn.ghostscript.com/ghostscript/tags/urw-fonts-1.0.7pre44/
+ sudo mv urw-fonts-1.0.7pre44/* /opt/local/share/ghostscript/fonts/
+ rm -rf urw-fonts-1.07pre44
+
+ Now run the `./configure' script. To avoid complications with
+automatic font detection, add
+
+ --with-ncsb-dir=/opt/local/share/ghostscript/fonts
+
+Solaris
+-------
+
+Solaris7, ./configure
+
+ `./configure' needs a POSIX compliant shell. On Solaris7, `/bin/sh'
+is not yet POSIX compliant, but `/bin/ksh' or bash is. Run configure
+like
+
+ CONFIG_SHELL=/bin/ksh ksh -c ./configure
+
+or
+
+ CONFIG_SHELL=/bin/bash bash -c ./configure
+
+FreeBSD
+-------
+
+To use system fonts, dejaview must be installed. With the default
+port, the fonts are installed in `usr/X11R6/lib/X11/fonts/dejavu'.
+
+ 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.)
+
+ <dir>/usr/X11R6/lib/X11/fonts</dir>
+
+International fonts
+-------------------
+
+On Mac OS 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
- Flex 2.5.4a does not produce g++-3.0 compliant C++ code. To compile
-LilyPond with gcc-3.0 you may do:
+Using lilypond python libraries
+-------------------------------
- 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
+If you want to use lilypond's python libraries (either running certain
+build scripts manually, or using them in other programs), set
+`PYTHONPATH' to `python/out' in your build directory, or
+`.../usr/lib/lilypond/current/python' in the installation directory
+structure.
- Note that this is fixed in Debian/unstable for flex >= 2.5.4a-13.
+1.8 Concurrent stable and development versions
+==============================================
-Python-2.1[.1]
---------------
+It can be useful to have both the stable and the development versions
+of Lilypond available at once. One way to do this on GNU/Linux is to
+install the stable version using the precompiled binary, and run the
+development version from the source tree. After running `make all'
+from the top directory of the Lilypond source files, there will be a
+binary called `lilypond' in the `out' directory:
- Regular expressions are broken in Python 2.1.[.1], either upgrade or
-downgrade python.
+ <PATH TO>/lilypond/out/bin/lilypond
-Linux-2.4.0, Guile-1.4 -with-threads
-------------------------------------
+ This binary can be run without actually doing the `make install'
+command. The advantage to this is that you can have all of the latest
+changes available after pulling from git and running `make all',
+without having to uninstall the old version and reinstall the new.
- 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):
+ So, to use the stable version, install it as usual and use the
+normal commands:
- guile-1.4$ ./configure --without-threads; make all install
+ lilypond foobar.ly
-NetBSD
-------
+ To use the development version, create a link to the binary in the
+source tree by saving the following line in a file somewhere in your
+`$PATH':
- * The flex precompiled in NetBSD-1.4.2 is broken. Download
- flex-2.5.4a, build, install.
+ exec <PATH TO>/lilypond/out/bin/lilypond "$@"
- * The configuration of Gcc (egcs-2.91.60 19981201 (egcs-1.1.1
- release)) does not include `/usr/pkg' paths. Configure using:
+ Save it as `Lilypond' (with a capital L to distinguish it from the
+stable `lilypond'), and make it executable:
- CFLAGS='-I /usr/pkg/include' LDFLAGS='-L/usr/pkg/lib' ./configure
+ chmod +x Lilypond
+ Then you can invoke the development version this way:
-Solaris:
---------
+ Lilypond foobar.ly
- * Sparc64/Solaris 2.6, GNU make-3.77
+ TODO: ADD
- GNU make-3.77 is buggy on this platform, upgrade to 3.78.1 or
- newer.
+ - other compilation tricks for developers
- * Sparc64/Solaris 2.6, ld
+1.9 Build system
+================
- Not yet resolved.
+We currently use make and stepmake, which is complicated and only used
+by us. Hopefully this will change in the future.
-AIX
----
+Version-specific texinfo macros
+-------------------------------
- * AIX 4.3 ld
+ * made with `scripts/build/create-version-itexi.py' and
+ `scripts/build/create-weblinks-itexi.py'
- 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.
+ * used extensively in the `WEBSITE_ONLY_BUILD' version of the
+ website (made with `website.make', used on lilypond.org)
- 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.
+ * not (?) used in the main docs?
- add -Wl,-bbigtoc to USER_LDFLAGS, ie:
- LDFLAGS='-Wl,-bbigtoc' ./configure
+ * the numbers in VERSION file: MINOR_VERSION should be 1 more than
+ the last release, VERSION_DEVEL should be the last *online*
+ release. Yes, VERSION_DEVEL is less than VERSION.
projects / lilypond.git / blobdiff