1 @c -*- coding: utf-8; mode: texinfo; -*-
4 @c DO NOT TRANSLATE THIS FILE
6 @c include any node/sections from the higher-level *texi file.
7 @c @n ode Compiling from source
8 @c @s ection Compiling from source
11 * Downloading source code::
14 * Building documentation::
19 @node Downloading source code
20 @subsection Downloading source code
26 @uref{http://lilypond.org/download/} by HTTP.
28 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
30 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
33 git clone git://git.sv.gnu.org/lilypond.git
36 The repository does not contain generated files. To create
43 For information on packaging, see @uref{http://lilypond.org/devel}.
47 @subsection Requirements
49 @unnumberedsubsubsec Compilation
51 In addition to the packages needed for running LilyPond (see below), you
52 need the following extra packages for building.
54 Below is a full list of packages needed to build LilyPond. However, for
55 most common distributions there is an easy way of installing most all
56 build dependencies in one go
58 @multitable @columnfractions .5 .5
59 @headitem Distribution
63 @tab @code{sudo apt-get build-dep lilypond}
66 @tab @code{sudo yum-builddep lilypond}
69 @c sorry for the idiosyncratic command, I really asked and argued
70 @c for "zypper build-dep" :-(
71 @tab @code{sudo zypper --build-deps-only source-install lilypond}
75 When installing a binary package FOO, you may need to install the
76 FOO-devel, libFOO-dev or FOO-dev package too.
80 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
82 @item @uref{http://metafont.tutorial.free.fr/,MetaFont} (mf-nowin, mf, mfw or
83 mfont binaries) and @uref{http://cm.bell-labs.com/who/hobby/MetaPost.html,MetaPost}
84 (mpost binary), usually packaged with a @LaTeX{} distribution like
87 @item @uref{http://www.lcdf.org/~eddietwo/type/#t1utils,t1utils}
88 (version 1.33 or newer recommended).
90 @item New Century Schoolbook fonts, as PFB files. These are shipped with
91 X11 and Ghostscript, and are named @file{c059033l.pfb}
92 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}.
94 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE} (version
95 1.8.2 or newer). If you are installing binary packages, you may need to
96 install guile-devel or guile-dev or libguile-dev too.
98 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.11 or newer).
100 @item @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 3.4 or
101 newer. 4.x is strongly recommended).
103 @item @uref{http://www.python.org,Python} (version 2.4 or newer)
105 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
107 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}
108 (version 0.17 or newer).
110 @item @uref{http://www.gnu.org/software/flex/,Flex}.
112 @item @uref{http://www.perl.org/,Perl}.
114 @item @uref{http://www.gnu.org/software/bison/,GNU Bison}.
116 @item All packages required for running, including development packages with
117 header files and libraries.
122 @unnumberedsubsubsec Running requirements
124 Running LilyPond requires proper installation of the following software
128 @item @uref{http://www.freetype.org/,Freetype} (version 2.1.10 or newer).
129 @item @uref{http://fontconfig.org/,FontConfig} (version 2.2 or newer).
130 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
131 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
132 (version 1.8.2 or newer), or patch 1.8.1 with
133 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
134 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
135 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
136 newer. 8.60 recommended)
137 @item Dejaview. (This is normally installed by default)
140 International fonts are required to create music with international text
144 @unnumberedsubsubsec Requirements for building documentation
146 You can view the documentation online at
147 @uref{http://lilypond.org/doc/}, but you can also build it locally.
148 This process requires a successful compile of LilyPond, and some
149 additional tools and packages:
152 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
154 @item International fonts (see input/regression/utf-8.ly for hints
155 about which font packages are necessary for your platform)
156 @item Ghostscript 8.60 or newer, or 8.50 with the patch from
157 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
159 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
160 @item @uref{http://www.nongnu.org/texi2html/,Texi2HTML} 1.82 or newer
165 @node Building LilyPond
166 @subsection Building LilyPond
168 @unnumberedsubsubsec Compiling
170 To install GNU LilyPond, type
173 gunzip -c lilypond-x.y.z | tar xf -
175 ./configure # run with --help for applicable options
181 If you are not root, you should choose a @code{--prefix} argument that
182 points into your home directory, e.g.
185 ./configure --prefix=$HOME/usr
188 If you encounter any problems, please see @ref{Problems}.
191 @unnumberedsubsubsec Compiling for multiple platforms
193 If you want to build multiple versions of LilyPond with different
194 configuration settings, you can use the @code{--enable-config=CONF}
195 option of @command{configure}. You should use @code{make conf=CONF}
196 to generate the output in @file{out-CONF}. For example, suppose you
197 want to build with and without profiling, then use the following for
201 ./configure --prefix=$HOME/usr/ --enable-checking
206 and for the profiling version, specify a different configuration
209 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
211 make conf=prof install
215 @unnumberedsubsubsec Compiling outside the source tree
217 It is possible to compile LilyPond in a build tree different from the
218 source tree, with @code{--srcdir} option of @command{configure}:
221 mkdir lily-build && cd lily-build
222 @var{sourcedir}/configure --srcdir=@var{sourcedir}
227 @unnumberedsubsubsec Useful @command{make} variables
229 If a less verbose build output if desired, the variable
230 @code{QUIET_BUILD} may be set to @code{1} on @command{make} command
231 line, or in @file{local.make} at top of the build tree.
234 @node Building documentation
235 @subsection Building documentation
237 This requires a successful compile of LilyPond, or using an external
241 * Commands for building documentation:: Compiling and installing the documentation.
242 * Building documentation without compiling LilyPond:: Using a LilyPond binary already installed.
245 @node Commands for building documentation
246 @unnumberedsubsubsec Commands for building documentation
248 The documentation is built by issuing
254 After compilation, the HTML documentation tree is available in
255 @file{out-www/offline-root/}, and can be browsed locally. Various
256 portions of the documentation can be found by looking in
257 @file{out/} and @file{out-www} subdirectories in other places in
258 the source tree, but these are only @emph{portions} of the docs.
259 Please do not complain about anything which is broken in those
260 places; the only complete set of documentation is in
261 @file{out-www/offline-root/} from the top of the source tree.
263 The HTML, PDF and if available Info files can be installed into the
264 standard documentation path by issuing
271 This also installs Info documentation with images if the installation
272 prefix is properly set; otherwise, instructions to complete proper
273 installation of Info documentation are printed on standard output.
275 Compilation of documentation in Info format with images can be done
276 separately by issuing
283 Separate installation of this documentation is done by issuing
290 Note that to get the images in Info documentation, @code{install-doc}
291 target creates symbolic links to HTML and PDF installed documentation
292 tree in @file{@var{prefix}/share/info}, in order to save disk space,
293 whereas @code{install-info} copies images in
294 @file{@var{prefix}/share/info} subdirectories.
296 It is possible to build a documentation tree in
297 @file{out-www/online-root/}, with special processing, so it can be
298 used on a website with content negotiation for automatic language
299 selection; this can be achieved by issuing
302 make WEB_TARGETS=online doc
306 and both @q{offline} and @q{online} targets can be generated by issuing
309 make WEB_TARGETS="offline online" doc
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/};
324 for more information, see the Contributor's Guide, section
325 @emph{Documentation work}.
327 The makefile variable @code{QUIET_BUILD} may be set to @code{1} for a
328 less verbose build output, just like for building the programs.
333 The most time consuming task for building the documentation is running
334 LilyPond to build images of music, and there cannot be several
335 simultaneously running @command{lilypond-book} instances, so @code{-j}
336 @command{make} option does not significantly speed up the build process.
337 To help speed it up, the makefile variable @var{CPU_COUNT} may be set
338 in @file{local.make} or on the command line to the number of
339 @code{.ly} files that LilyPond should process simultaneously, e.g. on
340 a bi-processor or dual core machine
343 make -j3 CPU_COUNT=3 doc
347 The recommended value of @var{CPU_COUNT} is one plus the number of
348 cores or processors, but it is advisable to set it to a smaller value
349 if your system has not enough RAM to run that many simultaneous
352 If source files have changed since last documentation build, output
353 files that need to be rebuilt are normally rebuilt, even if you do not
354 run @code{make doc-clean} first. However, building dependencies in the
355 documentation are so complex that rebuilding of some targets may not
356 be triggered as they should be; a workaround is to force rebuilding
357 by touching appropriate files, e.g.
360 touch Documentation/extend.texi
361 touch Documentation/*te??
362 touch Documentation/snippets/*.te??
366 @node Building documentation without compiling LilyPond
367 @unnumberedsubsubsec Building documentation without compiling LilyPond
369 The documentation can be built locally without compiling LilyPond
370 binary, if LilyPond is already installed on your system.
372 From a fresh Git checkout, do
375 ./autogen.sh # ignore any warning messages
376 cp GNUmakefile.in GNUmakefile
378 nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond doc
381 Please note that this may break sometimes -- for example, if a new
382 feature is added with a test file in input/regression, even the latest
383 development release of LilyPond will fail to build the docs.
385 You may build the manual without building all the @file{input/*} stuff
386 (i.e. mostly regression tests): change directory, for example to
387 @file{Documentation/}, issue @code{make doc}, which will build
388 documentation in a subdirectory @file{out-www} from the source files in
389 current directory. In this case, if you also want to browse the
390 documentation in its post-processed form, change back to top directory
394 make out=www WWW-post
399 You may also need to create a script for @command{pngtopnm} and
400 @code{pnmtopng}. On GNU/Linux, I use this:
403 export LD_LIBRARY_PATH=/usr/lib
404 exec /usr/bin/pngtopnm "$@"
407 On MacOS X with fink, I use this:
410 export DYLD_LIBRARY_PATH=/sw/lib
411 exec /sw/bin/pngtopnm "$@"
414 On MacOS X with macports, you should use this:
417 export DYLD_LIBRARY_PATH=/opt/local/lib
418 exec /opt/local/bin/pngtopnm "$@"
423 @node Testing LilyPond
424 @subsection Testing LilyPond
427 <a name="testing"></a>
430 LilyPond comes with an extensive suite that exercises the entire
431 program. This suite can be used to automatically check the impact of a
432 change. This is done as follows
436 @emph{## apply your changes, compile}
440 This will leave an HTML page @file{out/test-results/index.html}. This
441 page shows all the important differences that your change introduced,
442 whether in the layout, MIDI, performance or error reporting.
447 make test-redo @emph{## redo files differing from baseline}
448 make test-clean @emph{## remove all test results}
452 and then run @code{make check} again.
454 For tracking memory usage as part of this test, you will need GUILE
455 CVS; especially the following patch:
456 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
458 For checking the coverage of the test suite, do the following
461 ./scripts/auxiliar/build-coverage.sh
462 @emph{# uncovered files, least covered first}
463 ./scripts/auxiliar/coverage.py --summary out-cov/*.cc
464 @emph{# consecutive uncovered lines, longest first}
465 ./scripts/auxiliar/coverage.py --uncovered out-cov/*.cc
472 For help and questions use @email{lilypond-user@@gnu.org}. Send
473 bug reports to @email{bug-lilypond@@gnu.org}.
475 Bugs that are not fault of LilyPond are documented here.
477 @unnumberedsubsubsec Bison 1.875
479 There is a bug in bison-1.875: compilation fails with "parse error
480 before `goto'" in line 4922 due to a bug in bison. To fix, please
481 recompile bison 1.875 with the following fix
484 $ cd lily; make out/parser.cc
485 $ vi +4919 out/parser.cc
486 # append a semicolon to the line containing "__attribute__ ((__unused__))
492 @unnumberedsubsubsec Compiling on MacOS@tie{}X
494 Here are special instructions for compiling under MacOS@tie{}X.
495 These instructions assume that dependencies are installed using
496 @uref{http://www.macports.org/, MacPorts.} The instructions have
497 been tested using OS X 10.5 (Leopard).
499 First, install the relevant dependencies using MacPorts.
501 Next, add the following to your relevant shell initialization
502 files. This is @code{~/.profile} by default. You should create
503 this file if it does not exist.
506 export PATH=/opt/local/bin:/opt/local/sbin:$PATH
507 export DYLD_LIBRARY_PATH=/System/Library/Frameworks/ApplicationServices.framework/Versions/A/Frameworks/ImageIO.framework/Versions/A/Resources:\
508 /opt/local/lib:$DYLD_LIBRARY_PATH
511 Now you must edit the generated @code{config.make} file. Change
514 FLEXLEXER_FILE = /usr/include/FlexLexer.h
521 FLEXLEXER_FILE = /opt/local/include/FlexLexer.h
524 At this point, you should verify that you have the appropriate
525 fonts installed with your ghostscript installation. Check @code{ls
526 /opt/local/share/ghostscript/fonts} for: 'c0590*' files (.pfb,
527 .pfb and .afm). If you don't have them, run the following
528 commands to grab them from the ghostscript SVN server and install
529 them in the appropriate location:
532 svn export http://svn.ghostscript.com/ghostscript/tags/urw-fonts-1.0.7pre44/
533 sudo mv urw-fonts-1.0.7pre44/* /opt/local/share/ghostscript/fonts/
534 rm -rf urw-fonts-1.07pre44
537 Now run the @code{./configure} script. To avoid complications with
538 automatic font detection, add
541 --with-ncsb-dir=/opt/local/share/ghostscript/fonts
545 @unnumberedsubsubsec Solaris
547 Solaris7, ./configure
549 @file{./configure} needs a POSIX compliant shell. On Solaris7,
550 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
551 is. Run configure like
554 CONFIG_SHELL=/bin/ksh ksh -c ./configure
561 CONFIG_SHELL=/bin/bash bash -c ./configure
564 @unnumberedsubsubsec FreeBSD
566 To use system fonts, dejaview must be installed. With the default
567 port, the fonts are installed in @file{usr/X11R6/lib/X11/fonts/dejavu}.
569 Open the file @file{$LILYPONDBASE/usr/etc/fonts/local.conf} and add the
570 following line just after the @code{<fontconfig>} line. (Adjust as necessary
574 <dir>/usr/X11R6/lib/X11/fonts</dir>
578 @unnumberedsubsubsec International fonts
580 On Mac OS X, all fonts are installed by default. However, finding all
581 system fonts requires a bit of configuration; see
582 @uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
583 this post} on the @code{lilypond-user} mailing list.
585 On Linux, international fonts are installed by different means on
586 every distribution. We cannot list the exact commands or packages
587 that are necessary, as each distribution is different, and the exact
588 package names within each distribution changes. Here are some
594 taipeifonts fonts-xorg-truetype ttfonts-ja fonts-arabic \
595 ttfonts-zh_CN fonts-ja fonts-hebrew
599 apt-get install emacs-intl-fonts xfonts-intl-.* \
600 ttf-kochi-gothic ttf-kochi-mincho \
601 xfonts-bolkhov-75dpi xfonts-cronyx-100dpi xfonts-cronyx-75dpi