version that you are working on. See TRANSLATION for details.
@end ignore
+@c \version "2.11.61"
+
@ifclear INSTALL
@node Install
@chapter Install
@end ifclear
-@c I don't know what this comment does. Remove? -gp
-@ignore
-@h tml
-<a name="download-source">
-@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
@node Precompiled binaries
@section Precompiled binaries
-@subsection Downloading
+@unnumberedsubsec Downloading
Check out @uref{http://lilypond.org/web/install/} for up to date
information on binary packages for your platform. If your operating
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
+@knownissues
+
+If you have MacOS 10.3 or 10.4 and you would like to use Python
+scripts such as @command{convert-ly} and @command{lilypond-book}, see
+@ref{Setup for MacOS X,,,lilypond-program,Application Usage}.
+
+
+@node Compiling from source
+@section Compiling from source
+
+@ignore
+You can also compile LilyPond directly from the source code. This
+requires that you can read English, so this section is not
+translated. If you really want to compile LilyPond, see
+@iftex
+@c DO NOT translate the following line at all.
+@ref{Compiling from source,,,lilypond-program,Application Usage}.
+@end iftex
+@ifhtml
+@c Please translate the following line (but not the .html file name)
+the @uref{Compiling-from-source.html,documentation in English}.
+@end ifhtml
+@end ignore
@c TRANSLATORS:
@c Please **do not** translate anything below this line. Users
-@c should not be compiling LilyPond themselves; if they really
+@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
+@c Instead, please uncomment and translate the paragraph above,
+@c and remove all stuff (menu, nodes, contents) below this line.
@menu
* Downloading source code::
* Requirements::
* Building LilyPond::
-* Building documentation without compiling LilyPond::
+* Building documentation::
* Testing LilyPond::
* Problems::
@end menu
@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 @uref{http://metafont.tutorial.free.fr/,MetaFont} (mf-nowin, mf, mfw or
+mfont binaries) and @uref{http://cm.bell-labs.com/who/hobby/MetaPost.html,MetaPost}
+(mpost binary), usually packaged with a @LaTeX{} distribution like
+tetex or texlive.
+
+@item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
+(version 1.33 or newer recommended).
+
@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.
+@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
@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.
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
@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
@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.
+@item @uref{http://www.nongnu.org/texi2html/,Texi2HTML} 1.79 or newer
+is strongly recommended to build documentation in HTML; support for
+building HTML documentation using @command{makeinfo} from GNU Texinfo
+is deprecated.
@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
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.
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 @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
+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
+
+
+@unnumberedsubsubsec Useful @command{make} variables
+
+If a less verbose build output if desired, the variable
+@code{QUIET_BUILD} may be set to @code{1} on @command{make} command
+line, or in @file{local.make} at top of the build tree.
+
+
+@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}.
+
+The makefile variable @code{QUIET_BUILD} may be set to @code{1} for a
+less verbose build output, just like for building the programs.
+
+@knownissues
+
+@code{-j} command-line option of @command{make} is unsupported for
+building the documentation. As the most time consuming task is
+running LilyPond to build images of music, the makefile variable
+@code{CPU_COUNT} may be set in @file{local.make} or on the command line
+to the number of @code{.ly} files that LilyPond should process
+simultaneously, e.g. on a bi-processor or dual core machine
+
+@example
+make CPU_COUNT=2 web
+@end example
+
+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=/path/to/bin/lilypond web
-% change the lilypond directory as appropriate
@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 ( Documentation/user/ ) without building all
-the input/* stuff.
+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
-@refbugs
+@knownissues
You may also need to create a script for @command{pngtopnm} and
-@code{pnmtopng}. On Linux, I use this:
+@code{pnmtopng}. On GNU/Linux, I use this:
@verbatim
export LD_LIBRARY_PATH=/usr/lib
exec /usr/bin/pngtopnm "$@"
@end verbatim
-On OSX, I use this:
+On MacOS@tie{}X, 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
@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