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
Download source
-@itemize @bullet
+@itemize
@item tarballs from
@uref{http://lilypond.org/download/} by HTTP.
@item tarballs from
@item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
-@item New Century Schoolbook fonts, as PFB files. These are shipped with
+@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 may 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{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).
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).
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
+This process requires a successful compile of lilypond, and some
+additional tools and packages
-@example
-make web
-@end example
-
-Building the website requires 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
@uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
@end itemize
-The HTML files can be installed into the standard documentation path
-by issuing
+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 out=www web-install
@end example
+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
+
@node Building LilyPond
@subsection Building LilyPond
-@subsubsection Compiling
+@unnumberedsubsubsec Compiling
To install GNU LilyPond, type
@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
+option of configure. You should use @code{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
./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
+nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
% change the lilypond directory as appropriate
@end example
You may build the manual ( Documentation/user/ ) without building all
the input/* stuff.
+@knownissues
+
+You may also need to create a script for @command{pngtopnm} and
+@code{pnmtopng}. On Linux, I use this:
+
+@verbatim
+export LD_LIBRARY_PATH=/usr/lib
+exec /usr/bin/pngtopnm "$@"
+@end verbatim
+
+On OSX, I use this:
+
+@verbatim
+export DYLD_LIBRARY_PATH=/sw/lib
+exec /sw/bin/pngtopnm "$@"
+@end verbatim
+
+In order to force make to build a complete manual (this does not
+rebuild all examples, only things which are changed), I recommend
+writing a script like this:
+
+@verbatim
+### run from Documentation/user/
+# possibly required on OSX and/or old texinfo
+# ulimit -n 4096
+if [ -e out-www/lilypond.texi ]; then rm out-www/lilypond.* ; fi;
+if [ -e out-www/lilypond-program.texi ]; then rm
+out-www/lilypond-program.* ; fi;
+if [ -e out-www/lilypond-learning.texi ]; then rm
+out-www/lilypond-learning.* ; fi;
+nice make LILYPOND_EXTERNAL_BINARY=~/usr/bin/lilypond web
+@end verbatim
+
+To rebuild the complete HTML docs, run the above script from the
+@file{Documentation/user/} directory, then run the final line (the
+@code{nice make}) from the top source dir.
+
+
@node Testing LilyPond
@subsection 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
projects / lilypond.git / blobdiff