version that you are working on. See TRANSLATION for details.
@end ignore
-@c \version "2.11.51"
+@c \version "2.12.0"
@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
recommend using the precompiled binaries.
@menu
-* Precompiled binaries::
-* Compiling from source::
+* Precompiled binaries::
+* Compiling from source::
@end menu
@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::
-* Testing LilyPond::
-* Problems::
+* Downloading source code::
+* Requirements::
+* Building LilyPond::
+* Building documentation::
+* Testing LilyPond::
+* Problems::
@end menu
@node Downloading source code
@uref{http://lilypond.org/download/} by HTTP.
@item tarballs from
@uref{http://download.linuxaudio.org/lilypond/} by HTTP.
-@item
+@item
GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
@example
@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 @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
-@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
+@item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}
+(version 0.17 or newer).
@item @uref{http://www.gnu.org/software/flex/,Flex}.
@itemize
@item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
-@item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
+@item @uref{http://fontconfig.org/,FontConfig} (version 2.2).
@item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
@item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
(version 1.8.2 or newer), or patch 1.8.1 with
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, and some
-additional tools and packages
+additional tools and packages:
@itemize
@item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
@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
@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
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
+The most time consuming task for building the documentation is running
+LilyPond to build images of music, and there cannot be several
+simultaneously running @command{lilypond-book} instances, so @code{-j}
+@command{make} option does not significantly speed up the build process.
+To help speed it up, the makefile variable @var{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 -j3 CPU_COUNT=3 web
+@end example
+
+@noindent
+The recommended value of @var{CPU_COUNT} is one plus the number of
+cores or processors, but it is advisable to set it to a smaller value
+if your system has not enough RAM to run that many simultaneous
+LilyPond instances.
+
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
@verbatim
export DYLD_LIBRARY_PATH=/sw/lib
-exec /sw/bin/pngtopnm "$@"
+exec /sw/bin/pngtopnm "$@"
@end verbatim
For checking the coverage of the test suite, do the following
@example
-./buildscripts/build-coverage.sh
+./scripts/aux/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
+./scripts/aux/coverage.py --summary out-cov/*.cc
+@emph{# consecutive uncovered lines, longest first}
+./scripts/aux/coverage.py --uncovered out-cov/*.cc
@end example
Red Hat Fedora
taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
- ttfonts-zh_CN fonts-ja fonts-hebrew
+ 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
+ xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi
@end verbatim
projects / lilypond.git / blobdiff