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
64 @node Compiling from source
65 @section Compiling from source
68 * Downloading source code::
71 * Building documentation without compiling LilyPond::
76 @node Downloading source code
77 @subsection Downloading source code
83 @uref{http://lilypond.org/download/} by HTTP.
85 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
87 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
90 git clone git://git.sv.gnu.org/lilypond.git
93 The repository does not contain generated files. To create
100 For information on packaging, see @uref{http://lilypond.org/devel}.
104 @subsection Requirements
106 @unnumberedsubsubsec Compilation
108 In addition to the packages needed for running Lilypond (see below), you
109 need the following extra packages for building.
111 When installing a binary package FOO, you may need to install the
112 FOO-devel, libFOO-dev or FOO-dev package too.
116 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
118 @item New Century Schoolbook fonts, as PFB files. These are shipped with
119 X11 and Ghostscript, and are named @file{c059033l.pfb}
120 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
122 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
123 newer); you may need to install some additional packages to get mftrace
126 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
127 1.8.2 or newer). If you are installing binary packages, you may need to
128 install guile-devel or guile-dev or libguile-dev too.
130 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
132 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
135 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
137 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
139 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
141 @item @uref{http://www.gnu.org/software/flex/,Flex}
143 @item @uref{http://www.perl.org/,Perl}
145 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
147 @item All packages required for running, including development packages with
148 header files and libraries.
153 @unnumberedsubsubsec Running requirements
155 Running LilyPond requires proper installation of the following software
159 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
160 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
161 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
162 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
163 (version 1.8.2 or newer), or patch 1.8.1 with
164 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
165 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
166 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
167 newer. 8.50 recommended)
168 @item Dejaview. (This is normally installed by default)
171 International fonts are required to create music with international text
175 @unnumberedsubsubsec Building documentation
177 You can view the documentation online at
178 @uref{http://lilypond.org/doc/}, but you can also build it locally.
179 This process requires a successful compile of lilypond. The
180 documentation is built by issuing
186 Building the website requires some 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}.
199 The HTML files can be installed into the standard documentation path
203 make out=www web-install
207 @node Building LilyPond
208 @subsection Building LilyPond
210 @subsubsection Compiling
212 To install GNU LilyPond, type
215 gunzip -c lilypond-x.y.z | tar xf -
217 ./configure # run with --help for applicable options
222 If you are not root, you should choose a @code{--prefix} argument that
223 points into your home directory, e.g.
226 ./configure --prefix=$HOME/usr
230 @subsubsection Compiling for multiple platforms
232 If you want to build multiple versions of LilyPond with different
233 configuration settings, you can use the @code{--enable-config=CONF}
234 option of configure. You should use @samp{make conf=CONF} to generate
235 the output in @file{out-CONF}. Example: Suppose you want to build
236 with and without profiling, then use the following for the normal
240 ./configure --prefix=$HOME/usr/ --enable-checking
245 and for the profiling version, specify a different configuration
248 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
250 make conf=prof install
254 @node Building documentation without compiling LilyPond
255 @subsection Building documentation without compiling LilyPond
257 The documentation can be built locally without compiling lilypond from
260 From a fresh git checkout, do
263 ./autogen.sh % ignore any warning messages
264 cp GNUmakefile.in GNUmakefile
266 nice make LILYPOND_EXTERNAL_BINARY=~/Apps/LilyPond.app/Contents/Resources/bin/lilypond web
267 % change the lilypond directory as appropriate
270 Please note that this may break sometimes -- for example, if a new
271 feature is added with a test file in input/regression, even the latest
272 unstable Lily will fail to build the docs.
274 You may build the manual ( Documentation/user/ ) without building all
278 @node Testing LilyPond
279 @subsection Testing LilyPond
282 <a name="testing"></a>
285 LilyPond comes with an extensive suite that exercises the entire
286 program. This suite can be used to automatically check the impact of a
287 change. This is done as follows
291 @emph{## apply your changes, compile}
295 This will leave an HTML page @file{out/test-results/index.html}. This
296 page shows all the important differences that your change introduced,
297 whether in the layout, MIDI, performance or error reporting.
302 make test-redo @emph{## redo files differing from baseline}
303 make test-clean @emph{## remove all test results}
307 and then run @code{make check} again.
309 For tracking memory usage as part of this test, you will need GUILE
310 CVS; especially the following patch:
311 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
313 For checking the coverage of the test suite, do the following
316 ./buildscripts/build-coverage.sh
317 @emph{# uncovered files, least covered first}
318 python ./buildscripts/coverage.py --summary out-cov/*.cc
319 @emph{# consecutive uncovered lines, longest first}
320 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
327 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
328 reports to @email{bug-lilypond@@gnu.org}.
330 Bugs that are not fault of LilyPond are documented here.
332 @unnumberedsubsubsec Bison 1.875
334 There is a bug in bison-1.875: compilation fails with "parse error
335 before `goto'" in line 4922 due to a bug in bison. To fix, please
336 recompile bison 1.875 with the following fix
339 $ cd lily; make out/parser.cc
340 $ vi +4919 out/parser.cc
341 # append a semicolon to the line containing "__attribute__ ((__unused__))
347 @unnumberedsubsubsec MacOS X
349 For Fink, use the following command to compile.
352 export GUILE=guile-1.6
353 export GUILE_CONFIG=guile-1.6-config
354 export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
358 @unnumberedsubsubsec Solaris
360 Solaris7, ./configure
362 @file{./configure} needs a POSIX compliant shell. On Solaris7,
363 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
364 is. Run configure like
367 CONFIG_SHELL=/bin/ksh ksh -c ./configure
374 CONFIG_SHELL=/bin/bash bash -c ./configure
377 @unnumberedsubsubsec FreeBSD
379 To use system fonts, dejaview must be installed. With the default
380 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
382 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
383 following line just after the @code{<fontconfig>} line. (Adjust as necessary
387 <dir>/usr/X11R6/lib/X11/fonts</dir>
391 @unnumberedsubsubsec International fonts
393 On MacOs X, all fonts are installed by default. However, finding all
394 system fonts requires a bit of configuration; see
395 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
396 this post} on the @code{lilypond-user} mailing list.
398 On Linux, international fonts are installed by different means on
399 every distribution. We cannot list the exact commands or packages
400 that are necessary, as each distribution is different, and the exact
401 package names within each distribution changes. Here are some
407 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
408 ttfonts-zh_CN fonts-ja fonts-hebrew
412 apt-get install emacs-intl-fonts xfonts-intl-.* \
413 ttf-kochi-gothic ttf-kochi-mincho \
414 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi