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
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
283 @node Testing LilyPond
284 @subsection Testing LilyPond
287 <a name="testing"></a>
290 LilyPond comes with an extensive suite that exercises the entire
291 program. This suite can be used to automatically check the impact of a
292 change. This is done as follows
296 @emph{## apply your changes, compile}
300 This will leave an HTML page @file{out/test-results/index.html}. This
301 page shows all the important differences that your change introduced,
302 whether in the layout, MIDI, performance or error reporting.
307 make test-redo @emph{## redo files differing from baseline}
308 make test-clean @emph{## remove all test results}
312 and then run @code{make check} again.
314 For tracking memory usage as part of this test, you will need GUILE
315 CVS; especially the following patch:
316 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
318 For checking the coverage of the test suite, do the following
321 ./buildscripts/build-coverage.sh
322 @emph{# uncovered files, least covered first}
323 python ./buildscripts/coverage.py --summary out-cov/*.cc
324 @emph{# consecutive uncovered lines, longest first}
325 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
332 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
333 reports to @email{bug-lilypond@@gnu.org}.
335 Bugs that are not fault of LilyPond are documented here.
337 @unnumberedsubsubsec Bison 1.875
339 There is a bug in bison-1.875: compilation fails with "parse error
340 before `goto'" in line 4922 due to a bug in bison. To fix, please
341 recompile bison 1.875 with the following fix
344 $ cd lily; make out/parser.cc
345 $ vi +4919 out/parser.cc
346 # append a semicolon to the line containing "__attribute__ ((__unused__))
352 @unnumberedsubsubsec Solaris
354 Solaris7, ./configure
356 @file{./configure} needs a POSIX compliant shell. On Solaris7,
357 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
358 is. Run configure like
361 CONFIG_SHELL=/bin/ksh ksh -c ./configure
368 CONFIG_SHELL=/bin/bash bash -c ./configure
371 @unnumberedsubsubsec FreeBSD
373 To use system fonts, dejaview must be installed. With the default
374 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
376 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
377 following line just after the @code{<fontconfig>} line. (Adjust as necessary
381 <dir>/usr/X11R6/lib/X11/fonts</dir>
385 @unnumberedsubsubsec International fonts
387 On MacOs X, all fonts are installed by default. However, finding all
388 system fonts requires a bit of configuration; see
389 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
390 this post} on the @code{lilypond-user} mailing list.
392 On Linux, international fonts are installed by different means on
393 every distribution. We cannot list the exact commands or packages
394 that are necessary, as each distribution is different, and the exact
395 package names within each distribution changes. Here are some
401 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
402 ttfonts-zh_CN fonts-ja fonts-hebrew
406 apt-get install emacs-intl-fonts xfonts-intl-.* \
407 ttf-kochi-gothic ttf-kochi-mincho \
408 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi