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 without compiling LilyPond::
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 New Century Schoolbook fonts, as PFB files. These are shipped with
126 X11 and Ghostscript, and are named @file{c059033l.pfb}
127 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
129 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
130 1.8.2 or newer). If you are installing binary packages, you may need to
131 install guile-devel or guile-dev or libguile-dev too.
133 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer).
135 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
138 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
140 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
142 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
144 @item @uref{http://www.gnu.org/software/flex/,Flex}
146 @item @uref{http://www.perl.org/,Perl}
148 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
150 @item All packages required for running, including development packages with
151 header files and libraries.
156 @unnumberedsubsubsec Running requirements
158 Running LilyPond requires proper installation of the following software
162 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
163 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
164 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
165 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
166 (version 1.8.2 or newer), or patch 1.8.1 with
167 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
168 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
169 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
170 newer. 8.50 recommended)
171 @item Dejaview. (This is normally installed by default)
174 International fonts are required to create music with international text
178 @unnumberedsubsubsec Building documentation
180 You can view the documentation online at
181 @uref{http://lilypond.org/doc/}, but you can also build it locally.
182 This process requires a successful compile of LilyPond, and some
183 additional tools and packages
186 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
188 @item International fonts (see input/regression/utf-8.ly for hints
189 about which font packages are necessary for your platform)
190 @item Ghostscript, 8.50 with the patch from
191 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
193 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
196 The documentation is built by issuing
202 After compilation, the HTML documentation tree is available in
203 @file{out-www/offline-root/}, and can be browsed locally.
205 The HTML and PDF files can be installed into the standard documentation
209 make out=www web-install
212 It is also possible to build a documentation tree in
213 @file{out-www/online-root/}, with special processing, so it can be used
214 on a website with content negotiation for automatic language selection;
215 this can be achieved by issuing
218 make WEB_TARGETS=online web
222 and both @q{offline} and @q{online} targets can be generated by issuing
225 make WEB_TARGETS="offline online" web
229 @node Building LilyPond
230 @subsection Building LilyPond
232 @unnumberedsubsubsec Compiling
234 To install GNU LilyPond, type
237 gunzip -c lilypond-x.y.z | tar xf -
239 ./configure # run with --help for applicable options
244 If you are not root, you should choose a @code{--prefix} argument that
245 points into your home directory, e.g.
248 ./configure --prefix=$HOME/usr
252 @unnumberedsubsubsec Compiling for multiple platforms
254 If you want to build multiple versions of LilyPond with different
255 configuration settings, you can use the @code{--enable-config=CONF}
256 option of configure. You should use @code{make conf=CONF} to generate
257 the output in @file{out-CONF}. Example: Suppose you want to build
258 with and without profiling, then use the following for the normal
262 ./configure --prefix=$HOME/usr/ --enable-checking
267 and for the profiling version, specify a different configuration
270 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
272 make conf=prof install
276 @node Building documentation without compiling LilyPond
277 @subsection Building documentation without compiling LilyPond
279 The documentation can be built locally without compiling LilyPond from
282 From a fresh git checkout, do
285 ./autogen.sh % ignore any warning messages
286 cp GNUmakefile.in GNUmakefile
288 nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
289 % change the lilypond directory as appropriate
292 Please note that this may break sometimes -- for example, if a new
293 feature is added with a test file in input/regression, even the latest
294 unstable Lily will fail to build the docs.
296 You may build the manual ( Documentation/user/ ) without building all
301 You may also need to create a script for @command{pngtopnm} and
302 @code{pnmtopng}. On Linux, I use this:
305 export LD_LIBRARY_PATH=/usr/lib
306 exec /usr/bin/pngtopnm "$@"
309 On MacOS@tie{}X, I use this:
312 export DYLD_LIBRARY_PATH=/sw/lib
313 exec /sw/bin/pngtopnm "$@"
316 In order to force make to build a complete manual (this does not
317 rebuild all examples, only things which are changed), I recommend
318 writing a script like this:
321 ### run from Documentation/user/
322 # possibly required on OS X and/or old texinfo
324 if [ -e out-www/lilypond.texi ]; then rm out-www/lilypond.* ; fi;
325 if [ -e out-www/lilypond-program.texi ]; then rm
326 out-www/lilypond-program.* ; fi;
327 if [ -e out-www/lilypond-learning.texi ]; then rm
328 out-www/lilypond-learning.* ; fi;
329 nice make LILYPOND_EXTERNAL_BINARY=~/usr/bin/lilypond web
332 To rebuild the complete HTML docs, run the above script from the
333 @file{Documentation/user/} directory, then run the final line (the
334 @code{nice make}) from the top source dir.
338 @node Testing LilyPond
339 @subsection Testing LilyPond
342 <a name="testing"></a>
345 LilyPond comes with an extensive suite that exercises the entire
346 program. This suite can be used to automatically check the impact of a
347 change. This is done as follows
351 @emph{## apply your changes, compile}
355 This will leave an HTML page @file{out/test-results/index.html}. This
356 page shows all the important differences that your change introduced,
357 whether in the layout, MIDI, performance or error reporting.
362 make test-redo @emph{## redo files differing from baseline}
363 make test-clean @emph{## remove all test results}
367 and then run @code{make check} again.
369 For tracking memory usage as part of this test, you will need GUILE
370 CVS; especially the following patch:
371 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
373 For checking the coverage of the test suite, do the following
376 ./buildscripts/build-coverage.sh
377 @emph{# uncovered files, least covered first}
378 python ./buildscripts/coverage.py --summary out-cov/*.cc
379 @emph{# consecutive uncovered lines, longest first}
380 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
387 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
388 reports to @email{bug-lilypond@@gnu.org}.
390 Bugs that are not fault of LilyPond are documented here.
392 @unnumberedsubsubsec Bison 1.875
394 There is a bug in bison-1.875: compilation fails with "parse error
395 before `goto'" in line 4922 due to a bug in bison. To fix, please
396 recompile bison 1.875 with the following fix
399 $ cd lily; make out/parser.cc
400 $ vi +4919 out/parser.cc
401 # append a semicolon to the line containing "__attribute__ ((__unused__))
407 @unnumberedsubsubsec Solaris
409 Solaris7, ./configure
411 @file{./configure} needs a POSIX compliant shell. On Solaris7,
412 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
413 is. Run configure like
416 CONFIG_SHELL=/bin/ksh ksh -c ./configure
423 CONFIG_SHELL=/bin/bash bash -c ./configure
426 @unnumberedsubsubsec FreeBSD
428 To use system fonts, dejaview must be installed. With the default
429 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
431 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
432 following line just after the @code{<fontconfig>} line. (Adjust as necessary
436 <dir>/usr/X11R6/lib/X11/fonts</dir>
440 @unnumberedsubsubsec International fonts
442 On MacOS@tie{}X, all fonts are installed by default. However, finding all
443 system fonts requires a bit of configuration; see
444 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
445 this post} on the @code{lilypond-user} mailing list.
447 On Linux, international fonts are installed by different means on
448 every distribution. We cannot list the exact commands or packages
449 that are necessary, as each distribution is different, and the exact
450 package names within each distribution changes. Here are some
456 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
457 ttfonts-zh_CN fonts-ja fonts-hebrew
461 apt-get install emacs-intl-fonts xfonts-intl-.* \
462 ttf-kochi-gothic ttf-kochi-mincho \
463 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi