version that you are working on. See TRANSLATION for details.
@end ignore
-@c was "INSTALL - compiling and installing GNU LilyPond"
+@c \version "2.11.38"
+
+@ifclear INSTALL
@node Install
@chapter Install
+@end ifclear
-@html
+@c I don't know what this comment does. Remove? -gp
+@ignore
+@h tml
<a name="download-source">
-@end html
+@e nd html
+@end ignore
+
+There are two sets of releases for LilyPond: stable releases, and
+unstable development releases. Stable versions have an even-numbered
+@q{minor} version number (i.e. 2.8, 2.10, 2.12, etc). Development
+versions have an odd-numbered @q{minor} version number (i.e. 2.7, 2.9,
+2.11, etc).
+
+Building LilyPond is a very involved process, so we @strong{highly}
+recommend using the precompiled binaries.
+
+@menu
+* Precompiled binaries::
+* Compiling from source::
+@end menu
+
+
+@node Precompiled binaries
+@section Precompiled binaries
+
+@subsection Downloading
+
+Check out @uref{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 @uref{http://download.linuxaudio.org/lilypond/binaries/}
+
+We currently create binaries for
+
+@example
+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-arm - Any GNU/Linux distribution, arm
+linux-ppc - Any GNU/Linux distribution, powerpc
+linux-x86 - Any GNU/Linux distribution, x86
+mingw - Windows x86
+@end example
-@section Downloading
-Even numbered minor versions are `stable' (2.6, 2.8, etc), while odd
-version are development releases (2.7, 2.9, etc). Building LilyPond
-is an involved process. If possible
-@uref{http://lilypond.org/install,download a precompiled binary} for
-your platform.
+@c TRANSLATORS:
+@c Please **do not** translate anything below this line. Users
+@c should not be compiling LilyPond themselves; if they really
+@c want to do so, they should be able to read the English docs,
+@c because they'll probably need to ask questions in English
+@c on the -devel list. -gp
-@subsection Source code
+@node Compiling from source
+@section Compiling from source
+
+@menu
+* Downloading source code::
+* Requirements::
+* Building LilyPond::
+* Building documentation::
+* Testing LilyPond::
+* Problems::
+@end menu
+
+@node Downloading source code
+@subsection Downloading source code
Download source
-@itemize @bullet
+
+@itemize
@item tarballs from
@uref{http://lilypond.org/download/} by HTTP.
@item tarballs from
@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
@item
GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
+
@example
git clone git://git.sv.gnu.org/lilypond.git
@end example
For information on packaging, see @uref{http://lilypond.org/devel}.
-@subsection Precompiled binary packages
-
-Check out @uref{http://lilypond.org/web/install/} for up to date
-information on binary packages for your platform.
-
+@node Requirements
+@subsection Requirements
-@section Requirements
+@unnumberedsubsubsec Compilation
-@subsection Compilation
-
-In addition to the packages needed for running Lilypond (see below),
-you need the following extra packages for building.
+In addition to the packages needed for running LilyPond (see below), you
+need the following extra packages for building.
When installing a binary package FOO, you may need to install the
FOO-devel, libFOO-dev or FOO-dev package too.
@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
-@item New Century Schoolbook fonts, as PFB files. These are shipped
-with X11 and Ghostscript, and are named @file{c059033l.pfb}
+@item New Century Schoolbook fonts, as PFB files. These are shipped with
+X11 and Ghostscript, and are named @file{c059033l.pfb}
@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
-newer),
-
-You will need to install some additional packages to get mftrace to
-work.
+@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (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.
-@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
-(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.
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer).
-@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
-
-@item
-@uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
-newer).
+@item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.4 or
+newer. 4.x is strongly recommended).
@item @uref{http://www.python.org,Python} (version 2.4 or newer)
@end itemize
-@subsection Running requirements
-Running LilyPond requires proper installation of the following
-software
+@unnumberedsubsubsec Running requirements
+
+Running LilyPond requires proper installation of the following software
-@itemize @bullet
+@itemize
@item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
@item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
or lyrics.
-@subsection Building documentation
+@unnumberedsubsubsec Requirements for building documentation
You can view the documentation online at
@uref{http://lilypond.org/doc/}, but you can also build it locally.
-This process requires a successful compile of lilypond. The
-documentation is built by issuing
-@quotation
-@example
-make web
-@end example
-@end quotation
-
-Building the website requires some additional tools and packages
+This process requires a successful compile of LilyPond, and some
+additional tools and packages
-@itemize @bullet
+@itemize
@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
@item ImageMagick
@item International fonts (see input/regression/utf-8.ly for hints
@item Ghostscript, 8.50 with the patch from
@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
and the patch from
-@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
+@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}, or use
+a release of Ghostscript which includes these patches, for example
+8.60 or newer.
@end itemize
-The HTML files can be installed into the standard documentation path
-by issuing
-@quotation
+@node Building LilyPond
+@subsection Building LilyPond
+
+@unnumberedsubsubsec Compiling
+
+To install GNU LilyPond, type
+
@example
-make out=www web-install
+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'
@end example
-@end quotation
-@section Testing LilyPond
+@noindent
+If you are not root, you should choose a @code{--prefix} argument that
+points into your home directory, e.g.
+
+@example
+./configure --prefix=$HOME/usr
+@end example
-@html
-<a name="testing"></a>
-@end html
-LilyPond comes with an extensive suite that excercises the entire
-program. This suite can be used to automatically check the impact of a
-change. This is done as follows
+@unnumberedsubsubsec Compiling for multiple platforms
+
+If you want to build multiple versions of LilyPond with different
+configuration settings, you can use the @code{--enable-config=CONF}
+option of @command{configure}. You should use @code{make conf=CONF}
+to generate the output in @file{out-CONF}. For example, suppose you
+want to build with and without profiling, then use the following for
+the normal build
@example
- make test-baseline
- @emph{## apply your changes, compile}
- make check
+./configure --prefix=$HOME/usr/ --enable-checking
+make
+make install
@end example
-This will leave an HTML page @file{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.
+and for the profiling version, specify a different configuration
-To rerun tests, use
+@example
+./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
+make conf=prof
+make conf=prof install
+@end example
+
+
+@unnumberedsubsubsec Compiling outside the source tree
+
+It is possible to compile LilyPond in a build tree different from the
+source tree, with @code{--srcdir} option of @command{configure}:
+
+@example
+mkdir lily-build && cd lily-build
+@var{sourcedir}/configure --srcdir=@var{sourcedir}
+
+@end example
+
+@node Building documentation
+@subsection Building documentation
+
+This requires a successful compile of LilyPond, or using an external
+LilyPond binary.
+
+@menu
+* Commands for building documentation:: Compiling and installing the documentation.
+* Building documentation without compiling LilyPond:: Using a LilyPond binary already installed.
+@end menu
+
+@node Commands for building documentation
+@unnumberedsubsubsec Commands for building documentation
+
+The documentation is built by issuing
+
+@example
+make web
+@end example
+
+After compilation, the HTML documentation tree is available in
+@file{out-www/offline-root/}, and can be browsed locally.
+
+The HTML and PDF files can be installed into the standard documentation
+path by issuing
@example
- make test-redo @emph{## redo files differing from baseline}
- make test-clean @emph{## remove all test results}
+make web-install
@end example
@noindent
-and then run @code{make check} again.
+This also installs Info documentation with images if the installation
+prefix is properly set; otherwise, instructions for manual installation
+of Info documentation are printed on standard output.
-For tracking memory usage as part of this test, you will need GUILE
-CVS; especially the following patch:
-@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
+It is also possible to build a documentation tree in
+@file{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
-For checking the coverage of the test suite, do the following
+@example
+make WEB_TARGETS=online web
+@end example
+
+@noindent
+and both @q{offline} and @q{online} targets can be generated by issuing
@example
- ./buildscripts/build-coverage.sh
- @emph{# uncovered files, least covered first}
- python ./buildscripts/coverage.py --summary out-cov/*.cc
- @emph{# consecutive uncovered lines, longest first}
- python ./buildscripts/coverage.py --uncovered out-cov/*.cc
+make WEB_TARGETS="offline online" web
@end example
-@section Building LilyPond
+Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
-To install GNU LilyPond, type
-@quotation
@example
-gunzip -c lilypond-x.y.z | tar xf -
-cd lilypond-x.y.z
-./configure # run with --help for applicable options
-make
-make install
+make help
@end example
-@end quotation
-If you are not root, you should choose a @code{--prefix} argument that
-points into your home directory, e.g.
-@quotation
+@noindent
+from every directory in the build tree. Most targets for
+documentation maintenance are available from @file{Documentation/};
+for more information, see @file{Documentation/user/README.txt} and
+@file{Documentation/TRANSLATION}.
+
+@knownissues
+
+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 @code{make web-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.
+
@example
-./configure --prefix=$HOME/usr
+touch Documentation/user/*.itely
+touch input/lsr/*.ly
@end example
-@end quotation
-@subsection Configuring for multiple platforms
+@node Building documentation without compiling LilyPond
+@unnumberedsubsubsec Building documentation without compiling LilyPond
-If you want to build multiple versions of LilyPond with different
-configuration settings, you can use the @code{--enable-config=CONF}
-option of configure. You should use @samp{make conf=CONF} to generate
-the output in @file{out-CONF}. Example: Suppose you want to build
-with and without profiling, then use the following for the normal
-build
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
+
+From a fresh Git checkout, do
-@quotation
@example
-./configure --prefix=$HOME/usr/ --enable-checking
-make
-make install
+./autogen.sh # ignore any warning messages
+cp GNUmakefile.in GNUmakefile
+make -C python
+nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
@end example
-@end quotation
-and for the profiling version, specify a different configuration
+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 @file{input/*}
+stuff: change directory, for example to @file{Documentation/user},
+issue @code{make web}, which will build documentation in a
+subdirectory @file{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
-@quotation
@example
-./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
-make conf=prof
-make conf=prof install
+make out=www WWW-post
@end example
-@end quotation
+@knownissues
+
+You may also need to create a script for @command{pngtopnm} and
+@code{pnmtopng}. On GNU/Linux, I use this:
+
+@verbatim
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
+@end verbatim
+
+On MacOS@tie{}X, I use this:
+
+@verbatim
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
+@end verbatim
-@section Problems
+
+@node Testing LilyPond
+@subsection Testing LilyPond
+
+@html
+<a name="testing"></a>
+@end html
+
+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
+
+@example
+make test-baseline
+@emph{## apply your changes, compile}
+make check
+@end example
+
+This will leave an HTML page @file{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
+
+@example
+make test-redo @emph{## redo files differing from baseline}
+make test-clean @emph{## remove all test results}
+@end example
+
+@noindent
+and then run @code{make check} again.
+
+For tracking memory usage as part of this test, you will need GUILE
+CVS; especially the following patch:
+@uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
+
+For checking the coverage of the test suite, do the following
+
+@example
+./buildscripts/build-coverage.sh
+@emph{# uncovered files, least covered first}
+python ./buildscripts/coverage.py --summary out-cov/*.cc
+@emph{# consecutive uncovered lines, longest first}
+python ./buildscripts/coverage.py --uncovered out-cov/*.cc
+@end example
+
+
+@node Problems
+@subsection Problems
For help and questions use @email{lilypond-user@@gnu.org}. Send bug
reports to @email{bug-lilypond@@gnu.org}.
Bugs that are not fault of LilyPond are documented here.
-@subsection Bison 1.875
+@unnumberedsubsubsec 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
+before `goto'" in line 4922 due to a bug in bison. To fix, please
recompile bison 1.875 with the following fix
-@quotation
@example
$ cd lily; make out/parser.cc
$ vi +4919 out/parser.cc
# save
$ make
@end example
-@end quotation
-@unnumberedsubsec MacOS X
+@unnumberedsubsubsec Solaris
-For Fink, use the following command to compile.
-
-@verbatim
-export GUILE=guile-1.6
-export GUILE_CONFIG=guile-1.6-config
-export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
-./configure
-@end verbatim
-
-@unnumberedsubsec Solaris
-
-@itemize @bullet
-@item Solaris7, ./configure
+Solaris7, ./configure
@file{./configure} needs a POSIX compliant shell. On Solaris7,
@file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
is. Run configure like
-@quotation
+
@example
- CONFIG_SHELL=/bin/ksh ksh -c ./configure
+CONFIG_SHELL=/bin/ksh ksh -c ./configure
@end example
-@end quotation
+
+@noindent
or
-@quotation
+
@example
- CONFIG_SHELL=/bin/bash bash -c ./configure
+CONFIG_SHELL=/bin/bash bash -c ./configure
@end example
-@end quotation
-@item FreeBSD
+@unnumberedsubsubsec FreeBSD
To use system fonts, dejaview must be installed. With the default
port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
<dir>/usr/X11R6/lib/X11/fonts</dir>
@end example
-@end itemize
-
-@section International fonts
+@unnumberedsubsubsec International fonts
-On MacOs X, all fonts are installed by default. However, finding all
+On MacOS@tie{}X, all fonts are installed by default. However, finding all
system fonts requires a bit of configuration; see
@uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
this post} on the @code{lilypond-user} mailing list.