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.
15 @c I don't know what this comment does. Remove? -gp
18 <a name="download-source">
22 There are two sets of releases for LilyPond: stable releases, and
23 unstable development releases. Stable versions have an even-numbered
24 @q{minor} version number (i.e. 2.8, 2.10, 2.12, etc). Development
25 versions have an odd-numbered @q{minor} version number (i.e. 2.7, 2.9,
28 Building LilyPond is a very involved process, so we @strong{highly}
29 recommend using the precompiled binaries.
32 * Precompiled binaries::
33 * Compiling from source::
37 @node Precompiled binaries
38 @section Precompiled binaries
40 @subsection Downloading
42 Check out @uref{http://lilypond.org/web/install/} for up to date
43 information on binary packages for your platform. If your operating
44 system is not covered on that general page, please see the complete list
45 at @uref{http://download.linuxaudio.org/lilypond/binaries/}
47 We currently create binaries for
50 darwin-ppc - MacOS X powerpc
51 darwin-x86 - MacOS X intel
52 freebsd-64 - FreeBSD 6.x, x86_64
53 freebsd-x86 - FreeBSD 4.x, x86
54 linux-64 - Any GNU/Linux distribution, x86_64
55 linux-arm - Any GNU/Linux distribution, arm
56 linux-ppc - Any GNU/Linux distribution, powerpc
57 linux-x86 - Any GNU/Linux distribution, x86
63 @c Please **do not** translate anything below this line. Users
64 @c should not be compiling LilyPond themselves; if they really
65 @c want to do so, they should be able to read the English docs,
66 @c because they'll probably need to ask questions in English
67 @c on the -devel list. -gp
69 @node Compiling from source
70 @section Compiling from source
73 * Downloading source code::
76 * Building documentation without compiling LilyPond::
81 @node Downloading source code
82 @subsection Downloading source code
88 @uref{http://lilypond.org/download/} by HTTP.
90 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
92 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
95 git clone git://git.sv.gnu.org/lilypond.git
98 The repository does not contain generated files. To create
105 For information on packaging, see @uref{http://lilypond.org/devel}.
109 @subsection Requirements
111 @unnumberedsubsubsec Compilation
113 In addition to the packages needed for running Lilypond (see below), you
114 need the following extra packages for building.
116 When installing a binary package FOO, you may need to install the
117 FOO-devel, libFOO-dev or FOO-dev package too.
121 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
123 @item New Century Schoolbook fonts, as PFB files. These are shipped with
124 X11 and Ghostscript, and are named @file{c059033l.pfb}
125 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
127 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
128 newer); you may need to install some additional packages to get mftrace
131 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
132 1.8.2 or newer). If you are installing binary packages, you may need to
133 install guile-devel or guile-dev or libguile-dev too.
135 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
137 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
140 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
142 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
144 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
146 @item @uref{http://www.gnu.org/software/flex/,Flex}
148 @item @uref{http://www.perl.org/,Perl}
150 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
152 @item All packages required for running, including development packages with
153 header files and libraries.
158 @unnumberedsubsubsec Running requirements
160 Running LilyPond requires proper installation of the following software
164 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
165 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
166 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
167 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
168 (version 1.8.2 or newer), or patch 1.8.1 with
169 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
170 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
171 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
172 newer. 8.50 recommended)
173 @item Dejaview. (This is normally installed by default)
176 International fonts are required to create music with international text
180 @unnumberedsubsubsec Building documentation
182 You can view the documentation online at
183 @uref{http://lilypond.org/doc/}, but you can also build it locally.
184 This process requires a successful compile of lilypond. The
185 documentation is built by issuing
191 Building the website requires some additional tools and packages
194 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
196 @item International fonts (see input/regression/utf-8.ly for hints
197 about which font packages are necessary for your platform)
198 @item Ghostscript, 8.50 with the patch from
199 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
201 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
204 The HTML files can be installed into the standard documentation path
208 make out=www web-install
212 @node Building LilyPond
213 @subsection Building LilyPond
215 @unnumberedsubsubsec Compiling
217 To install GNU LilyPond, type
220 gunzip -c lilypond-x.y.z | tar xf -
222 ./configure # run with --help for applicable options
227 If you are not root, you should choose a @code{--prefix} argument that
228 points into your home directory, e.g.
231 ./configure --prefix=$HOME/usr
235 @unnumberedsubsubsec Compiling for multiple platforms
237 If you want to build multiple versions of LilyPond with different
238 configuration settings, you can use the @code{--enable-config=CONF}
239 option of configure. You should use @samp{make conf=CONF} to generate
240 the output in @file{out-CONF}. Example: Suppose you want to build
241 with and without profiling, then use the following for the normal
245 ./configure --prefix=$HOME/usr/ --enable-checking
250 and for the profiling version, specify a different configuration
253 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
255 make conf=prof install
259 @node Building documentation without compiling LilyPond
260 @subsection Building documentation without compiling LilyPond
262 The documentation can be built locally without compiling lilypond from
265 From a fresh git checkout, do
268 ./autogen.sh % ignore any warning messages
269 cp GNUmakefile.in GNUmakefile
271 nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web
272 % change the lilypond directory as appropriate
275 Please note that this may break sometimes -- for example, if a new
276 feature is added with a test file in input/regression, even the latest
277 unstable Lily will fail to build the docs.
279 You may build the manual ( Documentation/user/ ) without building all
284 You may also need to create a script for @command{pngtopnm} and
285 @code{pnmtopng}. On Linux, I use this:
288 export LD_LIBRARY_PATH=/usr/lib
289 exec /usr/bin/pngtopnm "$@"
295 export DYLD_LIBRARY_PATH=/sw/lib
296 exec /sw/bin/pngtopnm "$@"
299 In order to force make to build a complete manual (this does not
300 rebuild all examples, only things which are changed), I recommend
301 writing a script like this:
304 ### run from Documentation/user/
305 # possibly required on OSX and/or old texinfo
307 if [ -e out-www/lilypond.texi ]; then rm out-www/lilypond.* ; fi;
308 if [ -e out-www/lilypond-program.texi ]; then rm
309 out-www/lilypond-program.* ; fi;
310 if [ -e out-www/lilypond-learning.texi ]; then rm
311 out-www/lilypond-learning.* ; fi;
312 nice make LILYPOND_EXTERNAL_BINARY=~/usr/bin/lilypond web
315 To rebuild the complete HTML docs, run the above script from the
316 @file{Documentation/user/} directory, then run the final line (the
317 @code{nice make}) from the top source dir.
321 @node Testing LilyPond
322 @subsection Testing LilyPond
325 <a name="testing"></a>
328 LilyPond comes with an extensive suite that exercises the entire
329 program. This suite can be used to automatically check the impact of a
330 change. This is done as follows
334 @emph{## apply your changes, compile}
338 This will leave an HTML page @file{out/test-results/index.html}. This
339 page shows all the important differences that your change introduced,
340 whether in the layout, MIDI, performance or error reporting.
345 make test-redo @emph{## redo files differing from baseline}
346 make test-clean @emph{## remove all test results}
350 and then run @code{make check} again.
352 For tracking memory usage as part of this test, you will need GUILE
353 CVS; especially the following patch:
354 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
356 For checking the coverage of the test suite, do the following
359 ./buildscripts/build-coverage.sh
360 @emph{# uncovered files, least covered first}
361 python ./buildscripts/coverage.py --summary out-cov/*.cc
362 @emph{# consecutive uncovered lines, longest first}
363 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
370 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
371 reports to @email{bug-lilypond@@gnu.org}.
373 Bugs that are not fault of LilyPond are documented here.
375 @unnumberedsubsubsec Bison 1.875
377 There is a bug in bison-1.875: compilation fails with "parse error
378 before `goto'" in line 4922 due to a bug in bison. To fix, please
379 recompile bison 1.875 with the following fix
382 $ cd lily; make out/parser.cc
383 $ vi +4919 out/parser.cc
384 # append a semicolon to the line containing "__attribute__ ((__unused__))
390 @unnumberedsubsubsec Solaris
392 Solaris7, ./configure
394 @file{./configure} needs a POSIX compliant shell. On Solaris7,
395 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
396 is. Run configure like
399 CONFIG_SHELL=/bin/ksh ksh -c ./configure
406 CONFIG_SHELL=/bin/bash bash -c ./configure
409 @unnumberedsubsubsec FreeBSD
411 To use system fonts, dejaview must be installed. With the default
412 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
414 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
415 following line just after the @code{<fontconfig>} line. (Adjust as necessary
419 <dir>/usr/X11R6/lib/X11/fonts</dir>
423 @unnumberedsubsubsec International fonts
425 On MacOs X, all fonts are installed by default. However, finding all
426 system fonts requires a bit of configuration; see
427 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
428 this post} on the @code{lilypond-user} mailing list.
430 On Linux, international fonts are installed by different means on
431 every distribution. We cannot list the exact commands or packages
432 that are necessary, as each distribution is different, and the exact
433 package names within each distribution changes. Here are some
439 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
440 ttfonts-zh_CN fonts-ja fonts-hebrew
444 apt-get install emacs-intl-fonts xfonts-intl-.* \
445 ttf-kochi-gothic ttf-kochi-mincho \
446 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi