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 @c I don't know what this comment does. Remove? -gp
20 <a name="download-source">
24 There are two sets of releases for LilyPond: stable releases, and
25 unstable development releases. Stable versions have an even-numbered
26 @q{minor} version number (i.e. 2.8, 2.10, 2.12, etc). Development
27 versions have an odd-numbered @q{minor} version number (i.e. 2.7, 2.9,
30 Building LilyPond is a very involved process, so we @strong{highly}
31 recommend using the precompiled binaries.
34 * Precompiled binaries::
35 * Compiling from source::
39 @node Precompiled binaries
40 @section Precompiled binaries
42 @subsection Downloading
44 Check out @uref{http://lilypond.org/web/install/} for up to date
45 information on binary packages for your platform. If your operating
46 system is not covered on that general page, please see the complete list
47 at @uref{http://download.linuxaudio.org/lilypond/binaries/}
49 We currently create binaries for
52 darwin-ppc - MacOS X powerpc
53 darwin-x86 - MacOS X intel
54 freebsd-64 - FreeBSD 6.x, x86_64
55 freebsd-x86 - FreeBSD 4.x, x86
56 linux-64 - Any GNU/Linux distribution, x86_64
57 linux-arm - Any GNU/Linux distribution, arm
58 linux-ppc - Any GNU/Linux distribution, powerpc
59 linux-x86 - Any GNU/Linux distribution, x86
65 @c Please **do not** translate anything below this line. Users
66 @c should not be compiling LilyPond themselves; if they really
67 @c want to do so, they should be able to read the English docs,
68 @c because they'll probably need to ask questions in English
69 @c on the -devel list. -gp
71 @node Compiling from source
72 @section Compiling from source
75 * Downloading source code::
78 * Building documentation::
83 @node Downloading source code
84 @subsection Downloading source code
90 @uref{http://lilypond.org/download/} by HTTP.
92 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
94 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
97 git clone git://git.sv.gnu.org/lilypond.git
100 The repository does not contain generated files. To create
101 @file{configure}, run
107 For information on packaging, see @uref{http://lilypond.org/devel}.
111 @subsection Requirements
113 @unnumberedsubsubsec Compilation
115 In addition to the packages needed for running LilyPond (see below), you
116 need the following extra packages for building.
118 When installing a binary package FOO, you may need to install the
119 FOO-devel, libFOO-dev or FOO-dev package too.
123 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
125 @item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
126 (version 1.33 or newer recommended).
128 @item New Century Schoolbook fonts, as PFB files. These are shipped with
129 X11 and Ghostscript, and are named @file{c059033l.pfb}
130 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}.
132 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
133 1.8.2 or newer). If you are installing binary packages, you may need to
134 install guile-devel or guile-dev or libguile-dev too.
136 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer).
138 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.4 or
139 newer. 4.x is strongly recommended).
141 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
143 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
145 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
147 @item @uref{http://www.gnu.org/software/flex/,Flex}.
149 @item @uref{http://www.perl.org/,Perl}.
151 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}.
153 @item All packages required for running, including development packages with
154 header files and libraries.
159 @unnumberedsubsubsec Running requirements
161 Running LilyPond requires proper installation of the following software
165 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
166 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
167 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
168 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
169 (version 1.8.2 or newer), or patch 1.8.1 with
170 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
171 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
172 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
173 newer. 8.50 recommended)
174 @item Dejaview. (This is normally installed by default)
177 International fonts are required to create music with international text
181 @unnumberedsubsubsec Requirements for building documentation
183 You can view the documentation online at
184 @uref{http://lilypond.org/doc/}, but you can also build it locally.
185 This process requires a successful compile of LilyPond, and some
186 additional tools and packages
189 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
191 @item International fonts (see input/regression/utf-8.ly for hints
192 about which font packages are necessary for your platform)
193 @item Ghostscript, 8.50 with the patch from
194 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
196 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}, or use
197 a release of Ghostscript which includes these patches, for example
202 @node Building LilyPond
203 @subsection Building LilyPond
205 @unnumberedsubsubsec Compiling
207 To install GNU LilyPond, type
210 gunzip -c lilypond-x.y.z | tar xf -
212 ./configure # run with --help for applicable options
218 If you are not root, you should choose a @code{--prefix} argument that
219 points into your home directory, e.g.
222 ./configure --prefix=$HOME/usr
226 @unnumberedsubsubsec Compiling for multiple platforms
228 If you want to build multiple versions of LilyPond with different
229 configuration settings, you can use the @code{--enable-config=CONF}
230 option of @command{configure}. You should use @code{make conf=CONF}
231 to generate the output in @file{out-CONF}. For example, suppose you
232 want to build with and without profiling, then use the following for
236 ./configure --prefix=$HOME/usr/ --enable-checking
241 and for the profiling version, specify a different configuration
244 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
246 make conf=prof install
250 @unnumberedsubsubsec Compiling outside the source tree
252 It is possible to compile LilyPond in a build tree different from the
253 source tree, with @code{--srcdir} option of @command{configure}:
256 mkdir lily-build && cd lily-build
257 @var{sourcedir}/configure --srcdir=@var{sourcedir}
261 @node Building documentation
262 @subsection Building documentation
264 This requires a successful compile of LilyPond, or using an external
268 * Commands for building documentation:: Compiling and installing the documentation.
269 * Building documentation without compiling LilyPond:: Using a LilyPond binary already installed.
272 @node Commands for building documentation
273 @unnumberedsubsubsec Commands for building documentation
275 The documentation is built by issuing
281 After compilation, the HTML documentation tree is available in
282 @file{out-www/offline-root/}, and can be browsed locally.
284 The HTML and PDF files can be installed into the standard documentation
292 This also installs Info documentation with images if the installation
293 prefix is properly set; otherwise, instructions for manual installation
294 of Info documentation are printed on standard output.
296 It is also possible to build a documentation tree in
297 @file{out-www/online-root/}, with special processing, so it can be used
298 on a website with content negotiation for automatic language selection;
299 this can be achieved by issuing
302 make WEB_TARGETS=online web
306 and both @q{offline} and @q{online} targets can be generated by issuing
309 make WEB_TARGETS="offline online" web
312 Several targets are available to clean the documentation build and
313 help with maintaining documentation; an overview of these targets is
321 from every directory in the build tree. Most targets for
322 documentation maintenance are available from @file{Documentation/};
323 for more information, see @file{Documentation/user/README.txt} and
324 @file{Documentation/TRANSLATION}.
328 If source files have changed since last documentation build, output
329 files that need to be rebuilt are normally rebuilt, even if you do not
330 run @code{make web-clean} first. However, building dependencies in the
331 documentation are so complex that rebuilding of some targets may not
332 be triggered as they should be; a workaround is to force rebuilding
333 by touching appropriate files, e.g.
336 touch Documentation/user/*.itely
341 @node Building documentation without compiling LilyPond
342 @unnumberedsubsubsec Building documentation without compiling LilyPond
344 The documentation can be built locally without compiling LilyPond
345 binary, if LilyPond is already installed on your system.
347 From a fresh Git checkout, do
350 ./autogen.sh # ignore any warning messages
351 cp GNUmakefile.in GNUmakefile
353 nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
356 Please note that this may break sometimes -- for example, if a new
357 feature is added with a test file in input/regression, even the latest
358 development release of LilyPond will fail to build the docs.
360 You may build the manual without building all the @file{input/*}
361 stuff: change directory, for example to @file{Documentation/user},
362 issue @code{make web}, which will build documentation in a
363 subdirectory @file{out-www} from the source files in current
364 directory. In this case, if you also want to browse the documentation
365 in its post-processed form, change back to top directory and issue
368 make out=www WWW-post
373 You may also need to create a script for @command{pngtopnm} and
374 @code{pnmtopng}. On GNU/Linux, I use this:
377 export LD_LIBRARY_PATH=/usr/lib
378 exec /usr/bin/pngtopnm "$@"
381 On MacOS@tie{}X, I use this:
384 export DYLD_LIBRARY_PATH=/sw/lib
385 exec /sw/bin/pngtopnm "$@"
390 @node Testing LilyPond
391 @subsection Testing LilyPond
394 <a name="testing"></a>
397 LilyPond comes with an extensive suite that exercises the entire
398 program. This suite can be used to automatically check the impact of a
399 change. This is done as follows
403 @emph{## apply your changes, compile}
407 This will leave an HTML page @file{out/test-results/index.html}. This
408 page shows all the important differences that your change introduced,
409 whether in the layout, MIDI, performance or error reporting.
414 make test-redo @emph{## redo files differing from baseline}
415 make test-clean @emph{## remove all test results}
419 and then run @code{make check} again.
421 For tracking memory usage as part of this test, you will need GUILE
422 CVS; especially the following patch:
423 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
425 For checking the coverage of the test suite, do the following
428 ./buildscripts/build-coverage.sh
429 @emph{# uncovered files, least covered first}
430 python ./buildscripts/coverage.py --summary out-cov/*.cc
431 @emph{# consecutive uncovered lines, longest first}
432 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
439 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
440 reports to @email{bug-lilypond@@gnu.org}.
442 Bugs that are not fault of LilyPond are documented here.
444 @unnumberedsubsubsec Bison 1.875
446 There is a bug in bison-1.875: compilation fails with "parse error
447 before `goto'" in line 4922 due to a bug in bison. To fix, please
448 recompile bison 1.875 with the following fix
451 $ cd lily; make out/parser.cc
452 $ vi +4919 out/parser.cc
453 # append a semicolon to the line containing "__attribute__ ((__unused__))
459 @unnumberedsubsubsec Solaris
461 Solaris7, ./configure
463 @file{./configure} needs a POSIX compliant shell. On Solaris7,
464 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
465 is. Run configure like
468 CONFIG_SHELL=/bin/ksh ksh -c ./configure
475 CONFIG_SHELL=/bin/bash bash -c ./configure
478 @unnumberedsubsubsec FreeBSD
480 To use system fonts, dejaview must be installed. With the default
481 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
483 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
484 following line just after the @code{<fontconfig>} line. (Adjust as necessary
488 <dir>/usr/X11R6/lib/X11/fonts</dir>
492 @unnumberedsubsubsec International fonts
494 On MacOS@tie{}X, all fonts are installed by default. However, finding all
495 system fonts requires a bit of configuration; see
496 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
497 this post} on the @code{lilypond-user} mailing list.
499 On Linux, international fonts are installed by different means on
500 every distribution. We cannot list the exact commands or packages
501 that are necessary, as each distribution is different, and the exact
502 package names within each distribution changes. Here are some
508 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
509 ttfonts-zh_CN fonts-ja fonts-hebrew
513 apt-get install emacs-intl-fonts xfonts-intl-.* \
514 ttf-kochi-gothic ttf-kochi-mincho \
515 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi