1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond-program.tely
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. See TRANSLATION for details.
17 There are two sets of releases for LilyPond: stable releases, and
18 unstable development releases. Stable versions have an even-numbered
19 @q{minor} version number (i.e. 2.8, 2.10, 2.12, etc). Development
20 versions have an odd-numbered @q{minor} version number (i.e. 2.7, 2.9,
23 Building LilyPond is a very involved process, so we @strong{highly}
24 recommend using the precompiled binaries.
27 * Precompiled binaries::
28 * Compiling from source::
32 @node Precompiled binaries
33 @section Precompiled binaries
35 @unnumberedsubsec Downloading
37 Check out @uref{http://lilypond.org/web/install/} for up to date
38 information on binary packages for your platform. If your operating
39 system is not covered on that general page, please see the complete list
40 at @uref{http://download.linuxaudio.org/lilypond/binaries/}
42 We currently create binaries for
45 darwin-ppc - MacOS X powerpc
46 darwin-x86 - MacOS X intel
47 freebsd-64 - FreeBSD 6.x, x86_64
48 freebsd-x86 - FreeBSD 4.x, x86
49 linux-64 - Any GNU/Linux distribution, x86_64
50 linux-ppc - Any GNU/Linux distribution, powerpc
51 linux-x86 - Any GNU/Linux distribution, x86
57 If you have MacOS 10.3 or 10.4 and you would like to use Python
58 scripts such as @command{convert-ly} and @command{lilypond-book}, see
59 @ref{Setup for MacOS X}.
62 @node Compiling from source
63 @section Compiling from source
66 You can also compile LilyPond directly from the source code. This
67 requires that you can read English, so this section is not
68 translated. If you really want to compile LilyPond, see
70 @c DO NOT translate the following line at all.
71 @ref{Compiling from source,,,lilypond-program,Application Usage}.
74 @c Please translate the following line (but not the .html file name)
75 the @uref{Compiling-from-source.html,documentation in English}.
80 @c Please **do not** translate anything below this line. Users
81 @c should not be compiling LilyPond themselves; if they really
82 @c want to do so, they should be able to read the English docs,
83 @c because they'll probably need to ask questions in English
84 @c on the -devel list. -gp
85 @c Instead, please uncomment and translate the paragraph above,
86 @c and remove all stuff (menu, nodes, contents) below this line.
89 * Downloading source code::
92 * Building documentation::
97 @node Downloading source code
98 @subsection Downloading source code
104 @uref{http://lilypond.org/download/} by HTTP.
106 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
108 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
111 git clone git://git.sv.gnu.org/lilypond.git
114 The repository does not contain generated files. To create
115 @file{configure}, run
121 For information on packaging, see @uref{http://lilypond.org/devel}.
125 @subsection Requirements
127 @unnumberedsubsubsec Compilation
129 In addition to the packages needed for running LilyPond (see below), you
130 need the following extra packages for building.
132 When installing a binary package FOO, you may need to install the
133 FOO-devel, libFOO-dev or FOO-dev package too.
137 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
139 @item @uref{http://metafont.tutorial.free.fr/,MetaFont} (mf-nowin, mf, mfw or
140 mfont binaries) and @uref{http://cm.bell-labs.com/who/hobby/MetaPost.html,MetaPost}
141 (mpost binary), usually packaged with a @LaTeX{} distribution like
144 @item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
145 (version 1.33 or newer recommended).
147 @item New Century Schoolbook fonts, as PFB files. These are shipped with
148 X11 and Ghostscript, and are named @file{c059033l.pfb}
149 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}.
151 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
152 1.8.2 or newer). If you are installing binary packages, you may need to
153 install guile-devel or guile-dev or libguile-dev too.
155 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer).
157 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.4 or
158 newer. 4.x is strongly recommended).
160 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
162 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
164 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
166 @item @uref{http://www.gnu.org/software/flex/,Flex}.
168 @item @uref{http://www.perl.org/,Perl}.
170 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}.
172 @item All packages required for running, including development packages with
173 header files and libraries.
178 @unnumberedsubsubsec Running requirements
180 Running LilyPond requires proper installation of the following software
184 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
185 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
186 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
187 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
188 (version 1.8.2 or newer), or patch 1.8.1 with
189 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
190 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
191 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
192 newer. 8.50 recommended)
193 @item Dejaview. (This is normally installed by default)
196 International fonts are required to create music with international text
200 @unnumberedsubsubsec Requirements for building documentation
202 You can view the documentation online at
203 @uref{http://lilypond.org/doc/}, but you can also build it locally.
204 This process requires a successful compile of LilyPond, and some
205 additional tools and packages:
208 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
210 @item International fonts (see input/regression/utf-8.ly for hints
211 about which font packages are necessary for your platform)
212 @item Ghostscript, 8.50 with the patch from
213 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
215 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}, or use
216 a release of Ghostscript which includes these patches, for example
218 @item @uref{http://www.nongnu.org/texi2html/,Texi2HTML} 1.79 or newer
219 is strongly recommended to build documentation in HTML; support for
220 building HTML documentation using @command{makeinfo} from GNU Texinfo
225 @node Building LilyPond
226 @subsection Building LilyPond
228 @unnumberedsubsubsec Compiling
230 To install GNU LilyPond, type
233 gunzip -c lilypond-x.y.z | tar xf -
235 ./configure # run with --help for applicable options
241 If you are not root, you should choose a @code{--prefix} argument that
242 points into your home directory, e.g.
245 ./configure --prefix=$HOME/usr
249 @unnumberedsubsubsec Compiling for multiple platforms
251 If you want to build multiple versions of LilyPond with different
252 configuration settings, you can use the @code{--enable-config=CONF}
253 option of @command{configure}. You should use @code{make conf=CONF}
254 to generate the output in @file{out-CONF}. For example, suppose you
255 want to build with and without profiling, then use the following for
259 ./configure --prefix=$HOME/usr/ --enable-checking
264 and for the profiling version, specify a different configuration
267 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
269 make conf=prof install
273 @unnumberedsubsubsec Compiling outside the source tree
275 It is possible to compile LilyPond in a build tree different from the
276 source tree, with @code{--srcdir} option of @command{configure}:
279 mkdir lily-build && cd lily-build
280 @var{sourcedir}/configure --srcdir=@var{sourcedir}
285 @unnumberedsubsubsec Useful @command{make} variables
287 If a less verbose build output if desired, the variable
288 @code{QUIET_BUILD} may be set to @code{1} on @command{make} command
289 line, or in @file{local.make} at top of the build tree.
292 @node Building documentation
293 @subsection Building documentation
295 This requires a successful compile of LilyPond, or using an external
299 * Commands for building documentation:: Compiling and installing the documentation.
300 * Building documentation without compiling LilyPond:: Using a LilyPond binary already installed.
303 @node Commands for building documentation
304 @unnumberedsubsubsec Commands for building documentation
306 The documentation is built by issuing
312 After compilation, the HTML documentation tree is available in
313 @file{out-www/offline-root/}, and can be browsed locally.
315 The HTML and PDF files can be installed into the standard documentation
323 This also installs Info documentation with images if the installation
324 prefix is properly set; otherwise, instructions for manual installation
325 of Info documentation are printed on standard output.
327 It is also possible to build a documentation tree in
328 @file{out-www/online-root/}, with special processing, so it can be used
329 on a website with content negotiation for automatic language selection;
330 this can be achieved by issuing
333 make WEB_TARGETS=online web
337 and both @q{offline} and @q{online} targets can be generated by issuing
340 make WEB_TARGETS="offline online" web
343 Several targets are available to clean the documentation build and
344 help with maintaining documentation; an overview of these targets is
352 from every directory in the build tree. Most targets for
353 documentation maintenance are available from @file{Documentation/};
354 for more information, see @file{Documentation/user/README.txt} and
355 @file{Documentation/TRANSLATION}.
357 The makefile variable @code{QUIET_BUILD} may be set to @code{1} for a
358 less verbose build output, just like for building the programs.
362 @code{-j} command-line option of @command{make} is unsupported for
363 building the documentation. As the most time consuming task is
364 running LilyPond to build images of music, the makefile variable
365 @code{CPU_COUNT} may be set in @file{local.make} or on the command line
366 to the number of @code{.ly} files that LilyPond should process
367 simultaneously, e.g. on a bi-processor or dual core machine
373 If source files have changed since last documentation build, output
374 files that need to be rebuilt are normally rebuilt, even if you do not
375 run @code{make web-clean} first. However, building dependencies in the
376 documentation are so complex that rebuilding of some targets may not
377 be triggered as they should be; a workaround is to force rebuilding
378 by touching appropriate files, e.g.
381 touch Documentation/user/*.itely
386 @node Building documentation without compiling LilyPond
387 @unnumberedsubsubsec Building documentation without compiling LilyPond
389 The documentation can be built locally without compiling LilyPond
390 binary, if LilyPond is already installed on your system.
392 From a fresh Git checkout, do
395 ./autogen.sh # ignore any warning messages
396 cp GNUmakefile.in GNUmakefile
398 nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
401 Please note that this may break sometimes -- for example, if a new
402 feature is added with a test file in input/regression, even the latest
403 development release of LilyPond will fail to build the docs.
405 You may build the manual without building all the @file{input/*}
406 stuff: change directory, for example to @file{Documentation/user},
407 issue @code{make web}, which will build documentation in a
408 subdirectory @file{out-www} from the source files in current
409 directory. In this case, if you also want to browse the documentation
410 in its post-processed form, change back to top directory and issue
413 make out=www WWW-post
418 You may also need to create a script for @command{pngtopnm} and
419 @code{pnmtopng}. On GNU/Linux, I use this:
422 export LD_LIBRARY_PATH=/usr/lib
423 exec /usr/bin/pngtopnm "$@"
426 On MacOS@tie{}X, I use this:
429 export DYLD_LIBRARY_PATH=/sw/lib
430 exec /sw/bin/pngtopnm "$@"
435 @node Testing LilyPond
436 @subsection Testing LilyPond
439 <a name="testing"></a>
442 LilyPond comes with an extensive suite that exercises the entire
443 program. This suite can be used to automatically check the impact of a
444 change. This is done as follows
448 @emph{## apply your changes, compile}
452 This will leave an HTML page @file{out/test-results/index.html}. This
453 page shows all the important differences that your change introduced,
454 whether in the layout, MIDI, performance or error reporting.
459 make test-redo @emph{## redo files differing from baseline}
460 make test-clean @emph{## remove all test results}
464 and then run @code{make check} again.
466 For tracking memory usage as part of this test, you will need GUILE
467 CVS; especially the following patch:
468 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
470 For checking the coverage of the test suite, do the following
473 ./buildscripts/build-coverage.sh
474 @emph{# uncovered files, least covered first}
475 python ./buildscripts/coverage.py --summary out-cov/*.cc
476 @emph{# consecutive uncovered lines, longest first}
477 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
484 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
485 reports to @email{bug-lilypond@@gnu.org}.
487 Bugs that are not fault of LilyPond are documented here.
489 @unnumberedsubsubsec Bison 1.875
491 There is a bug in bison-1.875: compilation fails with "parse error
492 before `goto'" in line 4922 due to a bug in bison. To fix, please
493 recompile bison 1.875 with the following fix
496 $ cd lily; make out/parser.cc
497 $ vi +4919 out/parser.cc
498 # append a semicolon to the line containing "__attribute__ ((__unused__))
504 @unnumberedsubsubsec Solaris
506 Solaris7, ./configure
508 @file{./configure} needs a POSIX compliant shell. On Solaris7,
509 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
510 is. Run configure like
513 CONFIG_SHELL=/bin/ksh ksh -c ./configure
520 CONFIG_SHELL=/bin/bash bash -c ./configure
523 @unnumberedsubsubsec FreeBSD
525 To use system fonts, dejaview must be installed. With the default
526 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
528 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
529 following line just after the @code{<fontconfig>} line. (Adjust as necessary
533 <dir>/usr/X11R6/lib/X11/fonts</dir>
537 @unnumberedsubsubsec International fonts
539 On MacOS@tie{}X, all fonts are installed by default. However, finding all
540 system fonts requires a bit of configuration; see
541 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
542 this post} on the @code{lilypond-user} mailing list.
544 On Linux, international fonts are installed by different means on
545 every distribution. We cannot list the exact commands or packages
546 that are necessary, as each distribution is different, and the exact
547 package names within each distribution changes. Here are some
553 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
554 ttfonts-zh_CN fonts-ja fonts-hebrew
558 apt-get install emacs-intl-fonts xfonts-intl-.* \
559 ttf-kochi-gothic ttf-kochi-mincho \
560 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi