version that you are working on. See TRANSLATION for details.
@end ignore
+@c \version "2.11.51"
+
@ifclear INSTALL
@node Install
@chapter Install
We currently create binaries for
@example
-MacOS
-darwin-ppc
-darwin-x86
-freebsd-64
-freebsd-x86
-linux-64
-linux-arm
-linux-ppc
-linux-x86
-mingw
+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
+@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
@node Compiling from source
@section Compiling from source
* Downloading source code::
* Requirements::
* Building LilyPond::
-* Building documentation without compiling LilyPond::
+* Building documentation::
* Testing LilyPond::
* Problems::
@end menu
Download source
-@itemize @bullet
+@itemize
@item tarballs from
@uref{http://lilypond.org/download/} by HTTP.
@item tarballs from
@unnumberedsubsubsec Compilation
-In addition to the packages needed for running Lilypond (see below), you
+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
@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}
-@file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
+@item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
+(version 1.33 or newer recommended).
-@item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
-newer); you may need to install some additional packages to get mftrace
-to work.
+@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.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.8 or newer).
+@item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 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)
@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
-@item @uref{http://www.gnu.org/software/flex/,Flex}
+@item @uref{http://www.gnu.org/software/flex/,Flex}.
-@item @uref{http://www.perl.org/,Perl}
+@item @uref{http://www.perl.org/,Perl}.
-@item @uref{http://www.gnu.org/software/flex/,GNU Bison}
+@item @uref{http://www.gnu.org/software/flex/,GNU Bison}.
@item All packages required for running, including development packages with
header files and libraries.
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.
-@unnumberedsubsubsec 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
-
-@example
-make web
-@end example
-
-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
-
-@example
-make out=www web-install
-@end example
-
@node Building LilyPond
@subsection Building LilyPond
-@subsubsection Compiling
+@unnumberedsubsubsec Compiling
To install GNU LilyPond, type
cd lilypond-x.y.z
./configure # run with --help for applicable options
make
-make install
+su -c 'make install'
@end example
+@noindent
If you are not root, you should choose a @code{--prefix} argument that
points into your home directory, e.g.
@end example
-@subsubsection Compiling for multiple platforms
+@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 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
+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
./configure --prefix=$HOME/usr/ --enable-checking
@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 web-install
+@end example
+
+@noindent
+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.
+
+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
+
+@example
+make WEB_TARGETS=online web
+@end example
+
+@noindent
+and both @q{offline} and @q{online} targets can be generated by issuing
+
+@example
+make WEB_TARGETS="offline online" web
+@end example
+
+Several targets are available to clean the documentation build and
+help with maintaining documentation; an overview of these targets is
+available with
+
+@example
+make help
+@end example
+
+@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
+touch Documentation/user/*.itely
+touch input/lsr/*.ly
+@end example
+
+
@node Building documentation without compiling LilyPond
-@subsection Building documentation without compiling LilyPond
+@unnumberedsubsubsec Building documentation without compiling LilyPond
-The documentation can be built locally without compiling lilypond from
-scratch.
+The documentation can be built locally without compiling LilyPond
+binary, if LilyPond is already installed on your system.
-From a fresh git checkout, do
+From a fresh Git checkout, do
@example
-./autogen.sh % ignore any warning messages
+./autogen.sh # ignore any warning messages
cp GNUmakefile.in GNUmakefile
make -C python
-nice make LILYPOND_EXTERNAL_BINARY=~/Apps/LilyPond.app/Contents/Resources/bin/lilypond web
-% change the lilypond directory as appropriate
+nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
@end example
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
-unstable Lily will fail to build the docs.
+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
+
+@example
+make out=www WWW-post
+@end example
+
+@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
-You may build the manual ( Documentation/user/ ) without building all
-the input/* stuff.
@node Testing LilyPond
@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
+program. This suite can be used to automatically check the impact of a
+change. This is done as follows
@example
make test-baseline
@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
@example
@end example
-@unnumberedsubsubsec MacOS X
-
-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
-
@unnumberedsubsubsec Solaris
Solaris7, ./configure
@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.
projects / lilypond.git / blobdiff