1 \input texinfo @c -*-texinfo-*-
2 @setfilename INSTALL.info
3 @settitle INSTALL - compiling and installing GNU LilyPond
5 @documentencoding utf-8
13 @chapter Compiling and installing on Unix
17 <a name="download-source">
22 Even numbered minor versions are `stable' (2.6, 2.8, etc), while odd
23 version are development releases (2.7, 2.9, etc). Building LilyPond
24 is an involved process. If possible
25 @uref{http://lilypond.org/install,download a precompiled binary} for
28 @subsection Source code
33 @uref{http://lilypond.org/download/} by HTTP.
35 @uref{http://download.linuxaudio.org/lilypond/} by HTTP.
37 GIT from @uref{http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=summary,git.sv.gnu.org}
39 git clone git://git.sv.gnu.org/lilypond.git
42 The repository does not contain generated files. To create
49 For information on packaging, see @uref{http://lilypond.org/devel}.
51 @subsection Precompiled binary packages
53 Check out @uref{http://lilypond.org/web/install/} for up to date
54 information on binary packages for your platform.
59 @subsection Compilation
61 In addition to the packages needed for running Lilypond (see below),
62 you need the following extra packages for building.
64 When installing a binary package FOO, you may need to install the
65 FOO-devel, libFOO-dev or FOO-dev package too.
69 @item @uref{http://fontforge.sf.net/,FontForge} 20060125 or newer.
71 @item New Century Schoolbook fonts, as PFB files. These are shipped
72 with X11 and Ghostscript, and are named @file{c059033l.pfb}
73 @file{c059036l.pfb}, @file{c059013l.pfb} and @file{c059016l.pfb}
75 @item @uref{http://www.xs4all.nl/~hanwen/mftrace/,mftrace} (1.1.19 or
78 You will need to install some additional packages to get mftrace to
81 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
82 (version 1.8.2 or newer). If you are installing binary packages, you
83 may need to install guile-devel or guile-dev or libguile-dev too.
85 @item @uref{ftp://ftp.gnu.org/gnu/texinfo/,Texinfo} (version 4.8 or newer).
88 @uref{http://gcc.gnu.org/, The GNU c++ compiler} (version 4.x or
91 @item @uref{http://www.python.org,Python} (version 2.3 or newer)
93 @item @uref{ftp://ftp.gnu.org/gnu/make/,GNU Make} (version 3.78 or newer).
95 @item @uref{http://www.gnu.org/software/gettext/gettext.html,gettext}.
97 @item @uref{http://www.gnu.org/software/flex/,Flex}
99 @item @uref{http://www.perl.org/,Perl}
101 @item @uref{http://www.gnu.org/software/flex/,GNU Bison}
103 @item All packages required for running, including development packages with
104 header files and libraries.
108 @subsection Running requirements
110 Running LilyPond requires proper installation of the following
115 @item @uref{http://www.freetype.org/,Freetype} (version 2).
116 @item @uref{http://www.freetype.org/,FontConfig} (version 2.2).
117 @item @uref{http://www.pango.org/,Pango} (version 1.12 or newer).
118 @item @uref{http://www.gnu.org/software/guile/guile.html,GUILE}
119 (version 1.8.2 or newer), or patch 1.8.1 with
120 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.8-rational.patch}.
121 @item @uref{http://www.python.org,Python} (version 2.4 or newer).
122 @item @uref{http://www.ghostscript.com,Ghostscript} (version 8.15 or
123 newer. 8.50 recommended)
126 @subsection Building documentation
128 You can view the documentation online at
129 @uref{http://lilypond.org/doc/}, but you can also build it locally.
130 This process requires a successful compile of lilypond. The
131 documentation is built by issuing
138 Building the website requires some additional tools and packages
141 @item The @uref{http://netpbm.sourceforge.net/,netpbm utilities}
143 @item International fonts (see input/regression/utf-8.ly for hints
144 about which font packages are necessary for your platform)
145 @item Ghostscript, 8.50 with the patch from
146 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688154}
148 @uref{http://bugs.ghostscript.com/show_bug.cgi?id=688017}.
151 The HTML files can be installed into the standard documentation path
156 make out=www web-install
160 @section Testing LilyPond
163 <a name="testing"></a>
166 LilyPond comes with an extensive suite that excercises the entire
167 program. This suite can be used to automatically check the impact of a
168 change. This is done as follows
172 @emph{## apply your changes, compile}
176 This will leave an HTML page @file{out/test-results/index.html}. This
177 page shows all the important differences that your change introduced,
178 whether in the layout, MIDI, performance or error reporting.
183 make test-redo @emph{## redo files differing from baseline}
184 make test-clean @emph{## remove all test results}
188 and then run @code{make check} again.
190 For tracking memory usage as part of this test, you will need GUILE
191 CVS; especially the following patch:
192 @uref{http://lilypond.org/vc/gub.darcs/patches/guile-1.9-gcstats.patch}.
194 For checking the coverage of the test suite, do the following
197 ./buildscripts/build-coverage.sh
198 @emph{# uncovered files, least covered first}
199 python ./buildscripts/coverage.py --summary out-cov/*.cc
200 @emph{# consecutive uncovered lines, longest first}
201 python ./buildscripts/coverage.py --uncovered out-cov/*.cc
204 @section Building LilyPond
206 To install GNU LilyPond, type
209 gunzip -c lilypond-x.y.z | tar xf -
211 ./configure # run with --help for applicable options
217 If you are not root, you should choose a @code{--prefix} argument that
218 points into your home directory, e.g.
221 ./configure --prefix=$HOME/usr
226 @subsection Configuring for multiple platforms
228 If you want to build multiple versions of LilyPond with different
229 configuration settings, you can use the @code{--enable-config=CONF}
230 option of configure. You should use @samp{make conf=CONF} to generate
231 the output in @file{out-CONF}. Example: Suppose you want to build
232 with and without profiling, then use the following for the normal
237 ./configure --prefix=$HOME/usr/ --enable-checking
243 and for the profiling version, specify a different configuration
247 ./configure --prefix=$HOME/usr/ --enable-profiling --enable-config=prof --disable-checking
249 make conf=prof install
256 An Emacs mode for entering music and running LilyPond is contained in
257 the source archive in the @file{elisp} directory. Do @command{make
258 install} to install it to @var{elispdir}. The file @file{lilypond-init.el}
259 should be placed to @var{load-path}@file{/site-start.d/} or appended
260 to your @file{~/.emacs} or @file{~/.emacs.el}.
262 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
263 your @var{load-path} by appending the following line (as modified) to your
265 @c any reason we do not advise: (push "~/site-lisp" load-path)
268 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
275 A Vim mode for entering music and running LilyPond is contained in the
276 source archive in @code{$VIM} directory.
278 The LilyPond file type is detected if the file @file{~/.vim/filetype.vim} @c
279 has the following content
282 if exists("did_load_filetypes")
285 augroup filetypedetect
286 au! BufNewFile,BufRead *.ly setf lilypond
291 Please include this path by appending the following line to your
296 set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
301 where $@{LILYPOND_VERISON@} is your lilypond version. If Lilypond was not
302 installed in @file{/usr/local/}, then change this path accordingly.
307 For help and questions use @email{lilypond-user@@gnu.org}. Send bug
308 reports to @email{bug-lilypond@@gnu.org}.
310 Bugs that are not fault of LilyPond are documented here.
312 @subsection Bison 1.875
314 There is a bug in bison-1.875: compilation fails with "parse error
315 before `goto'" in line 4922 due to a bug in bison. To fix, please
316 recompile bison 1.875 with the following fix
320 $ cd lily; make out/parser.cc
321 $ vi +4919 out/parser.cc
322 # append a semicolon to the line containing "__attribute__ ((__unused__))
329 @unnumberedsubsec MacOS X
331 For Fink, use the following command to compile.
334 export GUILE=guile-1.6
335 export GUILE_CONFIG=guile-1.6-config
336 export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/
340 @unnumberedsubsec Solaris
343 @item Solaris7, ./configure
345 @file{./configure} needs a POSIX compliant shell. On Solaris7,
346 @file{/bin/sh} is not yet POSIX compliant, but @file{/bin/ksh} or bash
347 is. Run configure like
350 CONFIG_SHELL=/bin/ksh ksh -c ./configure
356 CONFIG_SHELL=/bin/bash bash -c ./configure